From 43daecd89b21292b112051340317927b42ccbdd3 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Sat, 1 Feb 2020 10:31:42 +0000 Subject: [PATCH] Version v1.51.0 --- MANUAL.html | 15786 ++++---- MANUAL.md | 1481 +- MANUAL.txt | 14872 ++++---- RELEASE.md | 7 +- VERSION | 2 +- docs/content/amazonclouddrive.md | 11 + docs/content/azureblob.md | 11 + docs/content/b2.md | 11 + docs/content/box.md | 11 + docs/content/changelog.md | 139 +- docs/content/commands/rclone.md | 2 +- docs/content/commands/rclone_about.md | 2 +- docs/content/commands/rclone_authorize.md | 9 +- docs/content/commands/rclone_cachestats.md | 2 +- docs/content/commands/rclone_cat.md | 2 +- docs/content/commands/rclone_check.md | 2 +- docs/content/commands/rclone_cleanup.md | 2 +- docs/content/commands/rclone_config.md | 2 +- docs/content/commands/rclone_config_create.md | 2 +- docs/content/commands/rclone_config_delete.md | 2 +- .../commands/rclone_config_disconnect.md | 2 +- docs/content/commands/rclone_config_dump.md | 2 +- docs/content/commands/rclone_config_edit.md | 2 +- docs/content/commands/rclone_config_file.md | 2 +- .../commands/rclone_config_password.md | 2 +- .../commands/rclone_config_providers.md | 2 +- .../commands/rclone_config_reconnect.md | 2 +- docs/content/commands/rclone_config_show.md | 2 +- docs/content/commands/rclone_config_update.md | 2 +- .../commands/rclone_config_userinfo.md | 2 +- docs/content/commands/rclone_copy.md | 2 +- docs/content/commands/rclone_copyto.md | 2 +- docs/content/commands/rclone_copyurl.md | 16 +- docs/content/commands/rclone_cryptcheck.md | 2 +- docs/content/commands/rclone_cryptdecode.md | 2 +- docs/content/commands/rclone_dbhashsum.md | 2 +- docs/content/commands/rclone_dedupe.md | 5 +- docs/content/commands/rclone_delete.md | 2 +- docs/content/commands/rclone_deletefile.md | 2 +- .../commands/rclone_genautocomplete.md | 2 +- .../commands/rclone_genautocomplete_bash.md | 2 +- .../commands/rclone_genautocomplete_zsh.md | 2 +- docs/content/commands/rclone_gendocs.md | 2 +- docs/content/commands/rclone_hashsum.md | 5 +- docs/content/commands/rclone_link.md | 2 +- docs/content/commands/rclone_listremotes.md | 2 +- docs/content/commands/rclone_ls.md | 2 +- docs/content/commands/rclone_lsd.md | 2 +- docs/content/commands/rclone_lsf.md | 2 +- docs/content/commands/rclone_lsjson.md | 23 +- docs/content/commands/rclone_lsl.md | 2 +- docs/content/commands/rclone_md5sum.md | 2 +- docs/content/commands/rclone_mkdir.md | 2 +- docs/content/commands/rclone_mount.md | 24 +- docs/content/commands/rclone_move.md | 2 +- docs/content/commands/rclone_moveto.md | 2 +- docs/content/commands/rclone_ncdu.md | 3 +- docs/content/commands/rclone_obscure.md | 2 +- docs/content/commands/rclone_purge.md | 2 +- docs/content/commands/rclone_rc.md | 2 +- docs/content/commands/rclone_rcat.md | 2 +- docs/content/commands/rclone_rcd.md | 2 +- docs/content/commands/rclone_rmdir.md | 2 +- docs/content/commands/rclone_rmdirs.md | 2 +- docs/content/commands/rclone_serve.md | 2 +- docs/content/commands/rclone_serve_dlna.md | 2 +- docs/content/commands/rclone_serve_ftp.md | 2 +- docs/content/commands/rclone_serve_http.md | 2 +- docs/content/commands/rclone_serve_restic.md | 2 +- docs/content/commands/rclone_serve_sftp.md | 31 +- docs/content/commands/rclone_serve_webdav.md | 2 +- docs/content/commands/rclone_settier.md | 2 +- docs/content/commands/rclone_sha1sum.md | 2 +- docs/content/commands/rclone_size.md | 2 +- docs/content/commands/rclone_sync.md | 2 +- docs/content/commands/rclone_touch.md | 2 +- docs/content/commands/rclone_tree.md | 2 +- docs/content/commands/rclone_version.md | 2 +- docs/content/crypt.md | 4 +- docs/content/drive.md | 63 +- docs/content/dropbox.md | 11 + docs/content/fichier.md | 11 + docs/content/flags.md | 61 +- docs/content/ftp.md | 11 + docs/content/googlecloudstorage.md | 15 + docs/content/hubic.md | 11 + docs/content/jottacloud.md | 11 + docs/content/koofr.md | 11 + docs/content/local.md | 11 + docs/content/mailru.md | 11 + docs/content/mega.md | 11 + docs/content/onedrive.md | 11 + docs/content/opendrive.md | 27 + docs/content/pcloud.md | 15 + docs/content/premiumizeme.md | 15 + docs/content/putio.md | 15 + docs/content/qingstor.md | 11 + docs/content/rc.md | 10 +- docs/content/s3.md | 46 +- docs/content/sftp.md | 9 + docs/content/sharefile.md | 11 + docs/content/swift.md | 11 + docs/content/yandex.md | 11 + docs/layouts/chrome/footer.copyright.html | 2 +- docs/layouts/partials/version.html | 2 +- fs/version.go | 2 +- rclone.1 | 31164 ++++++++++------ 107 files changed, 38444 insertions(+), 25727 deletions(-) diff --git a/MANUAL.html b/MANUAL.html index 4c48b5273..c87d9782e 100644 --- a/MANUAL.html +++ b/MANUAL.html @@ -14,10 +14,10 @@ -
+

rclone(1) User Manual

Nick Craig-Wood

-

Oct 26, 2019

+

Feb 01, 2020

Rclone - rsync for cloud storage

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

@@ -46,6 +46,7 @@
  • Mail.ru Cloud
  • Memset Memstore
  • Mega
    • +
  • Memory
  • Microsoft Azure Blob Storage
  • Microsoft OneDrive
  • Minio
    • @@ -63,6 +64,7 @@
  • rsync.net
  • Scaleway
  • SFTP
    • +
  • SugarSync
  • Wasabi
  • WebDAV
  • Yandex Disk
    • @@ -124,7 +126,10 @@ sudo cp rclone.1 /usr/local/share/man/man1/ sudo mandb

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

    rclone config
    -

    macOS installation from precompiled binary

    +

    macOS installation with brew

    +
    brew install rclone
    +

    macOS installation from precompiled binary, using curl

    +

    To avoid problems with macOS gatekeeper enforcing the binary to be signed and notarized it is enough to download with curl.

    Download the latest version of rclone.

    cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip

    Unzip the download and cd to the extracted folder.

    @@ -137,6 +142,12 @@ sudo mv rclone /usr/local/bin/ 
    cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip

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

    rclone config
    +

    macOS installation from precompiled binary, using a web browser

    +

    When downloading a binary with a web browser, the browser will set the macOS gatekeeper quarantine attribute. Starting from Catalina, when attempting to run rclone, a pop-up will appear saying:

    +
    “rclone” cannot be opened because the developer cannot be verified.
+macOS cannot verify that this app is free from malware.
    +

    The simplest fix is to run

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

    @@ -223,10 +234,11 @@ go build
  • Google Photos
  • HTTP
  • Hubic
    • -
  • Jottacloud
    • +
  • Jottacloud / GetSky.no
  • Koofr
  • Mail.ru Cloud
  • Mega
    • +
  • Memory
  • Microsoft Azure Blob Storage
  • Microsoft OneDrive
  • Openstack Swift / Rackspace Cloudfiles / Memset Memstore
    • @@ -236,6 +248,7 @@ go build
  • put.io
  • QingStor
  • SFTP
    • +
  • SugarSync
  • Union
  • WebDAV
  • Yandex Disk
    • @@ -651,6 +664,7 @@ two-3.txt: renamed from: two.txt
  • --dedupe-mode newest - removes identical files then keeps the newest one.
  • --dedupe-mode oldest - removes identical files then keeps the oldest one.
  • --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.

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

    @@ -659,7 +673,7 @@ 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|rename. (default "interactive")
+
          --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
    
@@ -714,9 +728,11 @@ Other:   8849156022

    Remote authorization.

    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]

    Options

    -
      -h, --help   help for authorize
    +
          --auth-no-open-browser   Do not automatically open auth link in default browser
+  -h, --help                   help for authorize

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

    SEE ALSO

    -

    Advanced Options

    +

    Advanced Options

    Here are the advanced options specific to http (http Connection).

    –http-headers

    Set HTTP headers for all transactions

    @@ -9997,14 +11576,14 @@ y/e/d> y 
    rclone copy /home/source remote:backup

    If you want the directory to be visible in the official Hubic browser, you need to copy your files to the default directory

    rclone copy /home/source remote:default/backup
    -

    –fast-list

    +

    –fast-list

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

    -

    Modified time

    +

    Modified time

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

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

    Note that Hubic wraps the Swift backend, so most of the properties of are the same.

    -

    Standard Options

    +

    Standard Options

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

    –hubic-client-id

    Hubic Client Id Leave blank normally.

    @@ -10012,7 +11591,7 @@ y/e/d> y
  • Config: client_id
  • Env Var: RCLONE_HUBIC_CLIENT_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –hubic-client-secret

    Hubic Client Secret Leave blank normally.

    @@ -10020,9 +11599,9 @@ y/e/d> y
  • Config: client_secret
  • Env Var: RCLONE_HUBIC_CLIENT_SECRET
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –hubic-chunk-size

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

    @@ -10044,14 +11623,23 @@ y/e/d> y
  • Type: bool
  • Default: false
    • +

    –hubic-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    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

    Paths are specified as remote:path

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

    -

    To configure Jottacloud you will need to enter your username and password and select a mountpoint.

    +

    To configure Jottacloud you will need to generate a personal security token in the Jottacloud web inteface. You will the option to do in your account security settings. Note that the web inteface may refer to this token as a JottaCli token.

    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:

    @@ -10077,16 +11665,8 @@ n) No y/n> n Remote config -Do you want to create a machine specific API key? - -Rclone has it's own Jottacloud API KEY which works fine as long as one only uses rclone on a single machine. When you want to use rclone with this account on more than one machine it's recommended to create a machine specific API key. These keys can NOT be shared between machines. - -y) Yes -n) No -y/n> y -Username> 0xC4KE@gmail.com -Your Jottacloud password is only required during setup and will not be stored. -password: +Generate a personal login token here: https://www.jottacloud.com/web/secure +Login Token> <your token here> Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? @@ -10109,11 +11689,10 @@ Mountpoints> 1 [jotta] type = jottacloud user = 0xC4KE@gmail.com -client_id = ..... -client_secret = ........ token = {........} device = Jotta mountpoint = Archive +configVersion = 1 -------------------- y) Yes this is OK e) Edit this remote @@ -10127,15 +11706,15 @@ y/e/d> y

    To copy a local directory to an Jottacloud directory called backup

    rclone copy /home/source remote:backup

    Devices and Mountpoints

    -

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

    -

    –fast-list

    +

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

    +

    –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

    +

    Restricted filename characters

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

    @@ -10147,7 +11726,7 @@ y/e/d> y - + @@ -10184,16 +11763,16 @@ y/e/d> y
    "" 0x22 ＂

    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. Due to a lack of API documentation emptying the trash is currently only possible via the Jottacloud website. If deleting permanently is required then use the --jottacloud-hard-delete flag, or set the equivalent environment variable.

    -

    Versions

    +

    Versions

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

    -

    Quota information

    +

    Quota information

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

    Device IDs

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

    -

    Advanced Options

    +

    Advanced Options

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

    –jottacloud-md5-memory-limit

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

    @@ -10227,8 +11806,17 @@ y/e/d> y
  • Type: SizeSuffix
  • Default: 10M
    • +

    –jottacloud-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    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.

    @@ -10292,7 +11880,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:

    @@ -10312,7 +11900,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

    @@ -10320,7 +11908,7 @@ y/e/d> y
  • Config: user
  • Env Var: RCLONE_KOOFR_USER
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –koofr-password

    Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password)

    @@ -10328,9 +11916,9 @@ y/e/d> y
  • Config: password
  • Env Var: RCLONE_KOOFR_PASSWORD
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –koofr-endpoint

    The Koofr API endpoint to use

    @@ -10346,7 +11934,7 @@ y/e/d> y
  • Config: mountid
  • Env Var: RCLONE_KOOFR_MOUNTID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

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

    @@ -10356,8 +11944,17 @@ y/e/d> y
  • Type: bool
  • Default: true
    • +

    –koofr-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    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)

    @@ -10438,15 +12035,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 /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:

    @@ -10458,7 +12055,7 @@ y/e/d> y - + @@ -10500,11 +12097,11 @@ y/e/d> y
    "" 0x22 ＂

    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)

    @@ -10512,7 +12109,7 @@ y/e/d> y
  • Config: user
  • Env Var: RCLONE_MAILRU_USER
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –mailru-pass

    Password

    @@ -10520,7 +12117,7 @@ y/e/d> y
  • Config: pass
  • Env Var: RCLONE_MAILRU_PASS
  • Type: string
    • -
  • Default: ""
    • +
  • 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.

    @@ -10541,7 +12138,7 @@ y/e/d> y -

    Advanced Options

    +

    Advanced Options

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

    –mailru-speedup-file-patterns

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

    @@ -10552,11 +12149,11 @@ y/e/d> y
  • Default: “.mkv,.avi,.mp4,.mp3,.zip,.gz,.rar,.pdf”
  • Examples:
      -
    • "" +
    • ""
      • Empty list completely disables speedup (put by hash).
      • -
    • "*" +
    • "*"
      • All files will be attempted for speedup.
      • @@ -10641,7 +12238,7 @@ y/e/d> y
    • Config: user_agent
    • Env Var: RCLONE_MAILRU_USER_AGENT
    • Type: string
      • -
    • Default: ""
      • +
    • 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

    @@ -10649,7 +12246,16 @@ y/e/d> y
  • Config: quirks
  • Env Var: RCLONE_MAILRU_QUIRKS
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + +

    –mailru-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    Mega

    @@ -10703,9 +12309,9 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an Mega directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

    Mega does not support modification times or hashes yet.

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -10728,7 +12334,7 @@ y/e/d> y

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

    -

    Duplicated files

    +

    Duplicated files

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

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

    Use rclone dedupe to fix duplicated files.

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

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

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

    -

    Standard Options

    +

    Standard Options

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

    –mega-user

    User name

    @@ -10752,7 +12358,7 @@ y/e/d> y
  • Config: user
  • Env Var: RCLONE_MEGA_USER
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –mega-pass

    Password.

    @@ -10760,9 +12366,9 @@ y/e/d> y
  • Config: pass
  • Env Var: RCLONE_MEGA_PASS
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –mega-debug

    Output more debug from Mega.

    @@ -10782,10 +12388,59 @@ y/e/d> y
  • Type: bool
  • Default: false
    • +

    –mega-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    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.

    +

    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
+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 / Memory
+   \ "memory"
+[snip]
+Storage> memory
+** See help for memory backend at: https://rclone.org/memory/ **
+
+Remote config
+
+--------------------
+[remote]
+type = memory
+--------------------
+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

    +
    rclone mount :memory: /mnt/tmp
+rclone serve webdav :memory:
+rclone serve sftp :memory:
    +

    Modified time and hashes

    +

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

    +

    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.

    Here is an example of making a Microsoft Azure Blob Storage configuration. For a remote called remote. First run:

    @@ -10829,11 +12484,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 /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:

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

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

    -

    Multipart uploads

    +

    Multipart uploads

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

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

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

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

    -

    Standard Options

    +

    Standard Options

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

    –azureblob-account

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

    @@ -10905,7 +12560,7 @@ rclone ls azureblob:othercontainer
  • Config: account
  • Env Var: RCLONE_AZUREBLOB_ACCOUNT
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –azureblob-key

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

    @@ -10913,7 +12568,7 @@ rclone ls azureblob:othercontainer
  • Config: key
  • Env Var: RCLONE_AZUREBLOB_KEY
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –azureblob-sas-url

    SAS URL for container level access only (leave blank if using account/key or Emulator)

    @@ -10921,7 +12576,7 @@ rclone ls azureblob:othercontainer
  • Config: sas_url
  • Env Var: RCLONE_AZUREBLOB_SAS_URL
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –azureblob-use-emulator

    Uses local storage emulator if provided as ‘true’ (leave blank if using real azure storage endpoint)

    @@ -10931,7 +12586,7 @@ rclone ls azureblob:othercontainer
  • Type: bool
  • Default: false
    • -

    Advanced Options

    +

    Advanced Options

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

    –azureblob-endpoint

    Endpoint for the service Leave blank normally.

    @@ -10939,7 +12594,7 @@ rclone ls azureblob:othercontainer
  • Config: endpoint
  • Env Var: RCLONE_AZUREBLOB_ENDPOINT
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –azureblob-upload-cutoff

    Cutoff for switching to chunked upload (<= 256MB).

    @@ -10975,10 +12630,19 @@ rclone ls azureblob:othercontainer
  • Config: access_tier
  • Env Var: RCLONE_AZUREBLOB_ACCESS_TIER
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + +

    –azureblob-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    Limitations

    +

    Limitations

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

    Azure Storage Emulator Support

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

    @@ -11070,10 +12734,11 @@ y/e/d> y

    To copy a local directory to an OneDrive directory called backup

    rclone copy /home/source remote:backup

    Getting your own Client ID and Key

    -

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

    +

    You can use your own Client ID if the default (client_id left blank) one doesn’t work for you or you see lots of throttling. The default Client ID and Key is shared by all rclone users when performing requests.

    +

    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, then click New registration.
      2. -
    2. Enter a name for your app, choose your account type, select Web in Redirect URI Enter http://localhost:53682/ and click Register. Copy and keep the Application (client) ID under the app name for later use.
      3. +
    3. Enter a name for your app, choose account type Any Azure AD directory - Multitenant, 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.
    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 follwing permssions: Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, offline_access, User.Read. Once selected click Add permissions at the bottom.
      7. @@ -11083,7 +12748,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:

    @@ -11095,7 +12760,7 @@ y/e/d> y - + @@ -11191,10 +12856,10 @@ y/e/d> y
    "" 0x22 ＂

    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

    Microsoft App Client Id Leave blank normally.

    @@ -11202,7 +12867,7 @@ y/e/d> y
  • Config: client_id
  • Env Var: RCLONE_ONEDRIVE_CLIENT_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –onedrive-client-secret

    Microsoft App Client Secret Leave blank normally.

    @@ -11210,9 +12875,9 @@ y/e/d> y
  • Config: client_secret
  • Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –onedrive-chunk-size

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

    @@ -11229,7 +12894,7 @@ y/e/d> y
  • Config: drive_id
  • Env Var: RCLONE_ONEDRIVE_DRIVE_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –onedrive-drive-type

    The type of the drive ( personal | business | documentLibrary )

    @@ -11237,7 +12902,7 @@ y/e/d> y
  • Config: drive_type
  • Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –onedrive-expose-onenote-files

    Set to make OneNote files show up in directory listings.

    @@ -11248,8 +12913,17 @@ y/e/d> y
  • Type: bool
  • Default: false
    • +

    –onedrive-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    Limitations

    +

    Limitations

    Naming

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

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

    @@ -11345,9 +13019,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

    @@ -11368,7 +13042,7 @@ y/e/d> y - + @@ -11448,7 +13122,7 @@ y/e/d> y
    ／
    "" 0x22 ＂

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

    -

    Standard Options

    +

    Standard Options

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

    –opendrive-username

    Username

    @@ -11456,7 +13130,7 @@ y/e/d> y
  • Config: username
  • Env Var: RCLONE_OPENDRIVE_USERNAME
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –opendrive-password

    Password.

    @@ -11464,10 +13138,30 @@ y/e/d> y
  • Config: password
  • Env Var: RCLONE_OPENDRIVE_PASSWORD
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + +

    Advanced Options

    +

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

    +

    –opendrive-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + +

    –opendrive-chunk-size

    +

    Files will be uploaded in chunks this size.

    +

    Note that these chunks are buffered in memory so increasing them will increase memory use.

    + -

    Limitations

    +

    Limitations

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

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

    QingStor

    @@ -11539,13 +13233,13 @@ y/e/d> y 
    rclone ls remote:bucket

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

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

    –fast-list

    +

    –fast-list

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

    -

    Multipart uploads

    +

    Multipart uploads

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

    Buckets and Zone

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

    -

    Authentication

    +

    Authentication

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

    -

    Restricted filename characters

    +

    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.

    @@ -11593,7 +13287,7 @@ y/e/d> y
  • Config: access_key_id
  • Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –qingstor-secret-access-key

    QingStor Secret Access Key (password) Leave blank for anonymous access or runtime credentials.

    @@ -11601,7 +13295,7 @@ y/e/d> y
  • Config: secret_access_key
  • Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –qingstor-endpoint

    Enter a endpoint URL to connection QingStor API. Leave blank will use the default value “https://qingstor.com:443”

    @@ -11609,7 +13303,7 @@ y/e/d> y
  • Config: endpoint
  • Env Var: RCLONE_QINGSTOR_ENDPOINT
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –qingstor-zone

    Zone to connect to. Default is “pek3a”.

    @@ -11617,7 +13311,7 @@ y/e/d> y
  • Config: zone
  • Env Var: RCLONE_QINGSTOR_ZONE
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
    • “pek3a” @@ -11637,7 +13331,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.

    @@ -11678,6 +13372,15 @@ y/e/d> y
  • Type: int
  • Default: 1
    • +

    –qingstor-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    Swift

    Swift refers to Openstack Object Storage. Commercial implementations of that being:

    @@ -11729,7 +13432,7 @@ Choose a number from below, or type in your own value 5 / Memset Memstore UK v2 \ "https://auth.storage.memset.com/v2.0" 6 / OVH - \ "https://auth.cloud.ovh.net/v2.0" + \ "https://auth.cloud.ovh.net/v3" auth> User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). user_id> @@ -11820,13 +13523,13 @@ tenant = $OS_TENANT_NAME export RCLONE_CONFIG_MYREMOTE_TYPE=swift export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true rclone lsd myremote: -

    –fast-list

    +

    –fast-list

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

    -

    –update and –use-server-modtime

    +

    –update and –use-server-modtime

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

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

    -

    Standard Options

    +

    Standard Options

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

    –swift-env-auth

    Get swift credentials from environment variables in standard OpenStack form.

    @@ -11853,7 +13556,7 @@ rclone lsd myremote:
  • Config: user
  • Env Var: RCLONE_SWIFT_USER
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-key

    API key or password (OS_PASSWORD).

    @@ -11861,7 +13564,7 @@ rclone lsd myremote:
  • Config: key
  • Env Var: RCLONE_SWIFT_KEY
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-auth

    Authentication URL for server (OS_AUTH_URL).

    @@ -11869,7 +13572,7 @@ rclone lsd myremote:
  • Config: auth
  • Env Var: RCLONE_SWIFT_AUTH
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
    • “https://auth.api.rackspacecloud.com/v1.0” @@ -11892,7 +13595,7 @@ rclone lsd myremote:
      • Memset Memstore UK v2
      • -
    • “https://auth.cloud.ovh.net/v2.0” +
    • “https://auth.cloud.ovh.net/v3”
      • OVH
      • @@ -11904,7 +13607,7 @@ rclone lsd myremote:
    • Config: user_id
    • Env Var: RCLONE_SWIFT_USER_ID
    • Type: string
      • -
    • Default: ""
      • +
    • Default: ""

    –swift-domain

    User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)

    @@ -11912,7 +13615,7 @@ rclone lsd myremote:
  • Config: domain
  • Env Var: RCLONE_SWIFT_DOMAIN
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-tenant

    Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME)

    @@ -11920,7 +13623,7 @@ rclone lsd myremote:
  • Config: tenant
  • Env Var: RCLONE_SWIFT_TENANT
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-tenant-id

    Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID)

    @@ -11928,7 +13631,7 @@ rclone lsd myremote:
  • Config: tenant_id
  • Env Var: RCLONE_SWIFT_TENANT_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-tenant-domain

    Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME)

    @@ -11936,7 +13639,7 @@ rclone lsd myremote:
  • Config: tenant_domain
  • Env Var: RCLONE_SWIFT_TENANT_DOMAIN
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-region

    Region name - optional (OS_REGION_NAME)

    @@ -11944,7 +13647,7 @@ rclone lsd myremote:
  • Config: region
  • Env Var: RCLONE_SWIFT_REGION
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-storage-url

    Storage URL - optional (OS_STORAGE_URL)

    @@ -11952,7 +13655,7 @@ rclone lsd myremote:
  • Config: storage_url
  • Env Var: RCLONE_SWIFT_STORAGE_URL
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-auth-token

    Auth Token from alternate authentication - optional (OS_AUTH_TOKEN)

    @@ -11960,7 +13663,7 @@ rclone lsd myremote:
  • Config: auth_token
  • Env Var: RCLONE_SWIFT_AUTH_TOKEN
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-application-credential-id

    Application Credential ID (OS_APPLICATION_CREDENTIAL_ID)

    @@ -11968,7 +13671,7 @@ rclone lsd myremote:
  • Config: application_credential_id
  • Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-application-credential-name

    Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME)

    @@ -11976,7 +13679,7 @@ rclone lsd myremote:
  • Config: application_credential_name
  • Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-application-credential-secret

    Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET)

    @@ -11984,7 +13687,7 @@ rclone lsd myremote:
  • Config: application_credential_secret
  • Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –swift-auth-version

    AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION)

    @@ -12024,10 +13727,10 @@ rclone lsd myremote:
  • Config: storage_policy
  • Env Var: RCLONE_SWIFT_STORAGE_POLICY
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
      -
    • "" +
    • ""
      • Default
      • @@ -12041,7 +13744,7 @@ rclone lsd myremote:
    • -

    Advanced Options

    +

    Advanced Options

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

    –swift-chunk-size

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

    @@ -12063,11 +13766,20 @@ rclone lsd myremote:
  • Type: bool
  • Default: false
    • +

    –swift-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

    Modified time

    +

    Modified time

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

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

    -

    Restricted filename characters

    +

    Restricted filename characters

    @@ -12090,7 +13802,7 @@ rclone lsd myremote:

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

    -

    Limitations

    +

    Limitations

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

    Troubleshooting

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

    @@ -12153,10 +13865,10 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an pCloud directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

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

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

    -

    Restricted filename characters

    +

    Restricted filename characters

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

    @@ -12175,10 +13887,10 @@ 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.

    -

    Standard Options

    +

    Standard Options

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

    –pcloud-client-id

    Pcloud App Client Id Leave blank normally.

    @@ -12186,7 +13898,7 @@ y/e/d> y
  • Config: client_id
  • Env Var: RCLONE_PCLOUD_CLIENT_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –pcloud-client-secret

    Pcloud App Client Secret Leave blank normally.

    @@ -12194,7 +13906,18 @@ y/e/d> y
  • Config: client_secret
  • Env Var: RCLONE_PCLOUD_CLIENT_SECRET
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + +

    Advanced Options

    +

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

    +

    –pcloud-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    premiumize.me

    @@ -12249,9 +13972,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:

    @@ -12268,7 +13991,7 @@ y/e/d> - + @@ -12276,7 +13999,7 @@ y/e/d>
    ＼
    "" 0x22 ＂

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

    -

    Standard Options

    +

    Standard Options

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

    –premiumizeme-api-key

    API Key.

    @@ -12285,12 +14008,23 @@ y/e/d>
  • Config: api_key
  • Env Var: RCLONE_PREMIUMIZEME_API_KEY
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + +

    Advanced Options

    +

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

    +

    –premiumizeme-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + -

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

    @@ -12357,7 +14091,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:

    @@ -12377,6 +14111,17 @@ 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

    +

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

    +

    –putio-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    SFTP

    SFTP is the Secure (or SSH) File Transfer Protocol.

    @@ -12387,7 +14132,7 @@ e/n/d/r/c/s/q> q

    SFTP runs over SSH v2 and is installed as standard with most modern SSH installations.

    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.

    -

    "Note that some SFTP servers will need the leading / - Synology is a good example of this. rsync.net, on the other hand, requires users to OMIT the leading /.

    +

    "Note that some SFTP servers will need the leading / - Synology is a good example of this. rsync.net, on the other hand, requires users to OMIT the leading /.

    Here is an example of making an SFTP configuration. First run

    rclone config

    This will guide you through an interactive setup process.

    @@ -12460,12 +14205,12 @@ y/e/d> y

    And then at the end of the session

    eval `ssh-agent -k`

    These commands can be used in scripts of course.

    -

    Modified time

    +

    Modified time

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

    Modified times are used in syncing and are fully supported.

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

    -

    Standard Options

    +

    Standard Options

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

    –sftp-host

    SSH host to connect to

    @@ -12473,7 +14218,7 @@ y/e/d> y
  • Config: host
  • Env Var: RCLONE_SFTP_HOST
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
    • “example.com” @@ -12488,7 +14233,7 @@ y/e/d> y
    • Config: user
    • Env Var: RCLONE_SFTP_USER
    • Type: string
      • -
    • Default: ""
      • +
    • Default: ""

    –sftp-port

    SSH port, leave blank to use default (22)

    @@ -12496,7 +14241,7 @@ y/e/d> y
  • Config: port
  • Env Var: RCLONE_SFTP_PORT
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-pass

    SSH password, leave blank to use ssh-agent.

    @@ -12504,7 +14249,7 @@ y/e/d> y
  • Config: pass
  • Env Var: RCLONE_SFTP_PASS
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-key-file

    Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent.

    @@ -12512,7 +14257,7 @@ y/e/d> y
  • Config: key_file
  • Env Var: RCLONE_SFTP_KEY_FILE
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-key-file-pass

    The passphrase to decrypt the PEM-encoded private key file.

    @@ -12521,7 +14266,7 @@ y/e/d> y
  • Config: key_file_pass
  • Env Var: RCLONE_SFTP_KEY_FILE_PASS
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-key-use-agent

    When set forces the usage of the ssh-agent.

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

    Advanced Options

    +

    Advanced Options

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

    –sftp-ask-password

    Allow asking for SFTP password when needed.

    @@ -12591,7 +14336,7 @@ y/e/d> y
  • Config: path_override
  • Env Var: RCLONE_SFTP_PATH_OVERRIDE
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-set-modtime

    Set the modified time on the remote if set.

    @@ -12607,7 +14352,7 @@ y/e/d> y
  • Config: md5sum_command
  • Env Var: RCLONE_SFTP_MD5SUM_COMMAND
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –sftp-sha1sum-command

    The command used to read sha1 hashes. Leave blank for autodetect.

    @@ -12615,10 +14360,18 @@ y/e/d> y
  • Config: sha1sum_command
  • Env Var: RCLONE_SFTP_SHA1SUM_COMMAND
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • + + +

    Set to skip any symlinks and any other non regular files.

    + -

    Limitations

    +

    Limitations

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

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

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

    @@ -12633,6 +14386,184 @@ y/e/d> y

    rsync.net

    rsync.net is supported through the SFTP backend.

    See rsync.net’s documentation of rclone examples.

    +

    SugarSync

    +

    SugarSync is a cloud service that enables active synchronization of files across computers and other devices for file backup, access, syncing, and sharing.

    +

    The initial setup for SugarSync involves getting a token from SugarSync which you can do with rclone. 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 / Sugarsync
+   \ "sugarsync"
+[snip]
+Storage> sugarsync
+** See help for sugarsync backend at: https://rclone.org/sugarsync/ **
+
+Sugarsync App ID.
+Leave blank to use rclone's.
+Enter a string value. Press Enter for the default ("").
+app_id> 
+Sugarsync Access Key ID.
+Leave blank to use rclone's.
+Enter a string value. Press Enter for the default ("").
+access_key_id> 
+Sugarsync Private Access Key
+Leave blank to use rclone's.
+Enter a string value. Press Enter for the default ("").
+private_access_key> 
+Permanently delete files if true
+otherwise put them in the deleted files.
+Enter a boolean value (true or false). Press Enter for the default ("false").
+hard_delete> 
+Edit advanced config? (y/n)
+y) Yes
+n) No (default)
+y/n> n
+Remote config
+Username (email address)> nick@craig-wood.com
+Your Sugarsync password is only required during setup and will not be stored.
+password:
+--------------------
+[remote]
+type = sugarsync
+refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX
+--------------------
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
    +

    Note that the config asks for your email and password but doesn’t store them, it only uses them to get the initial token.

    +

    Once configured you can then use rclone like this,

    +

    List directories (sync folders) in top level of your SugarSync

    +
    rclone lsd remote:
    +

    List all the files in your SugarSync folder “Test”

    +
    rclone ls remote:Test
    +

    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.

    +

    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

    +

    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

    +

    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

    +

    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

    +

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

    +

    –sugarsync-app-id

    +

    Sugarsync App ID.

    +

    Leave blank to use rclone’s.

    + +

    –sugarsync-access-key-id

    +

    Sugarsync Access Key ID.

    +

    Leave blank to use rclone’s.

    + +

    –sugarsync-private-access-key

    +

    Sugarsync Private Access Key

    +

    Leave blank to use rclone’s.

    + +

    –sugarsync-hard-delete

    +

    Permanently delete files if true otherwise put them in the deleted files.

    + +

    Advanced Options

    +

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

    +

    –sugarsync-refresh-token

    +

    Sugarsync refresh token

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-authorization

    +

    Sugarsync authorization

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-authorization-expiry

    +

    Sugarsync authorization expiry

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-user

    +

    Sugarsync user

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-root-id

    +

    Sugarsync root id

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-deleted-id

    +

    Sugarsync deleted folder id

    +

    Leave blank normally, will be auto configured by rclone.

    + +

    –sugarsync-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    + +

    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.

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

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

    rclone copy C:\source remote:source
    -

    Standard Options

    +

    Standard Options

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

    –union-remotes

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

    @@ -12702,7 +14633,7 @@ e/n/d/r/c/s/q> q
  • Config: remotes
  • Env Var: RCLONE_UNION_REMOTES
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • WebDAV

    @@ -12775,11 +14706,11 @@ y/e/d> y 
    rclone ls remote:

    To copy a local directory to an WebDAV directory called backup

    rclone copy /home/source remote:backup
    -

    Modified time and hashes

    +

    Modified time and hashes

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

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

    -

    Standard Options

    +

    Standard Options

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

    –webdav-url

    URL of http host to connect to

    @@ -12787,7 +14718,7 @@ y/e/d> y
  • Config: url
  • Env Var: RCLONE_WEBDAV_URL
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
    • “https://example.com” @@ -12802,7 +14733,7 @@ y/e/d> y
    • Config: vendor
    • Env Var: RCLONE_WEBDAV_VENDOR
    • Type: string
      • -
    • Default: ""
      • +
    • Default: ""
    • Examples:
      • “nextcloud” @@ -12829,7 +14760,7 @@ y/e/d> y
      • Config: user
      • Env Var: RCLONE_WEBDAV_USER
      • Type: string
        • -
      • Default: ""
        • +
      • Default: ""

      –webdav-pass

      Password.

      @@ -12837,7 +14768,7 @@ y/e/d> y
    • Config: pass
    • Env Var: RCLONE_WEBDAV_PASS
    • Type: string
      • -
    • Default: ""
      • +
    • Default: ""

    –webdav-bearer-token

    Bearer token instead of user/pass (eg a Macaroon)

    @@ -12845,9 +14776,9 @@ y/e/d> y
  • Config: bearer_token
  • Env Var: RCLONE_WEBDAV_BEARER_TOKEN
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

    –webdav-bearer-token-command

    Command to run to get a bearer token

    @@ -12855,7 +14786,7 @@ y/e/d> y
  • Config: bearer_token_command
  • Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • Provider notes

    @@ -12968,21 +14899,21 @@ y/e/d> y

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

    rclone sync /home/local/directory remote:directory

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

    -

    Modified time

    +

    Modified 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

    Yandex Client Id Leave blank normally.

    @@ -12990,7 +14921,7 @@ y/e/d> y
  • Config: client_id
  • Env Var: RCLONE_YANDEX_CLIENT_ID
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""

    • –yandex-client-secret

    Yandex Client Secret Leave blank normally.

    @@ -12998,9 +14929,9 @@ y/e/d> y
  • Config: client_secret
  • Env Var: RCLONE_YANDEX_CLIENT_SECRET
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
    • -

    Advanced Options

    +

    Advanced Options

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

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

    @@ -13010,20 +14941,29 @@ y/e/d> y
  • Type: bool
  • Default: false
    • +

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

    rclone sync /home/source /tmp/destination

    Will sync /home/source to /tmp/destination

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

    -

    Modified time

    +

    Modified time

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

    Filenames

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

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

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

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

    Restricted characters

    +

    Restricted characters

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

    @@ -13222,7 +15162,7 @@ y/e/d> y - + @@ -13382,7 +15322,7 @@ $ tree /tmp/b

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

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

    -

    Standard Options

    +

    Standard Options

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

    –local-nounc

    Disable UNC (long path names) conversion on Windows

    @@ -13390,7 +15330,7 @@ $ tree /tmp/b
  • Config: nounc
  • Env Var: RCLONE_LOCAL_NOUNC
  • Type: string
    • -
  • Default: ""
    • +
  • Default: ""
  • Examples:
    • “true” @@ -13399,7 +15339,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.

    @@ -13470,8 +15410,238 @@ $ tree /tmp/b
  • Type: bool
  • Default: false
    • +

    –local-encoding

    +

    This sets the encoding for the backend.

    +

    See: the encoding section in the overview for more info.

    +

    Changelog

    +

    v1.51.0 - 2020-02-01

    + +

    v1.50.2 - 2019-11-19

    + +

    v1.50.1 - 2019-11-02

    +

    v1.50.0 - 2019-10-26

    Bugs and Limitations

    -

    Limitations

    +

    Limitations

    Directory timestamps aren’t preserved

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

    Rclone struggles with millions of files in a directory

    @@ -16751,304 +18921,332 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Authors

    Contributors

    Contact the rclone project

    Forum

    diff --git a/MANUAL.md b/MANUAL.md index 90fc33113..dc9158c8f 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -1,6 +1,6 @@ % rclone(1) User Manual % Nick Craig-Wood -% Oct 26, 2019 +% Feb 01, 2020 # Rclone - rsync for cloud storage @@ -30,6 +30,7 @@ Rclone is a command line program to sync files and directories to and from: * Mail.ru Cloud * Memset Memstore * Mega +* Memory * Microsoft Azure Blob Storage * Microsoft OneDrive * Minio @@ -47,6 +48,7 @@ Rclone is a command line program to sync files and directories to and from: * rsync.net * Scaleway * SFTP +* SugarSync * Wasabi * WebDAV * Yandex Disk @@ -129,7 +131,14 @@ Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) rclone config -## macOS installation from precompiled binary ## +## macOS installation with brew ## + + brew install rclone + +## macOS installation from precompiled binary, using curl ## + +To avoid problems with macOS gatekeeper enforcing the binary to be signed and +notarized it is enough to download with `curl`. Download the latest version of rclone. @@ -154,6 +163,19 @@ Run `rclone config` to setup. See [rclone config docs](https://rclone.org/docs/) rclone config +## macOS installation from precompiled binary, using a web browser ## + +When downloading a binary with a web browser, the browser will set the macOS +gatekeeper quarantine attribute. Starting from Catalina, when attempting to run +`rclone`, a pop-up will appear saying: + + “rclone” cannot be opened because the developer cannot be verified. + macOS cannot verify that this app is free from malware. + +The simplest fix is to run + + xattr -d com.apple.quarantine rclone + ## Install with docker ## The rclone maintains a [docker image for rclone](https://hub.docker.com/r/rclone/rclone). @@ -297,10 +319,11 @@ See the following for detailed instructions for * [Google Photos](https://rclone.org/googlephotos/) * [HTTP](https://rclone.org/http/) * [Hubic](https://rclone.org/hubic/) - * [Jottacloud](https://rclone.org/jottacloud/) + * [Jottacloud / GetSky.no](https://rclone.org/jottacloud/) * [Koofr](https://rclone.org/koofr/) * [Mail.ru Cloud](https://rclone.org/mailru/) * [Mega](https://rclone.org/mega/) + * [Memory](https://rclone.org/memory/) * [Microsoft Azure Blob Storage](https://rclone.org/azureblob/) * [Microsoft OneDrive](https://rclone.org/onedrive/) * [Openstack Swift / Rackspace Cloudfiles / Memset Memstore](https://rclone.org/swift/) @@ -310,6 +333,7 @@ See the following for detailed instructions for * [put.io](https://rclone.org/putio/) * [QingStor](https://rclone.org/qingstor/) * [SFTP](https://rclone.org/sftp/) + * [SugarSync](https://rclone.org/sugarsync/) * [Union](https://rclone.org/union/) * [WebDAV](https://rclone.org/webdav/) * [Yandex Disk](https://rclone.org/yandex/) @@ -1135,6 +1159,7 @@ Dedupe can be run non interactively using the `--dedupe-mode` flag or by using a * `--dedupe-mode newest` - removes identical files then keeps the newest one. * `--dedupe-mode oldest` - removes identical files then keeps the oldest one. * `--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. For example to rename all the identically named photos in your Google Photos directory, do @@ -1153,7 +1178,7 @@ rclone dedupe [mode] remote:path [flags] ### Options ``` - --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") + --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default "interactive") -h, --help help for dedupe ``` @@ -1242,6 +1267,9 @@ 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] ``` @@ -1249,7 +1277,8 @@ rclone authorize [flags] ### Options ``` - -h, --help help for authorize + --auth-no-open-browser Do not automatically open auth link in default browser + -h, --help help for authorize ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -1744,10 +1773,15 @@ Copy url content to dest. ### Synopsis -Download urls content and copy it to destination -without saving it in tmp storage. +Download a URL's content and copy it to the destination without saving +it in temporary storage. -Setting --auto-filename flag will cause retrieving file name from url and using it in destination path. +Setting --auto-filename will cause the file name to be retreived from +the from URL (after any redirections) and used in the destination +path. + +Setting --stdout or making the output file name "-" will cause the +output to be written to standard output. ``` @@ -1757,8 +1791,9 @@ rclone copyurl https://example.com dest:path [flags] ### Options ``` - -a, --auto-filename Get the file name from the url and use it for destination file path + -a, --auto-filename Get the file name from the URL and use it for destination file path -h, --help help for copyurl + --stdout Write the output to stdout rather than a file ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -2074,7 +2109,8 @@ rclone hashsum remote:path [flags] ### Options ``` - -h, --help help for hashsum + --base64 Output base64 encoded hashsum + -h, --help help for hashsum ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -2328,7 +2364,9 @@ The output is an array of Items, where each Item looks like this If --hash is not specified the Hashes property won't be emitted. -If --no-modtime is specified then ModTime will be blank. +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 --encrypted is not specified the Encrypted won't be emitted. @@ -2386,14 +2424,15 @@ rclone lsjson remote:path [flags] ### Options ``` - --dirs-only Show only directories in the listing. - -M, --encrypted Show the encrypted names. - --files-only Show only files in the listing. - --hash Include hashes in the output (may take longer). - -h, --help help for lsjson - --no-modtime Don't read the modification time (can speed things up). - --original Show the ID of the underlying Object. - -R, --recursive Recurse into the listing. + --dirs-only Show only directories in the listing. + -M, --encrypted Show the encrypted names. + --files-only Show only files in the listing. + --hash Include hashes in the output (may take longer). + -h, --help help for lsjson + --no-mimetype Don't read the mime type (can speed things up). + --no-modtime Don't read the modification time (can speed things up). + --original Show the ID of the underlying Object. + -R, --recursive Recurse into the listing. ``` See the [global flags page](https://rclone.org/flags/) for global options not listed here. @@ -2815,6 +2854,7 @@ Here are the keys - press '?' to toggle the help on and off g toggle graph n,s,C sort by name,size,count d delete file/directory + y copy current path to clipbard Y display current path ^L refresh screen ? to toggle help on and off @@ -5151,6 +5191,19 @@ 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 ### + +This specifies the amount of time to wait for a server's first +response headers after fully writing the request headers if the +request has an "Expect: 100-continue" header. Not all backends support +using this. + +Zero means no timeout and causes the body to be sent immediately, +without waiting for the server to approve. This time does not include +the time to send the request header. + +The default is `1s`. Set to 0 to disable. + ### --ignore-case-sync ### Using this option will cause rclone to ignore the case of the files @@ -5284,8 +5337,8 @@ queue is in use. Note that it will use in the order of N kB of memory when the backlog is in use. Setting this large allows rclone to calculate how many files are -pending more accurately and give a more accurate estimated finish -time. +pending more accurately, give a more accurate estimated finish +time and make `--order-by` work more accurately. Setting this small will make rclone more synchronous to the listings of the remote which may be desirable. @@ -5314,6 +5367,17 @@ files not recursed through are considered excluded and will be deleted on the destination. Test first with `--dry-run` if you are not sure what will happen. +### --max-duration=TIME ### + +Rclone will stop scheduling new transfers when it has run for the +duration specified. + +Defaults to off. + +When the limit is reached any existing transfers will complete. + +Rclone won't exit with an error if the transfer limit is reached. + ### --max-transfer=SIZE ### Rclone will stop transferring when it has reached the size specified. @@ -5383,6 +5447,23 @@ in effect (the defaults): - 500MB..750MB files will be downloaded with 3 streams - 750MB+ files will be downloaded with 4 streams +### --no-check-dest ### + +The `--no-check-dest` can be used with `move` or `copy` and it causes +rclone not to check the destination at all when copying files. + +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) +- `--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 +of the files are on the destination. + +This is a specialized flag which should be ignored by most users! + ### --no-gzip-encoding ### Don't set `Accept-Encoding: gzip`. This means that rclone won't ask @@ -5419,6 +5500,68 @@ 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). +### --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: + +- `size` - order by the size of the files +- `name` - order by the full path of the files +- `modtime` - order by the modification date of the files + +This can have a modifier appended with a comma: + +- `ascending` or `asc` - order so that the smallest (or oldest) is processed first +- `descending` or `desc` - order so that the largest (or newest) is processed first + +If no modifier is supplied then the order is `ascending`. + +For example + +- `--order-by size,desc` - send the largest files first +- `--order-by modtime,ascending` - send the oldest files first +- `--order-by name` - send the files with alphabetically by path first + +If the `--order-by` flag is not supplied or it is supplied with an +empty string then the default ordering will be used which is as +scanned. With `--checkers 1` this is mostly alphabetical, however +with the default `--checkers 8` it is somewhat random. + +#### Limitations + +The `--order-by` flag does not do a separate pass over the data. This +means that it may transfer some files out of the order specified if + +- there are no files in the backlog or the source has not been fully scanned yet +- there are more than [--max-backlog](#max-backlog-n) files in the backlog + +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. + +### --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](https://godoc.org/encoding/csv) +for more info. + +Eg + + --password-command echo hello + --password-command echo "hello with space" + --password-command echo "hello with ""quotes"" and space" + +See the [Configuration Encryption](#configuration-encryption) for more info. + ### -P, --progress ### This flag makes rclone update the stats in a static block in the @@ -5434,7 +5577,7 @@ with the `--stats` flag. This can be used with the `--stats-one-line` flag for a simpler display. -Note: On Windows until[this bug](https://github.com/Azure/go-ansiterm/issues/26) +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. @@ -5824,7 +5967,7 @@ your cloud services. This means that you should keep your If you are in an environment where that isn't possible, you can add a password to your configuration. This means that you will -have to enter the password every time you start rclone. +have to supply the password every time you start rclone. To add a password to your rclone configuration, execute `rclone config`. @@ -5861,9 +6004,9 @@ c/u/q> ``` Your configuration is now encrypted, and every time you start rclone -you will now be asked for the password. In the same menu, you can -change the password or completely remove encryption from your -configuration. +you will have to supply the password. See below for details. +In the same menu, you can change the password or completely remove +encryption from your configuration. There is no way to recover the configuration if you lose your password. @@ -5895,11 +6038,36 @@ Then source the file when you want to use it. From the shell you would do `source set-rclone-password`. It will then ask you for the password and set it in the environment variable. -If you are running rclone inside a script, you might want to disable +An alternate means of supplying the password is to provide a script +which will retrieve the password and print on standard output. This +script should have a fully specified path name and not rely on any +environment variables. The script is supplied either via +`--password-command="..."` command line argument or via the +`RCLONE_PASSWORD_COMMAND` environment variable. + +One useful example of this is using the `passwordstore` application +to retrieve the password: + +``` +export RCLONE_PASSWORD_COMMAND="pass rclone/config" +``` + +If the `passwordstore` password manager holds the password for the +rclone configuration, using the script method means the password +is primarily protected by the `passwordstore` system, and is never +embedded in the clear in scripts, nor available for examination +using the standard commands available. It is quite possible with +long running rclone sessions for copies of passwords to be innocently +captured in log files or terminal scroll buffers, etc. Using the +script method of supplying the password enhances the security of +the config password considerably. + +If you are running rclone inside a script, unless you are using the +`--password-command` method, you might want to disable password prompts. To do that, pass the parameter `--ask-password=false` to rclone. This will make rclone fail instead of asking for a password if `RCLONE_CONFIG_PASS` doesn't contain -a valid password. +a valid password, and `--password-command` has not been supplied. Developer options @@ -5917,7 +6085,14 @@ Write CPU profile to file. This can be analysed with `go tool pprof`. #### --dump flag,flag,flag #### The `--dump` flag takes a comma separated list of flags to dump info -about. These are: +about. + +Note that some headers including `Accept-Encoding` as shown may not +be correct in the request and the response may not show `Content-Encoding` +if the go standard libraries auto gzip encoding was in effect. In this case +the body of the request will be gunzipped before showing it. + +The available flags are: #### --dump headers #### @@ -6509,6 +6684,10 @@ 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. +`--files-from` expects a list of files as it's input. [rclone lsf](https://rclone.org/commands/rclone_lsf/) +has a compatible format that can be used to export file lists from +remotes. + 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. @@ -6723,10 +6902,13 @@ This will produce logs like this and rclone needs to continue to run to serve th This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI - see below for details. -By default, rclone will NOT check for GUI update each time it operates. You may alter this -behaviour by using `--rc-web-gui-update` to check and update. +If you wish to check for updates then you can add `--rc-web-gui-update` +to the command line. -Also, rclone will open the default browser automatically. You may disable it by using `--rc-web-gui-no-open-browser`. +If you find your GUI broken, you may force it to update by add `--rc-web-gui-force-update`. + +By default, rclone will open your browser. Add `--rc-web-gui-no-open-browser` +to disable this feature. ## Using the GUI @@ -6795,7 +6977,7 @@ Or instead of htpassword if you just want a single user and password: The GUI is being developed in the: [rclone/rclone-webui-react respository](https://github.com/rclone/rclone-webui-react). -Bug reports and contributions very welcome welcome :-) +Bug reports and contributions are very welcome :-) If you have questions then please ask them on the [rclone forum](https://forum.rclone.org/). @@ -6906,6 +7088,18 @@ Set this flag to check and update rclone-webui-react from the rc-web-fetch-url. Default Off. +### --rc-web-gui-force-update + +Set this flag to force update rclone-webui-react from the rc-web-fetch-url. + +Default Off. + +### --rc-web-gui-no-open-browser + +Set this flag to disable opening browser automatically when using web-gui. + +Default Off. + ### --rc-job-expire-duration=DURATION Expire finished async jobs older than DURATION (default 60s). @@ -7135,6 +7329,7 @@ Authentication is required for this call. ### config/get: Get a remote in the config file. {#config/get} Parameters: + - name - name of remote to get See the [config dump command](https://rclone.org/commands/rclone_config_dump/) command for more information on the above. @@ -7277,6 +7472,7 @@ 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: @@ -7312,14 +7508,22 @@ Returns the following values: Values for "transferring", "checking" and "lastError" are only assigned if data is available. The value for "eta" is null if an eta cannot be determined. -### core/stats-reset: Reset stats. {#core/stats-reset} +### core/stats-delete: Delete stats group. {#core/stats-delete} -This clears counters and errors for all stats or specific stats group if group -is provided. +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} @@ -7333,6 +7537,7 @@ returned. Note only the last 100 completed transfers are returned. Parameters + - group - name of the stats group (string) Returns the following values: @@ -7356,6 +7561,7 @@ Returns the following values: ### core/version: Shows the current version of rclone and the go runtime. {#core/version} This shows the current version of go and the go runtime + - version - rclone version, eg "v1.44" - decomposed - version number as [major, minor, patch, subpatch] - note patch and subpatch will be 999 for a git compiled version @@ -7364,19 +7570,60 @@ This shows the current version of go and the go runtime - 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") @@ -7391,6 +7638,7 @@ Results ### job/stop: Stop the running job {#job/stop} Parameters + - jobid - id of the job (integer) ### operations/about: Return the space used on the remote {#operations/about} @@ -7984,10 +8232,16 @@ 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` +- 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 @@ -8024,6 +8278,7 @@ Here is an overview of the major features of each cloud storage system. | 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 | No | - | @@ -8033,6 +8288,7 @@ Here is an overview of the major features of each cloud storage system. | put.io | CRC-32 | Yes | No | Yes | R | | QingStor | MD5 | No | No | No | R/W | | SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | +| SugarSync | - | No | No | No | - | | WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | | Yandex Disk | MD5 | Yes | No | No | R/W | | The local filesystem | All | Yes | Depends | No | - | @@ -8200,6 +8456,86 @@ A common source of invalid UTF-8 bytes are local filesystems, that store names in a different encoding than UTF-8 or UTF-16, like latin1. See the [local filenames](/local/#filenames) section for details. +#### 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 @@ -8241,6 +8577,7 @@ operations more efficient. | Jottacloud | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | Yes | | Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | | Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | +| Memory | No | Yes | No | No | No | Yes | Yes | No | No | No | | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | | Microsoft OneDrive | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | Yes | Yes | Yes | | OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | @@ -8250,6 +8587,7 @@ operations more efficient. | put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | | QingStor | No | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | | SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | +| SugarSync | Yes | Yes | Yes | Yes | No | No | Yes | Yes | No | Yes | | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | @@ -8353,10 +8691,10 @@ These flags are available for every command. -c, --checksum Skip based on checksum (if available) & size, not mod-time & size --client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth - --compare-dest string use DIR to server side copy flies from. + --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 Compare dest to DIR also. + --copy-dest string Implies --compare-dest but also copies files from path into destination. --cpuprofile string Write cpu profile to file --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring @@ -8370,6 +8708,7 @@ These flags are available for every command. --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read exclude patterns from file --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 -f, --filter stringArray Add a file-filtering rule @@ -8392,6 +8731,7 @@ These flags are available for every command. --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) @@ -8402,9 +8742,12 @@ These flags are available for every command. --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-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. @@ -8428,6 +8771,8 @@ These flags are available for every command. --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 --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) @@ -8454,7 +8799,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.50.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -8467,6 +8812,7 @@ and may be set in the config file. --acd-auth-url string Auth server URL. --acd-client-id string Amazon Application Client ID. --acd-client-secret string Amazon Application Client Secret. + --acd-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-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) @@ -8474,6 +8820,7 @@ and may be set in the config file. --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-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) @@ -8485,6 +8832,7 @@ and may be set in the config file. --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 @@ -8496,6 +8844,7 @@ and may be set in the config file. --box-client-id string Box App Client Id. --box-client-secret string Box App Client Secret --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) --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. @@ -8539,6 +8888,7 @@ and may be set in the config file. --drive-client-id string Google Application Client Id --drive-client-secret string Google Application Client Secret --drive-disable-http2 Disable drive using http2 (default true) + --drive-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. @@ -8553,23 +8903,28 @@ and may be set in the config file. --drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-file string Service Account Credentials JSON file path --drive-shared-with-me Only show files that are shared with me. - --drive-size-as-quota Show storage quota usage for file size. + --drive-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-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-trashed-only Only show files that are in the trash. --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) --drive-use-created-date Use file created date instead of modified date., + --drive-use-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-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) --dropbox-client-id string Dropbox App Client Id --dropbox-client-secret string Dropbox App Client Secret + --dropbox-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. --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-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 @@ -8580,6 +8935,7 @@ and may be set in the config file. --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. --gcs-client-id string Google Application Client Id --gcs-client-secret string Google Application Client Secret + --gcs-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. @@ -8596,11 +8952,14 @@ and may be set in the config file. --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --hubic-client-id string Hubic Client Id --hubic-client-secret string Hubic Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during streaming upload. + --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-unlink Remove existing public link to file/folder with link command rather than creating. --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --koofr-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) @@ -8609,10 +8968,12 @@ and may be set in the config file. -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-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 --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") @@ -8620,6 +8981,7 @@ and may be set in the config file. --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. --mega-user string User name @@ -8629,14 +8991,21 @@ and may be set in the config file. --onedrive-client-secret string Microsoft App Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-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. + --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. --opendrive-username string Username --pcloud-client-id string Pcloud App Client Id --pcloud-client-secret string Pcloud App Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --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 a endpoint URL to connection QingStor API. --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. --qingstor-secret-access-key string QingStor Secret Access Key (password) @@ -8647,11 +9016,14 @@ and may be set in the config file. --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 5G) --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-provider string Choose your S3 provider. --s3-region string Region to connect to. @@ -8676,13 +9048,26 @@ and may be set in the config file. --sftp-port string SSH port, leave blank to use default (22) --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. --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) @@ -8691,6 +9076,7 @@ and may be set in the config file. --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). @@ -8712,6 +9098,7 @@ and may be set in the config file. --webdav-vendor string Name of the Webdav site/service/software you are using --yandex-client-id string Yandex Client Id --yandex-client-secret string Yandex Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-unlink Remove existing public link to file/folder with link command rather than creating. ``` @@ -8851,6 +9238,17 @@ If you want to download a shared folder, add this parameter - Type: string - Default: "" +#### --fichier-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/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 @@ -9212,6 +9610,17 @@ underlying S3 storage. - Type: SizeSuffix - Default: 9G +#### --acd-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_ACD_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Limitations ### @@ -9249,6 +9658,7 @@ The S3 backend can be used with a number of different providers: * Dreamhost * IBM COS S3 * Minio +* Scaleway * Wasabi Paths are specified as `remote:bucket` (or `remote:` for the `lsd` @@ -9368,8 +9778,11 @@ 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 +14 | Needs location constraint ap-east-1. + \ "ap-east-1" / South America (Sao Paulo) Region -14 | Needs location constraint sa-east-1. +15 | Needs location constraint sa-east-1. \ "sa-east-1" region> 1 Endpoint for S3 API. @@ -9403,7 +9816,9 @@ Choose a number from below, or type in your own value \ "ap-northeast-2" 13 / Asia Pacific (Mumbai) \ "ap-south-1" -14 / South America (Sao Paulo) Region. +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. @@ -9497,8 +9912,8 @@ 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 +side copy to update the modification if the object can be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive storage the object will be uploaded rather than copied. #### Restricted filename characters @@ -9585,6 +10000,7 @@ The different authentication methods are tried in this order: - `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). @@ -9788,6 +10204,9 @@ Region to connect to. - "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. @@ -10007,6 +10426,8 @@ Used when creating buckets only. - Asia Pacific (Seoul) - "ap-south-1" - Asia Pacific (Mumbai) + - "ap-east-1" + - Asia Pacific (Hong Kong) - "sa-east-1" - South America (Sao Paulo) Region. @@ -10253,8 +10674,10 @@ The minimum is 0 and the maximum is 5GB. Chunk size to use for uploading. -When uploading files larger than upload_cutoff they will be uploaded -as multipart uploads using this chunk size. +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. @@ -10262,11 +10685,34 @@ 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-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: 5G + #### --s3-disable-checksum Don't store MD5 checksum with object metadata @@ -10310,7 +10756,9 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (eg Aliyun OSS or Netease COS) require this set to false. +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 @@ -10356,6 +10804,32 @@ WARNING: Storing parts of an incomplete multipart upload counts towards space us - 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-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_S3_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Anonymous access to public buckets ### @@ -11454,6 +11928,17 @@ The minimum value is 1 second. The maximum value is one week. - Type: Duration - Default: 1w +#### --b2-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_B2_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + Box @@ -11750,6 +12235,17 @@ Max number of times to try committing a multipart file. - Type: int - Default: 100 +#### --box-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_BOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot + ### Limitations ### @@ -12487,10 +12983,10 @@ error message in such cases. #### Chunk names -The default chunk name format is `*.rclone-chunk.###`, hence by default -chunk names are `BIG_FILE_NAME.rclone-chunk.001`, -`BIG_FILE_NAME.rclone-chunk.002` etc. You can configure a different name -format using the `--chunker-name-format` option. The format uses asterisk +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 @@ -12568,6 +13064,9 @@ 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 expence 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 @@ -12631,6 +13130,14 @@ Chunker requires wrapped remote to support server side `move` (or `copy` + 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. @@ -12973,6 +13480,17 @@ be set manually to something like: https://XXX.sharefile.com - Type: string - Default: "" +#### --sharefile-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/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 @@ -13268,12 +13786,12 @@ How to encrypt the filenames. - Type: string - Default: "standard" - Examples: - - "off" - - Don't encrypt the file names. Adds a ".bin" extension only. - "standard" - Encrypt the filenames see the docs for the details. - "obfuscate" - Very simple filename obfuscation. + - "off" + - Don't encrypt the file names. Adds a ".bin" extension only. #### --crypt-directory-name-encryption @@ -13627,6 +14145,17 @@ Impersonate this user when using a business account. - Type: string - Default: "" +#### --dropbox-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_DROPBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot + ### Limitations ### @@ -13645,6 +14174,25 @@ 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 + +5. Click the button `Create App` + +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 ------------------------------ @@ -13853,6 +14401,17 @@ Disable using EPSV even if server advertises support - Type: bool - Default: false +#### --ftp-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_FTP_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,RightSpace,Dot + ### Limitations ### @@ -14293,6 +14852,21 @@ The storage class to use when storing objects in Google Cloud Storage. - "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-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_GCS_ENCODING +- Type: MultiEncoder +- Default: Slash,CrLf,InvalidUtf8,Dot + Google Drive @@ -15026,6 +15600,21 @@ or move the photos locally and use the date the image was taken - 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. @@ -15111,10 +15700,20 @@ Keep new head revision of each file forever. #### --drive-size-as-quota -Show storage quota usage for file size. +Show sizes as storage quota usage, not actual size. -The storage used by a file is the size of the current version plus any -older versions that have been set to keep forever. +Show the size of a file as the 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 @@ -15180,6 +15779,38 @@ See: https://github.com/rclone/rclone/issues/3631 - 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-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_DRIVE_ENCODING +- Type: MultiEncoder +- Default: InvalidUtf8 + ### Limitations ### @@ -15981,6 +16612,17 @@ copy operations. - Type: bool - Default: false +#### --hubic-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_HUBIC_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + ### Limitations ### @@ -16000,7 +16642,7 @@ Paths are specified as `remote:path` Paths may be as deep as required, eg `remote:directory/subdirectory`. -To configure Jottacloud you will need to enter your username and password and select a mountpoint. +To configure Jottacloud you will need to generate a personal security token in the Jottacloud web inteface. You will the option to do in your [account security settings](https://www.jottacloud.com/web/secure). Note that the web inteface may refer to this token as a JottaCli token. Here is an example of how to make a remote called `remote`. First run: @@ -16031,16 +16673,8 @@ n) No y/n> n Remote config -Do you want to create a machine specific API key? - -Rclone has it's own Jottacloud API KEY which works fine as long as one only uses rclone on a single machine. When you want to use rclone with this account on more than one machine it's recommended to create a machine specific API key. These keys can NOT be shared between machines. - -y) Yes -n) No -y/n> y -Username> 0xC4KE@gmail.com -Your Jottacloud password is only required during setup and will not be stored. -password: +Generate a personal login token here: https://www.jottacloud.com/web/secure +Login Token> Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? @@ -16063,11 +16697,10 @@ Mountpoints> 1 [jotta] type = jottacloud user = 0xC4KE@gmail.com -client_id = ..... -client_secret = ........ token = {........} device = Jotta mountpoint = Archive +configVersion = 1 -------------------- y) Yes this is OK e) Edit this remote @@ -16091,7 +16724,7 @@ To copy a local directory to an Jottacloud directory called backup ### Devices and Mountpoints ### The official Jottacloud client registers a device for each computer you install it on and then creates a mountpoint for each folder you select for Backup. -The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. In most cases you'll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by the official rclone provides the option to select other devices and mountpoints during config. +The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. In most cases you'll want to use the Jotta/Archive device/mounpoint however if you want to access files uploaded by any of the official clients rclone provides the option to select other devices and mountpoints during config. ### --fast-list ### @@ -16200,6 +16833,17 @@ Files bigger than this can be resumed if the upload fail's. - Type: SizeSuffix - Default: 10M +#### --jottacloud-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_JOTTACLOUD_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### @@ -16363,6 +17007,17 @@ Does the backend support setting modification time. Set this to false if you use - Type: bool - Default: true +#### --koofr-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_KOOFR_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### @@ -16666,6 +17321,17 @@ Supported quirks: atomicmkdir binlist gzip insecure retry400 - Type: string - Default: "" +#### --mailru-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_MAILRU_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot + Mega @@ -16867,6 +17533,17 @@ permanently delete objects instead. - Type: bool - Default: false +#### --mega-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_MEGA_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Limitations ### @@ -16878,6 +17555,67 @@ 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. + +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 +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 / Memory + \ "memory" +[snip] +Storage> memory +** See help for memory backend at: https://rclone.org/memory/ ** + +Remote config + +-------------------- +[remote] +type = memory +-------------------- +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 + + rclone mount :memory: /mnt/tmp + rclone serve webdav :memory: + rclone serve sftp :memory: + +### Modified time and hashes ### + +The memory backend supports MD5 hashes and modification times accurate to 1 nS. + +#### Restricted filename characters + +The memory backend replaces the [default restricted characters +set](/overview/#restricted-characters). + + + + Microsoft Azure Blob Storage ----------------------------------------- @@ -17146,6 +17884,17 @@ tiering blob to "Hot" or "Cool". - Type: string - Default: "" +#### --azureblob-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_AZUREBLOB_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 + ### Limitations ### @@ -17275,12 +18024,16 @@ To copy a local directory to an OneDrive directory called backup ### Getting your own Client ID and Key ### -rclone uses a pair of Client ID and Key shared by all rclone users when performing requests by default. +You can use your own Client ID if the default (`client_id` left blank) +one doesn't work for you or you see lots of throttling. The default +Client ID and Key is shared by all rclone users when performing +requests. + 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, then click `New registration`. -2. Enter a name for your app, choose your account type, select `Web` in `Redirect URI` Enter `http://localhost:53682/` and click Register. Copy and keep the `Application (client) ID` under the app name for later use. +2. Enter a name for your app, choose account type `Any Azure AD directory - Multitenant`, select `Web` in `Redirect URI` Enter `http://localhost:53682/` and click Register. Copy and keep the `Application (client) ID` under the app name for later use. 3. Under `manage` select `Certificates & secrets`, click `New client secret`. Copy and keep that secret for later use. 4. Under `manage` select `API permissions`, click `Add a permission` and select `Microsoft Graph` then select `delegated permissions`. 5. Search and select the follwing permssions: `Files.Read`, `Files.ReadWrite`, `Files.Read.All`, `Files.ReadWrite.All`, `offline_access`, `User.Read`. Once selected click `Add permissions` at the bottom. @@ -17418,6 +18171,17 @@ listing, set this option. - Type: bool - Default: false +#### --onedrive-encoding + +This sets the encoding for the backend. + +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 + ### Limitations ### @@ -17655,6 +18419,33 @@ Password. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to opendrive (OpenDrive). + +#### --opendrive-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_OPENDRIVE_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot + +#### --opendrive-chunk-size + +Files will be uploaded in chunks this size. + +Note that these chunks are buffered in memory so increasing them will +increase memory use. + +- Config: chunk_size +- Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 10M + ### Limitations ### @@ -17930,6 +18721,17 @@ this may help to speed up the transfers. - Type: int - Default: 1 +#### --qingstor-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_QINGSTOR_ENCODING +- Type: MultiEncoder +- Default: Slash,Ctl,InvalidUtf8 + Swift @@ -17991,7 +18793,7 @@ Choose a number from below, or type in your own value 5 / Memset Memstore UK v2 \ "https://auth.storage.memset.com/v2.0" 6 / OVH - \ "https://auth.cloud.ovh.net/v2.0" + \ "https://auth.cloud.ovh.net/v3" auth> User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). user_id> @@ -18207,7 +19009,7 @@ Authentication URL for server (OS_AUTH_URL). - Memset Memstore UK - "https://auth.storage.memset.com/v2.0" - Memset Memstore UK v2 - - "https://auth.cloud.ovh.net/v2.0" + - "https://auth.cloud.ovh.net/v3" - OVH #### --swift-user-id @@ -18389,6 +19191,17 @@ copy operations. - Type: bool - Default: false +#### --swift-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_SWIFT_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + ### Modified time ### @@ -18568,6 +19381,21 @@ Leave blank normally. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to pcloud (Pcloud). + +#### --pcloud-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PCLOUD_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + premiumize.me @@ -18684,6 +19512,21 @@ This is not normally used - use oauth instead. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to premiumizeme (premiumize.me). + +#### --premiumizeme-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PREMIUMIZEME_ENCODING +- Type: MultiEncoder +- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### @@ -18802,6 +19645,21 @@ Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. +### Advanced Options + +Here are the advanced options specific to putio (Put.io). + +#### --putio-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PUTIO_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + SFTP @@ -19120,6 +19978,15 @@ The command used to read sha1 hashes. Leave blank for autodetect. - Type: string - Default: "" +#### --sftp-skip-links + +Set to skip any symlinks and any other non regular files. + +- Config: skip_links +- Env Var: RCLONE_SFTP_SKIP_LINKS +- Type: bool +- Default: false + ### Limitations ### @@ -19174,6 +20041,253 @@ rsync.net is supported through the SFTP backend. See [rsync.net's documentation of rclone examples](https://www.rsync.net/products/rclone.html). +SugarSync +----------------------------------------- + +[SugarSync](https://sugarsync.com) is a cloud service that enables +active synchronization of files across computers and other devices for +file backup, access, syncing, and sharing. + +The initial setup for SugarSync involves getting a token from SugarSync which you +can do with rclone. `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 / Sugarsync + \ "sugarsync" +[snip] +Storage> sugarsync +** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** + +Sugarsync App ID. +Leave blank to use rclone's. +Enter a string value. Press Enter for the default (""). +app_id> +Sugarsync Access Key ID. +Leave blank to use rclone's. +Enter a string value. Press Enter for the default (""). +access_key_id> +Sugarsync Private Access Key +Leave blank to use rclone's. +Enter a string value. Press Enter for the default (""). +private_access_key> +Permanently delete files if true +otherwise put them in the deleted files. +Enter a boolean value (true or false). Press Enter for the default ("false"). +hard_delete> +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +Username (email address)> nick@craig-wood.com +Your Sugarsync password is only required during setup and will not be stored. +password: +-------------------- +[remote] +type = sugarsync +refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX +-------------------- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +``` + +Note that the config asks for your email and password but doesn't +store them, it only uses them to get the initial token. + +Once configured you can then use `rclone` like this, + +List directories (sync folders) in top level of your SugarSync + + rclone lsd remote: + +List all the files in your SugarSync folder "Test" + + rclone ls remote:Test + +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`. + +**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 ### + +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 + +SugarSync replaces the [default restricted characters set](/overview/#restricted-characters) +except for DEL. + +Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), +as they can't be used in XML strings. + +### 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 + +Here are the standard options specific to sugarsync (Sugarsync). + +#### --sugarsync-app-id + +Sugarsync App ID. + +Leave blank to use rclone's. + +- Config: app_id +- Env Var: RCLONE_SUGARSYNC_APP_ID +- Type: string +- Default: "" + +#### --sugarsync-access-key-id + +Sugarsync Access Key ID. + +Leave blank to use rclone's. + +- Config: access_key_id +- Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID +- Type: string +- Default: "" + +#### --sugarsync-private-access-key + +Sugarsync Private Access Key + +Leave blank to use rclone's. + +- Config: private_access_key +- Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY +- Type: string +- Default: "" + +#### --sugarsync-hard-delete + +Permanently delete files if true +otherwise put them in the deleted files. + +- Config: hard_delete +- Env Var: RCLONE_SUGARSYNC_HARD_DELETE +- Type: bool +- Default: false + +### Advanced Options + +Here are the advanced options specific to sugarsync (Sugarsync). + +#### --sugarsync-refresh-token + +Sugarsync refresh token + +Leave blank normally, will be auto configured by rclone. + +- Config: refresh_token +- Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN +- Type: string +- Default: "" + +#### --sugarsync-authorization + +Sugarsync authorization + +Leave blank normally, will be auto configured by rclone. + +- Config: authorization +- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION +- Type: string +- Default: "" + +#### --sugarsync-authorization-expiry + +Sugarsync authorization expiry + +Leave blank normally, will be auto configured by rclone. + +- Config: authorization_expiry +- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY +- Type: string +- Default: "" + +#### --sugarsync-user + +Sugarsync user + +Leave blank normally, will be auto configured by rclone. + +- Config: user +- Env Var: RCLONE_SUGARSYNC_USER +- Type: string +- Default: "" + +#### --sugarsync-root-id + +Sugarsync root id + +Leave blank normally, will be auto configured by rclone. + +- Config: root_id +- Env Var: RCLONE_SUGARSYNC_ROOT_ID +- Type: string +- Default: "" + +#### --sugarsync-deleted-id + +Sugarsync deleted folder id + +Leave blank normally, will be auto configured by rclone. + +- Config: deleted_id +- Env Var: RCLONE_SUGARSYNC_DELETED_ID +- Type: string +- Default: "" + +#### --sugarsync-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_SUGARSYNC_ENCODING +- Type: MultiEncoder +- Default: Slash,Ctl,InvalidUtf8,Dot + + + Union ----------------------------------------- @@ -19768,6 +20882,17 @@ Default is false, meaning link command will create or retrieve public link. - Type: bool - Default: false +#### --yandex-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_YANDEX_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,InvalidUtf8,Dot + Local Filesystem @@ -20179,10 +21304,176 @@ to override the default choice. - Type: bool - Default: false +#### --local-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_LOCAL_ENCODING +- Type: MultiEncoder +- Default: Slash,Dot + # Changelog +## v1.51.0 - 2020-02-01 + +* New backends + * [Memory](/memory) (Nick Craig-Wood) + * [Sugarsync](/sugarsync) (Nick Craig-Wood) +* New Features + * Adjust all backends to have `--backend-encoding` parameter (Nick Craig-Wood) + * this enables the encoding for special characters to be adjusted or disabled + * Add `--max-duration` flag to control the maximum duration of a transfer session (boosh) + * Add `--expect-continue-timeout` flag, default 1s (Nick Craig-Wood) + * Add `--no-check-dest` flag for copying without testing the destination (Nick Craig-Wood) + * Implement `--order-by` flag to order transfers (Nick Craig-Wood) + * accounting + * Don't show entries in both transferring and checking (Nick Craig-Wood) + * Add option to delete stats (Aleksandar Jankovic) + * build + * Compress the test builds with gzip (Nick Craig-Wood) + * Implement a framework for starting test servers during tests (Nick Craig-Wood) + * cmd: Always print elapsed time to tenth place seconds in progress (Gary Kim) + * config + * Add `--password-command` to allow dynamic config password (Damon Permezel) + * Give config questions default values (Nick Craig-Wood) + * Check a remote exists when creating a new one (Nick Craig-Wood) + * copyurl: Add `--stdout` flag to write to stdout (Nick Craig-Wood) + * dedupe: Implement keep smallest too (Nick Craig-Wood) + * hashsum: Add flag `--base64` flag (landall) + * lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick Craig-Wood) + * lsjson: Add `--no-mimetype` flag (Nick Craig-Wood) + * rc: Add methods to turn on blocking and mutex profiling (Nick Craig-Wood) + * rcd + * Adding group parameter to stats (Chaitanya) + * Move webgui apart; option to disable browser (Xiaoxing Ye) + * serve sftp: Add support for public key with auth proxy (Paul Tinsley) + * stats: Show deletes in stats and hide zero stats (anuar45) +* Bug Fixes + * accounting + * Fix error counter counting multiple times (Ankur Gupta) + * Fix error count shown as checks (Cnly) + * Clear finished transfer in stats-reset (Maciej Zimnoch) + * Added StatsInfo locking in statsGroups sum function (Michał Matczuk) + * asyncreader: Fix EOF error (buengese) + * check: Fix `--one-way` recursing more directories than it needs to (Nick Craig-Wood) + * chunkedreader: Disable hash calculation for first segment (Nick Craig-Wood) + * config + * Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye) + * SetValueAndSave ignore error if config section does not exist yet (buengese) + * cmd: Fix completion with an encrypted config (Danil Semelenov) + * 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) + * 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) + * Make NewOverrideObjectInfo public and factor uses (Nick Craig-Wood) + * proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood) + * vendor + * Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood) + * Update github.com/t3rm1n4l/go-mega to fix mega "illegal base64 data at input byte 22" (Nick Craig-Wood) + * Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu) + * Update t3rm1n4l/go-mega - fixes mega: couldn't login: crypto/aes: invalid key size 0 (Nick Craig-Wood) +* Mount + * Enable async reads for a 20% speedup (Nick Craig-Wood) + * Replace use of WriteAt with Write for cache mode >= writes and O_APPEND (Brett Dutro) + * Make sure we call unmount when exiting (Nick Craig-Wood) + * Don't build on go1.10 as bazil/fuse no longer supports it (Nick Craig-Wood) + * When setting dates discard out of range dates (Nick Craig-Wood) +* VFS + * Add a newly created file straight into the directory (Nick Craig-Wood) + * Only calculate one hash for reads for a speedup (Nick Craig-Wood) + * Make ReadAt for non cached files work better with non-sequential reads (Nick Craig-Wood) + * Fix edge cases when reading ModTime from file (Nick Craig-Wood) + * Make sure existing files opened for write show correct size (Nick Craig-Wood) + * Don't cache the path in RW file objects to fix renaming (Nick Craig-Wood) + * Fix rename of open files when using the VFS cache (Nick Craig-Wood) + * When renaming files in the cache, rename the cache item in memory too (Nick Craig-Wood) + * Fix open file renaming on drive when using `--vfs-cache-mode writes` (Nick Craig-Wood) + * Fix incorrect modtime for mv into mount with `--vfs-cache-modes writes` (Nick Craig-Wood) + * On rename, rename in cache too if the file exists (Anagh Kumar Baranwal) +* Local + * Make source file being updated errors be NoLowLevelRetry errors (Nick Craig-Wood) + * Fix update of hidden files on Windows (Nick Craig-Wood) +* Cache + * Follow move of upstream library github.com/coreos/bbolt github.com/etcd-io/bbolt (Nick Craig-Wood) + * Fix `fatal error: concurrent map writes` (Nick Craig-Wood) +* Crypt + * Reorder the filename encryption options (Thomas Eales) + * Correctly handle trailing dot (buengese) +* Chunker + * Reduce length of temporary suffix (Ivan Andreev) +* Drive + * Add `--drive-stop-on-upload-limit` flag to stop syncs when upload limit reached (Nick Craig-Wood) + * Add `--drive-use-shared-date` to use date file was shared instead of modified date (Garry McNulty) + * Make sure invalid auth for teamdrives always reports an error (Nick Craig-Wood) + * Fix `--fast-list` when using appDataFolder (Nick Craig-Wood) + * Use multipart resumable uploads for streaming and uploads in mount (Nick Craig-Wood) + * Log an ERROR if an incomplete search is returned (Nick Craig-Wood) + * Hide dangerous config from the configurator (Nick Craig-Wood) +* Dropbox + * Treat `insufficient_space` errors as non retriable errors (Nick Craig-Wood) +* Jottacloud + * Use new auth method used by official client (buengese) + * Add URL to generate Login Token to config wizard (Nick Craig-Wood) + * Add support whitelabel versions (buengese) +* Koofr + * Use rclone HTTP client. (jaKa) +* Onedrive + * Add Sites.Read.All permission (Benjamin Richter) + * Add support "Retry-After" header (Motonori IWAMURO) +* Opendrive + * Implement `--opendrive-chunk-size` (Nick Craig-Wood) +* 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) + * 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) + * Use AWS web identity role provider if available (Tennix) + * Fix ExpiryWindow value (Aleksandar Jankovic) + * Fix DisableChecksum condition (Aleksandar Janković) + * Fix URL decoding of NextMarker (Nick Craig-Wood) +* SFTP + * Add `--sftp-skip-links` to skip symlinks and non regular files (Nick Craig-Wood) + * Retry Creation of Connection (Sebastian Brandt) + * Fix "failed to parse private key file: ssh: not an encrypted key" error (Nick Craig-Wood) + * Open files for update write only to fix AWS SFTP interop (Nick Craig-Wood) +* Swift + * Reserve segments of dynamic large object when delete objects in container what was enabled versioning. (Nguyễn Hữu Luân) + * Fix parsing of X-Object-Manifest (Nick Craig-Wood) + * Update OVH API endpoint (unbelauscht) +* WebDAV + * Make nextcloud only upload SHA1 checksums (Nick Craig-Wood) + * Fix case of "Bearer" in Authorization: header to agree with RFC (Nick Craig-Wood) + * Add Referer header to fix problems with WAFs (Nick Craig-Wood) + +## v1.50.2 - 2019-11-19 + +* Bug Fixes + * accounting: Fix memory leak on retries operations (Nick Craig-Wood) +* Drive + * Fix listing of the root directory with drive.files scope (Nick Craig-Wood) + * Fix --drive-root-folder-id with team/shared drives (Nick Craig-Wood) + +## v1.50.1 - 2019-11-02 + +* Bug Fixes + * hash: Fix accidentally changed hash names for `DropboxHash` and `CRC-32` (Nick Craig-Wood) + * fshttp: Fix error reporting on tpslimit token bucket errors (Nick Craig-Wood) + * fshttp: Don't print token bucket errors on context cancelled (Nick Craig-Wood) +* Local + * Fix listings of . on Windows (Nick Craig-Wood) +* Onedrive + * Fix DirMove/Move after Onedrive change (Xiaoxing Ye) + ## v1.50.0 - 2019-10-26 * New backends @@ -22782,7 +24073,7 @@ Contributors * Sheldon Rupp * albertony <12441419+albertony@users.noreply.github.com> * cron410 - * Anagh Kumar Baranwal + * Anagh Kumar Baranwal <6824881+darthShadow@users.noreply.github.com> * Felix Brucker * Santiago Rodríguez * Craig Miskell @@ -22853,7 +24144,7 @@ Contributors * garry415 * forgems * Florian Apolloner - * Aleksandar Jankovic + * Aleksandar Janković * Maran * nguyenhuuluan434 * Laura Hausmann @@ -22896,6 +24187,34 @@ Contributors * Carlos Ferreyra * Saksham Khanna * dausruddin <5763466+dausruddin@users.noreply.github.com> + * zero-24 + * Xiaoxing Ye + * Barry Muldrey + * Sebastian Brandt + * Marco Molteni + * Ankur Gupta + * Maciej Zimnoch + * anuar45 + * Fernando + * David Cole + * Wei He + * Outvi V <19144373+outloudvi@users.noreply.github.com> + * Thomas Kriechbaumer + * Tennix + * Ole Schütt + * Kuang-che Wu + * Thomas Eales + * Paul Tinsley + * Felix Hungenberg + * Benjamin Richter + * landall + * thestigma + * jtagcat <38327267+jtagcat@users.noreply.github.com> + * Damon Permezel + * boosh + * unbelauscht <58393353+unbelauscht@users.noreply.github.com> + * Motonori IWAMURO + * Benjapol Worakan # Contact the rclone project # diff --git a/MANUAL.txt b/MANUAL.txt index 99eae2213..6d0200a37 100644 --- a/MANUAL.txt +++ b/MANUAL.txt @@ -1,6 +1,6 @@ rclone(1) User Manual Nick Craig-Wood -Oct 26, 2019 +Feb 01, 2020 @@ -34,6 +34,7 @@ from: - Mail.ru Cloud - Memset Memstore - Mega +- Memory - Microsoft Azure Blob Storage - Microsoft OneDrive - Minio @@ -51,6 +52,7 @@ from: - rsync.net - Scaleway - SFTP +- SugarSync - Wasabi - WebDAV - Yandex Disk @@ -140,7 +142,15 @@ Run rclone config to setup. See rclone config docs for more details. rclone config -macOS installation from precompiled binary +macOS installation with brew + + brew install rclone + + +macOS installation from precompiled binary, using curl + +To avoid problems with macOS gatekeeper enforcing the binary to be +signed and notarized it is enough to download with curl. Download the latest version of rclone. @@ -167,6 +177,20 @@ Run rclone config to setup. See rclone config docs for more details. rclone config +macOS installation from precompiled binary, using a web browser + +When downloading a binary with a web browser, the browser will set the +macOS gatekeeper quarantine attribute. Starting from Catalina, when +attempting to run rclone, a pop-up will appear saying: + + “rclone” cannot be opened because the developer cannot be verified. + macOS cannot verify that this app is free from malware. + +The simplest fix is to run + + xattr -d com.apple.quarantine rclone + + Install with docker The rclone maintains a docker image for rclone. These images are @@ -307,10 +331,11 @@ See the following for detailed instructions for - Google Photos - HTTP - Hubic -- Jottacloud +- Jottacloud / GetSky.no - Koofr - Mail.ru Cloud - Mega +- Memory - Microsoft Azure Blob Storage - Microsoft OneDrive - Openstack Swift / Rackspace Cloudfiles / Memset Memstore @@ -320,6 +345,7 @@ See the following for detailed instructions for - put.io - QingStor - SFTP +- SugarSync - Union - WebDAV - Yandex Disk @@ -1073,6 +1099,8 @@ using an extra parameter with the same value one. - --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. @@ -1089,7 +1117,7 @@ Or Options - --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") + --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. @@ -1171,11 +1199,15 @@ 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] Options - -h, --help help for authorize + --auth-no-open-browser Do not automatically open auth link in default browser + -h, --help help for authorize See the global flags page for global options not listed here. @@ -1604,18 +1636,22 @@ Copy url content to dest. Synopsis -Download urls content and copy it to destination without saving it in -tmp storage. +Download a URL’s content and copy it to the destination without saving +it in temporary storage. -Setting –auto-filename flag will cause retrieving file name from url and -using it in destination path. +Setting –auto-filename will cause the file name to be retreived from the +from URL (after any redirections) and used in the destination path. + +Setting –stdout or making the output file name “-” will cause the output +to be written to standard output. rclone copyurl https://example.com dest:path [flags] Options - -a, --auto-filename Get the file name from the url and use it for destination file path + -a, --auto-filename Get the file name from the URL and use it for destination file path -h, --help help for copyurl + --stdout Write the output to stdout rather than a file See the global flags page for global options not listed here. @@ -1889,7 +1925,8 @@ Then Options - -h, --help help for hashsum + --base64 Output base64 encoded hashsum + -h, --help help for hashsum See the global flags page for global options not listed here. @@ -2117,7 +2154,13 @@ false, “IsDir” : false, “MimeType” : “application/octet-stream”, If –hash is not specified the Hashes property won’t be emitted. -If –no-modtime is specified then ModTime will be blank. +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 –encrypted is not specified the Encrypted won’t be emitted. @@ -2174,14 +2217,15 @@ bucket based remotes). Options - --dirs-only Show only directories in the listing. - -M, --encrypted Show the encrypted names. - --files-only Show only files in the listing. - --hash Include hashes in the output (may take longer). - -h, --help help for lsjson - --no-modtime Don't read the modification time (can speed things up). - --original Show the ID of the underlying Object. - -R, --recursive Recurse into the listing. + --dirs-only Show only directories in the listing. + -M, --encrypted Show the encrypted names. + --files-only Show only files in the listing. + --hash Include hashes in the output (may take longer). + -h, --help help for lsjson + --no-mimetype Don't read the mime type (can speed things up). + --no-modtime Don't read the modification time (can speed things up). + --original Show the ID of the underlying Object. + -R, --recursive Recurse into the listing. See the global flags page for global options not listed here. @@ -2583,6 +2627,7 @@ Here are the keys - press ‘?’ to toggle the help on and off g toggle graph n,s,C sort by name,size,count d delete file/directory + y copy current path to clipbard Y display current path ^L refresh screen ? to toggle help on and off @@ -4800,6 +4845,18 @@ 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 + +This specifies the amount of time to wait for a server’s first response +headers after fully writing the request headers if the request has an +“Expect: 100-continue” header. Not all backends support using this. + +Zero means no timeout and causes the body to be sent immediately, +without waiting for the server to approve. This time does not include +the time to send the request header. + +The default is 1s. Set to 0 to disable. + –ignore-case-sync Using this option will cause rclone to ignore the case of the files when @@ -4857,11 +4914,11 @@ but existing files will never be updated. If an existing file does not match between the source and destination, rclone will give the error Source and destination exist but do not match: immutable file modified. -Note that only commands which transfer files (e.g. sync, copy, move) are +Note that only commands which transfer files (e.g. sync, copy, move) are affected by this behavior, and only modification is disallowed. Files -may still be deleted explicitly (e.g. delete, purge) or implicitly (e.g. -sync, move). Use copy --immutable if it is desired to avoid deletion as -well as modification. +may still be deleted explicitly (e.g. delete, purge) or implicitly +(e.g. sync, move). Use copy --immutable if it is desired to avoid +deletion as well as modification. This can be useful as an additional layer of protection for immutable or append-only data sets (notably backup archives), where modification @@ -4933,7 +4990,8 @@ queue is in use. Note that it will use in the order of N kB of memory when the backlog is in use. Setting this large allows rclone to calculate how many files are pending -more accurately and give a more accurate estimated finish time. +more accurately, give a more accurate estimated finish time and make +--order-by work more accurately. Setting this small will make rclone more synchronous to the listings of the remote which may be desirable. @@ -4962,6 +5020,17 @@ recursed through are considered excluded and will be deleted on the destination. Test first with --dry-run if you are not sure what will happen. +–max-duration=TIME + +Rclone will stop scheduling new transfers when it has run for the +duration specified. + +Defaults to off. + +When the limit is reached any existing transfers will complete. + +Rclone won’t exit with an error if the transfer limit is reached. + –max-transfer=SIZE Rclone will stop transferring when it has reached the size specified. @@ -5028,6 +5097,25 @@ effect (the defaults): - 500MB..750MB files will be downloaded with 3 streams - 750MB+ files will be downloaded with 4 streams +–no-check-dest + +The --no-check-dest can be used with move or copy and it causes rclone +not to check the destination at all when copying files. + +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) +- --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 +of the files are on the destination. + +This is a specialized flag which should be ignored by most users! + –no-gzip-encoding Don’t set Accept-Encoding: gzip. This means that rclone won’t ask the @@ -5063,6 +5151,70 @@ 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). +–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: + +- size - order by the size of the files +- name - order by the full path of the files +- modtime - order by the modification date of the files + +This can have a modifier appended with a comma: + +- ascending or asc - order so that the smallest (or oldest) is + processed first +- descending or desc - order so that the largest (or newest) is + processed first + +If no modifier is supplied then the order is ascending. + +For example + +- --order-by size,desc - send the largest files first +- --order-by modtime,ascending - send the oldest files first +- --order-by name - send the files with alphabetically by path first + +If the --order-by flag is not supplied or it is supplied with an empty +string then the default ordering will be used which is as scanned. With +--checkers 1 this is mostly alphabetical, however with the default +--checkers 8 it is somewhat random. + +Limitations + +The --order-by flag does not do a separate pass over the data. This +means that it may transfer some files out of the order specified if + +- there are no files in the backlog or the source has not been fully + scanned yet +- there are more than –max-backlog files in the backlog + +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. + +–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. + +Eg + + --password-command echo hello + --password-command echo "hello with space" + --password-command echo "hello with ""quotes"" and space" + +See the Configuration Encryption for more info. + -P, –progress This flag makes rclone update the stats in a static block in the @@ -5077,8 +5229,8 @@ with the --stats flag. This can be used with the --stats-one-line flag for a simpler display. -Note: On Windows untilthis bug is fixed all non-ASCII characters will be -replaced with . when --progress is in use. +Note: On Windows until this bug is fixed all non-ASCII characters will +be replaced with . when --progress is in use. -q, –quiet @@ -5464,7 +5616,7 @@ cloud services. This means that you should keep your .rclone.conf file in a secure location. If you are in an environment where that isn’t possible, you can add a -password to your configuration. This means that you will have to enter +password to your configuration. This means that you will have to supply the password every time you start rclone. To add a password to your rclone configuration, execute rclone config. @@ -5499,8 +5651,9 @@ Go into s, Set configuration password: c/u/q> Your configuration is now encrypted, and every time you start rclone you -will now be asked for the password. In the same menu, you can change the -password or completely remove encryption from your configuration. +will have to supply the password. See below for details. In the same +menu, you can change the password or completely remove encryption from +your configuration. There is no way to recover the configuration if you lose your password. @@ -5529,10 +5682,33 @@ Then source the file when you want to use it. From the shell you would do source set-rclone-password. It will then ask you for the password and set it in the environment variable. -If you are running rclone inside a script, you might want to disable -password prompts. To do that, pass the parameter --ask-password=false to -rclone. This will make rclone fail instead of asking for a password if -RCLONE_CONFIG_PASS doesn’t contain a valid password. +An alternate means of supplying the password is to provide a script +which will retrieve the password and print on standard output. This +script should have a fully specified path name and not rely on any +environment variables. The script is supplied either via +--password-command="..." command line argument or via the +RCLONE_PASSWORD_COMMAND environment variable. + +One useful example of this is using the passwordstore application to +retrieve the password: + + export RCLONE_PASSWORD_COMMAND="pass rclone/config" + +If the passwordstore password manager holds the password for the rclone +configuration, using the script method means the password is primarily +protected by the passwordstore system, and is never embedded in the +clear in scripts, nor available for examination using the standard +commands available. It is quite possible with long running rclone +sessions for copies of passwords to be innocently captured in log files +or terminal scroll buffers, etc. Using the script method of supplying +the password enhances the security of the config password considerably. + +If you are running rclone inside a script, unless you are using the +--password-command method, you might want to disable password prompts. +To do that, pass the parameter --ask-password=false to rclone. This will +make rclone fail instead of asking for a password if RCLONE_CONFIG_PASS +doesn’t contain a valid password, and --password-command has not been +supplied. Developer options @@ -5549,7 +5725,14 @@ Write CPU profile to file. This can be analysed with go tool pprof. –dump flag,flag,flag The --dump flag takes a comma separated list of flags to dump info -about. These are: +about. + +Note that some headers including Accept-Encoding as shown may not be +correct in the request and the response may not show Content-Encoding if +the go standard libraries auto gzip encoding was in effect. In this case +the body of the request will be gunzipped before showing it. + +The available flags are: –dump headers @@ -6141,6 +6324,9 @@ 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. +--files-from expects a list of files as it’s input. rclone lsf has a +compatible format that can be used to export file lists from remotes. + 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. @@ -6326,7 +6512,7 @@ You can exclude dir3 from sync by running the following command: rclone sync --exclude-if-present .ignore dir1 remote:backup -Currently only one filename is supported, i.e. --exclude-if-present +Currently only one filename is supported, i.e. --exclude-if-present should not be used multiple times. @@ -6353,8 +6539,14 @@ serve the GUI: This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI - see below for details. -If you wish to check and update to the latest API version then you can add ---rc-web-gui-update to the command line. +If you wish to check for updates then you can add --rc-web-gui-update to +the command line. + +If you find your GUI broken, you may force it to update by add +--rc-web-gui-force-update. + +By default, rclone will open your browser. Add +--rc-web-gui-no-open-browser to disable this feature. Using the GUI @@ -6436,7 +6628,7 @@ Project The GUI is being developed in the: rclone/rclone-webui-react respository. -Bug reports and contributions very welcome welcome :-) +Bug reports and contributions are very welcome :-) If you have questions then please ask them on the rclone forum. @@ -6553,6 +6745,19 @@ https://api.github.com/repos/rclone/rclone-webui-react/releases/latest. Set this flag to check and update rclone-webui-react from the rc-web-fetch-url. +Default Off. + +–rc-web-gui-force-update + +Set this flag to force update rclone-webui-react from the +rc-web-fetch-url. + +Default Off. + +–rc-web-gui-no-open-browser + +Set this flag to disable opening browser automatically when using +web-gui. Default Off. @@ -6772,7 +6977,9 @@ Authentication is required for this call. config/get: Get a remote in the config file. {#config/get} -Parameters: - name - name of remote to get +Parameters: + +- name - name of remote to get See the config dump command command for more information on the above. @@ -6909,7 +7116,9 @@ This returns all available stats: If group is not provided then summed up stats for all groups will be returned. -Parameters - group - name of the stats group (string) +Parameters + +- group - name of the stats group (string) Returns the following values: @@ -6944,7272 +7153,8667 @@ Values for “transferring”, “checking” and “lastError” are only assig 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 and errors 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 - group - name of the stats group (string) +Parameters +- group - name of the stats group (string) - ### core/transferred: Returns stats about completed transfers. {#core/transferred} +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 - - group - name of the stats group (string) +Parameters - Returns the following values: +- group - name of the stats group (string) -{ “transferred”: an array of completed transfers (including failed -ones): [ { “name”: name of the file, “size”: size of the file in bytes, -“bytes”: total transferred bytes for this file, “checked”: if the -transfer is only checked (skipped, deleted), “timestamp”: integer -representing millisecond unix epoch, “error”: string description of the -error (empty if successfull), “jobid”: id of the job that this transfer -belongs to } ] } +Returns the following values: + { + "transferred": an array of completed transfers (including failed ones): + [ + { + "name": name of the file, + "size": size of the file in bytes, + "bytes": total transferred bytes for this file, + "checked": if the transfer is only checked (skipped, deleted), + "timestamp": integer representing millisecond unix epoch, + "error": string description of the error (empty if successfull), + "jobid": id of the job that this transfer belongs to + } + ] + } - ### core/version: Shows the current version of rclone and the go runtime. {#core/version} +core/version: Shows the current version of rclone and the go runtime. {#core/version} - This shows the current version of go and the go runtime - - version - rclone version, eg "v1.44" - - decomposed - version number as [major, minor, patch, subpatch] - - note patch and subpatch will be 999 for a git compiled version - - isGit - boolean - true if this was compiled from the git version - - os - OS in use as according to Go - - arch - cpu architecture in use according to Go - - goVersion - version of Go runtime in use +This shows the current version of go and the go runtime - ### job/list: Lists the IDs of the running jobs {#job/list} +- version - rclone version, eg “v1.44” +- decomposed - version number as [major, minor, patch, subpatch] + - note patch and subpatch will be 999 for a git compiled version +- isGit - boolean - true if this was compiled from the git version +- os - OS in use as according to Go +- arch - cpu architecture in use according to Go +- goVersion - version of Go runtime in use - Parameters - None +debug/set-block-profile-rate: Set runtime.SetBlockProfileRate for blocking profiling. {#debug/set-block-profile-rate} - Results - - jobids - array of integer job ids +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. - ### job/status: Reads the status of the job ID {#job/status} +To include every blocking event in the profile, pass rate = 1. To turn +off profiling entirely, pass rate <= 0. - Parameters - - jobid - id of the job (integer) +After calling this you can use this to see the blocking profile: - 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 + go tool pprof http://localhost:5572/debug/pprof/block - ### job/stop: Stop the running job {#job/stop} +Parameters - Parameters - - jobid - id of the job (integer) +- rate - int - ### operations/about: Return the space used on the remote {#operations/about} +debug/set-mutex-profile-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug/set-mutex-profile-fraction} - This takes the following parameters +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. - - fs - a remote name string eg "drive:" +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.) - The result is as returned from rclone about --json +Once this is set you can look use this to profile the mutex contention: - See the [about command](https://rclone.org/commands/rclone_size/) command for more information on the above. + go tool pprof http://localhost:5572/debug/pprof/mutex - Authentication is required for this call. +Parameters - ### operations/cleanup: Remove trashed files in the remote or path {#operations/cleanup} +- rate - int - This takes the following parameters +Results - - fs - a remote name string eg "drive:" +- previousRate - int - See the [cleanup command](https://rclone.org/commands/rclone_cleanup/) command for more information on the above. +job/list: Lists the IDs of the running jobs {#job/list} - Authentication is required for this call. +Parameters - None - ### operations/copyfile: Copy a file from source remote to destination remote {#operations/copyfile} +Results - This takes the following parameters +- jobids - array of integer job ids - - 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 +job/status: Reads the status of the job ID {#job/status} - Authentication is required for this call. +Parameters - ### operations/copyurl: Copy the URL to the object {#operations/copyurl} +- jobid - id of the job (integer) - This takes the following parameters +Results - - 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. +- 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 - Authentication is required for this call. +job/stop: Stop the running job {#job/stop} - ### operations/delete: Remove files in the path {#operations/delete} +Parameters - This takes the following parameters +- jobid - id of the job (integer) - - fs - a remote name string eg "drive:" +operations/about: Return the space used on the remote {#operations/about} - See the [delete command](https://rclone.org/commands/rclone_delete/) 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:” - ### operations/deletefile: Remove the single file pointed to {#operations/deletefile} +The result is as returned from rclone about –json - This takes the following parameters +See the about 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/cleanup: Remove trashed files in the remote or path {#operations/cleanup} - Authentication is required for this call. +This takes the following parameters - ### operations/fsinfo: Return information about the remote {#operations/fsinfo} +- fs - a remote name string eg “drive:” - This takes the following parameters +See the cleanup command command for more information on the above. - - fs - a remote name string eg "drive:" +Authentication is required for this call. - This returns info about the remote passed in; +operations/copyfile: Copy a file from source remote to destination remote {#operations/copyfile} -{ // 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 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 - This command does not have a command line equivalent so use this instead: +Authentication is required for this call. - rclone rc --loopback operations/fsinfo fs=remote: +operations/copyurl: Copy the URL to the object {#operations/copyurl} - ### operations/list: List the given remote and path in JSON format {#operations/list} +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” +- 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. - - 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 +Authentication is required for this call. - The result is +operations/delete: Remove files in the path {#operations/delete} - - list - - This is an array of objects as described in the lsjson command +This takes the following parameters - See the [lsjson command](https://rclone.org/commands/rclone_lsjson/) for more information on the above and examples. +- fs - a remote name string eg “drive:” - Authentication is required for this call. +See the delete command command for more information on the above. - ### operations/mkdir: Make a destination directory or container {#operations/mkdir} +Authentication is required for this call. - This takes the following parameters +operations/deletefile: Remove the single file pointed to {#operations/deletefile} - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +This takes the following parameters - See the [mkdir command](https://rclone.org/commands/rclone_mkdir/) 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 command for more information on the above. - ### operations/movefile: Move a file from source remote to destination remote {#operations/movefile} +Authentication is required for this call. - This takes the following parameters +operations/fsinfo: Return information about the remote {#operations/fsinfo} - - srcFs - a remote name string eg "drive:" for the source - - srcRemote - a path within that remote eg "file.txt" for the source - - dstFs - a remote name string eg "drive2:" for the destination - - dstRemote - a path within that remote eg "file2.txt" for the destination +This takes the following parameters - Authentication is required for this call. +- fs - a remote name string eg “drive:” - ### operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations/publiclink} +This returns info about the remote passed in; - This takes the following parameters + { + // 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 + } - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +This command does not have a command line equivalent so use this +instead: - Returns + rclone rc --loopback operations/fsinfo fs=remote: - - url - URL of the resource +operations/list: List the given remote and path in JSON format {#operations/list} - See the [link command](https://rclone.org/commands/rclone_link/) command for more information on the above. +This takes the following parameters - Authentication is required for this call. +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” +- 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/purge: Remove a directory or container and all of its contents {#operations/purge} +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" +See the lsjson command for more information on the above and examples. - See the [purge command](https://rclone.org/commands/rclone_purge/) command for more information on the above. +Authentication is required for this call. - Authentication is required for this call. +operations/mkdir: Make a destination directory or container {#operations/mkdir} - ### operations/rmdir: Remove an empty directory or container {#operations/rmdir} +This takes the following parameters - This takes the following parameters +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" +See the mkdir command command for more information on the above. - See the [rmdir command](https://rclone.org/commands/rclone_rmdir/) command for more information on the above. +Authentication is required for this call. - Authentication is required for this call. +operations/movefile: Move a file from source remote to destination remote {#operations/movefile} - ### operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs} +This takes the following parameters - 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 - - fs - a remote name string eg "drive:" - - remote - a path within that remote eg "dir" - - leaveRoot - boolean, set to true not to delete the root +Authentication is required for this call. - See the [rmdirs command](https://rclone.org/commands/rclone_rmdirs/) command for more information on the above. +operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations/publiclink} - Authentication is required for this call. +This takes the following parameters - ### operations/size: Count the number of bytes and files in remote {#operations/size} +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” - This takes the following parameters +Returns - - fs - a remote name string eg "drive:path/to/dir" +- url - URL of the resource - Returns +See the link command command for more information on the above. - - count - number of files - - bytes - number of bytes in those files +Authentication is required for this call. - See the [size command](https://rclone.org/commands/rclone_size/) command for more information on the above. +operations/purge: Remove a directory or container and all of its contents {#operations/purge} - Authentication is required for this call. +This takes the following parameters - ### options/blocks: List all the option blocks {#options/blocks} +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” - Returns - - options - a list of the options block names +See the purge command command for more information on the above. - ### options/get: Get all the options {#options/get} +Authentication is required for this call. - Returns an object where keys are option block names and values are an - object with the current option values in. +operations/rmdir: Remove an empty directory or container {#operations/rmdir} - This shows the internal names of the option within rclone which should - map to the external options very easily with a few exceptions. +This takes the following parameters - ### options/set: Set an option {#options/set} +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” - Parameters +See the rmdir command command for more information on the above. - - option block name containing an object with - - key: value +Authentication is required for this call. - Repeated as often as required. +operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs} - Only supply the options you wish to change. If an option is unknown - it will be silently ignored. Not all options will have an effect when - changed like this. +This takes the following parameters - For example: +- fs - a remote name string eg “drive:” +- remote - a path within that remote eg “dir” +- leaveRoot - boolean, set to true not to delete the root - This sets DEBUG level logs (-vv) +See the rmdirs command command for more information on the above. - rclone rc options/set --json '{"main": {"LogLevel": 8}}' +Authentication is required for this call. - And this sets INFO level logs (-v) +operations/size: Count the number of bytes and files in remote {#operations/size} - rclone rc options/set --json '{"main": {"LogLevel": 7}}' +This takes the following parameters - And this sets NOTICE level logs (normal without -v) +- fs - a remote name string eg “drive:path/to/dir” - rclone rc options/set --json '{"main": {"LogLevel": 6}}' +Returns - ### rc/error: This returns an error {#rc/error} +- count - number of files +- bytes - number of bytes in those files - This returns an error with the input as part of its error string. - Useful for testing error handling. +See the size command command for more information on the above. - ### rc/list: List all the registered remote control commands {#rc/list} +Authentication is required for this call. - This lists all the registered remote control commands as a JSON map in - the commands response. +options/blocks: List all the option blocks {#options/blocks} - ### rc/noop: Echo the input to the output parameters {#rc/noop} +Returns - options - a list of the options block names - 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. +options/get: Get all the options {#options/get} - ### rc/noopauth: Echo the input to the output parameters requiring auth {#rc/noopauth} +Returns an object where keys are option block names and values are an +object with the current option values in. - 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 shows the internal names of the option within rclone which should +map to the external options very easily with a few exceptions. - Authentication is required for this call. +options/set: Set an option {#options/set} - ### sync/copy: copy a directory from source remote to destination remote {#sync/copy} +Parameters - This takes the following parameters +- option block name containing an object with + - key: value - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +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. - See the [copy command](https://rclone.org/commands/rclone_copy/) command for more information on the above. +For example: - Authentication is required for this call. +This sets DEBUG level logs (-vv) - ### sync/move: move a directory from source remote to destination remote {#sync/move} + rclone rc options/set --json '{"main": {"LogLevel": 8}}' - This takes the following parameters +And this sets INFO level logs (-v) - - 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 + rclone rc options/set --json '{"main": {"LogLevel": 7}}' +And this sets NOTICE level logs (normal without -v) - See the [move command](https://rclone.org/commands/rclone_move/) command for more information on the above. + rclone rc options/set --json '{"main": {"LogLevel": 6}}' - Authentication is required for this call. +rc/error: This returns an error {#rc/error} - ### sync/sync: sync a directory from source remote to destination remote {#sync/sync} +This returns an error with the input as part of its error string. Useful +for testing error handling. - This takes the following parameters +rc/list: List all the registered remote control commands {#rc/list} - - srcFs - a remote name string eg "drive:src" for the source - - dstFs - a remote name string eg "drive:dst" for the destination +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} - See the [sync command](https://rclone.org/commands/rclone_sync/) command for more information on the above. +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} - ### vfs/forget: Forget files or directories in the directory cache. {#vfs/forget} +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 forgets the paths in the directory cache causing them to be - re-read from the remote when needed. +Authentication is required for this call. - If no paths are passed in then it will forget all the paths in the - directory cache. +sync/copy: copy a directory from source remote to destination remote {#sync/copy} - rclone rc vfs/forget +This takes the following parameters - 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 +- srcFs - a remote name string eg “drive:src” for the source +- dstFs - a remote name string eg “drive:dst” for the destination - rclone rc vfs/forget file=hello file2=goodbye dir=home/junk +See the copy command command for more information on the above. - ### vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs/poll-interval} +Authentication is required for this call. - Without any parameter given this returns the current status of the - poll-interval setting. +sync/move: move a directory from source remote to destination remote {#sync/move} - 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 takes the following parameters - rclone rc vfs/poll-interval interval=5m +- 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 - 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. +See the move command command for more information on the above. - The new poll-interval value will only be active when the timeout is - not reached. +Authentication is required for this call. - If poll-interval is updated or disabled temporarily, some changes - might not get picked up by the polling function, depending on the - used remote. +sync/sync: sync a directory from source remote to destination remote {#sync/sync} - ### vfs/refresh: Refresh the directory cache. {#vfs/refresh} +This takes the following parameters - This reads the directories for the specified paths and freshens the - directory cache. +- 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 refresh the root directory. +See the sync command command for more information on the above. - rclone rc vfs/refresh +Authentication is required for this call. - Otherwise pass directories in as dir=path. Any parameter key - starting with dir will refresh that directory, eg +vfs/forget: Forget files or directories in the directory cache. {#vfs/forget} - rclone rc vfs/refresh dir=home/junk dir2=data/misc +This forgets the paths in the directory cache causing them to be re-read +from the remote when needed. - If the parameter recursive=true is given the whole directory tree - will get refreshed. This refresh will use --fast-list if enabled. +If no paths are passed in then it will forget all the paths in the +directory cache. - + rclone rc vfs/forget - ## Accessing the remote control via HTTP +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 implements a simple HTTP based protocol. + rclone rc vfs/forget file=hello file2=goodbye dir=home/junk - 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. +vfs/poll-interval: Get the status or update the value of the poll-interval option. {#vfs/poll-interval} - All calls must made using POST. +Without any parameter given this returns the current status of the +poll-interval setting. - 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`. +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. - The response will be a JSON blob in the body of the response. This is - formatted to be reasonably human readable. + rclone rc vfs/poll-interval interval=5m - ### Error returns +The timeout=duration parameter can be used to specify a time to wait for +the current poll function to apply the new value. If timeout is less or +equal 0, which is the default, wait indefinitely. - If 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 new poll-interval value will only be active when the timeout is not +reached. -{ “error”: “Expecting string value for key "remote" (was float64)”, -“input”: { “fs”: “/tmp”, “remote”: 3 }, “status”: 400 “path”: -“operations/rmdir”, } +If poll-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. +vfs/refresh: Refresh the directory cache. {#vfs/refresh} - 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 +This reads the directories for the specified paths and freshens the +directory cache. - ### CORS +If no paths are passed in then it will refresh the root directory. - 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. + rclone rc vfs/refresh - ### Using POST with URL parameters only +Otherwise pass directories in as dir=path. Any parameter key starting +with dir will refresh that directory, eg -curl -X POST ‘http://localhost:5572/rc/noop?potato=1&sausage=2’ + 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. - Response -{ “potato”: “1”, “sausage”: “2” } +Accessing the remote control via HTTP +Rclone implements a simple HTTP based protocol. - Here is what an error response looks like: +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. -curl -X POST ‘http://localhost:5572/rc/error?potato=1&sausage=2’ +All calls must made using POST. -{ “error”: “arbitrary error on input map[potato:1 sausage:2]”, “input”: -{ “potato”: “1”, “sausage”: “2” } } +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. - Note that curl doesn't return errors to the shell unless you use the `-f` option +Error returns -$ 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 +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", + } - ### Using POST with a form +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 -curl –data “potato=1” –data “sausage=2” http://localhost:5572/rc/noop +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. - Response +Using POST with URL parameters only -{ “potato”: “1”, “sausage”: “2” } + curl -X POST 'http://localhost:5572/rc/noop?potato=1&sausage=2' +Response - Note that you can combine these with URL parameters too with the POST - parameters taking precedence. + { + "potato": "1", + "sausage": "2" + } -curl –data “potato=1” –data “sausage=2” -“http://localhost:5572/rc/noop?rutabaga=3&sausage=4” +Here is what an error response looks like: + curl -X POST 'http://localhost:5572/rc/error?potato=1&sausage=2' - Response + { + "error": "arbitrary error on input map[potato:1 sausage:2]", + "input": { + "potato": "1", + "sausage": "2" + } + } -{ “potato”: “1”, “rutabaga”: “3”, “sausage”: “4” } +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 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 - response + { + "potato": "1", + "sausage": "2" + } -{ “password”: “xyz”, “username”: “xyz” } +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" - This can be combined with URL parameters too if required. The JSON - blob takes precedence. +Response -curl -H “Content-Type: application/json” -X POST -d -‘{“potato”:2,“sausage”:1}’ -‘http://localhost:5572/rc/noop?rutabaga=3&potato=4’ + { + "potato": "1", + "rutabaga": "3", + "sausage": "4" + } -{ “potato”: 2, “rutabaga”: “3”, “sausage”: 1 } +Using POST with a JSON blob + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' http://localhost:5572/rc/noop - ## Debugging rclone with pprof ## +response - If you use the `--rc` flag this will also enable the use of the go - profiling tools on the same port. + { + "password": "xyz", + "username": "xyz" + } - To use these, first [install go](https://golang.org/doc/install). +This can be combined with URL parameters too if required. The JSON blob +takes precedence. - ### Debugging memory use + curl -H "Content-Type: application/json" -X POST -d '{"potato":2,"sausage":1}' 'http://localhost:5572/rc/noop?rutabaga=3&potato=4' - To profile rclone's memory use you can run: + { + "potato": 2, + "rutabaga": "3", + "sausage": 1 + } - go tool pprof -web http://localhost:5572/debug/pprof/heap - This should open a page in your browser showing what is using what - memory. +Debugging rclone with pprof - You can also use the `-text` flag to produce a textual summary +If you use the --rc flag this will also enable the use of the go +profiling tools on the same port. -$ 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 +To use these, first install go. +Debugging memory use - ### Debugging go routine leaks +To profile rclone’s memory use you can run: - Memory leaks are most often caused by go routine leaks keeping memory - alive which should have been garbage collected. + go tool pprof -web http://localhost:5572/debug/pprof/heap - See all active go routines using +This should open a page in your browser showing what is using what +memory. - curl http://localhost:5572/debug/pprof/goroutine?debug=1 +You can also use the -text flag to produce a textual summary - Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your browser. + $ 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 - ### Other profiles to look at +Debugging go routine leaks - You can see a summary of profiles available at http://localhost:5572/debug/pprof/ +Memory leaks are most often caused by go routine leaks keeping memory +alive which should have been garbage collected. - Here is how to use some of them: +See all active go routines using - * 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` + curl http://localhost:5572/debug/pprof/goroutine?debug=1 - 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). +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. - The profiling hook is [zero overhead unless it is used](https://stackoverflow.com/q/26545159/164234). +Other profiles to look at - # Overview of cloud storage systems # +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ - Each cloud storage system is slightly different. Rclone attempts to - provide a unified interface to them, but some underlying differences - show through. +Here is how to use some of them: - ## Features ## +- 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 - Here is an overview of the major features of each cloud storage system. +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. - | Name | Hash | ModTime | Case Insensitive | Duplicate Files | MIME Type | - | ---------------------------- |:-----------:|:-------:|:----------------:|:---------------:|:---------:| - | 1Fichier | Whirlpool | No | No | Yes | R | - | Amazon Drive | MD5 | No | Yes | No | R | - | Amazon S3 | MD5 | Yes | No | No | R/W | - | Backblaze B2 | SHA1 | Yes | No | No | R/W | - | Box | SHA1 | Yes | Yes | No | - | - | Citrix ShareFile | MD5 | Yes | Yes | No | - | - | Dropbox | DBHASH † | Yes | Yes | No | - | - | FTP | - | No | No | No | - | - | Google Cloud Storage | MD5 | Yes | No | No | R/W | - | Google Drive | MD5 | Yes | No | Yes | R/W | - | Google Photos | - | No | No | Yes | R | - | HTTP | - | No | No | No | R | - | Hubic | MD5 | Yes | No | No | R/W | - | Jottacloud | MD5 | Yes | Yes | No | R/W | - | Koofr | MD5 | No | Yes | No | - | - | Mail.ru Cloud | Mailru ‡‡‡ | Yes | Yes | No | - | - | Mega | - | No | No | Yes | - | - | Microsoft Azure Blob Storage | MD5 | Yes | No | No | R/W | - | Microsoft OneDrive | SHA1 ‡‡ | Yes | Yes | No | R | - | OpenDrive | MD5 | Yes | Yes | No | - | - | Openstack Swift | MD5 | Yes | No | No | R/W | - | pCloud | MD5, SHA1 | Yes | No | No | W | - | premiumize.me | - | No | Yes | No | R | - | put.io | CRC-32 | Yes | No | Yes | R | - | QingStor | MD5 | No | No | No | R/W | - | SFTP | MD5, SHA1 ‡ | Yes | Depends | No | - | - | WebDAV | MD5, SHA1 ††| Yes ††† | Depends | No | - | - | Yandex Disk | MD5 | Yes | No | No | R/W | - | The local filesystem | All | Yes | Depends | No | - | +The profiling hook is zero overhead unless it is used. - ### Hash ### - The cloud storage system supports various hash types of the objects. - The hashes are used when transferring data as an integrity check and - can be specifically used with the `--checksum` flag in syncs and in - the `check` command. - To use the verify checksums when transferring between cloud storage - systems they must support a common hash type. - - † Note that Dropbox supports [its own custom - hash](https://www.dropbox.com/developers/reference/content-hash). - This is an SHA256 sum of all the 4MB block SHA256s. - - ‡ SFTP supports checksums if the same login has shell access and `md5sum` - or `sha1sum` as well as `echo` are in the remote's PATH. - - †† WebDAV supports hashes when used with Owncloud and Nextcloud only. - - ††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. - - ‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive - for business and SharePoint server support Microsoft's own - [QuickXorHash](https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). - - ‡‡‡ Mail.ru uses its own modified SHA1 hash - - ### ModTime ### - - The cloud storage system supports setting modification times on - objects. If it does then this enables a using the modification times - as part of the sync. If not then only the size will be checked by - default, though the MD5SUM can be checked with the `--checksum` flag. - - All cloud storage systems support some kind of date on the object and - these will be set when transferring from the cloud storage system. - - ### Case Insensitive ### - - If a cloud storage systems is case sensitive then it is possible to - have two files which differ only in case, eg `file.txt` and - `FILE.txt`. If a cloud storage system is case insensitive then that - isn't possible. - - This can cause problems when syncing between a case insensitive - system and a case sensitive system. The symptom of this is that no - matter how many times you run the sync it never completes fully. - - The local filesystem and SFTP may or may not be case sensitive - depending on OS. - - * Windows - usually case insensitive, though case is preserved - * OSX - usually case insensitive, though it is possible to format case sensitive - * Linux - usually case sensitive, but there are case insensitive file systems (eg FAT formatted USB keys) - - Most of the time this doesn't cause any problems as people tend to - avoid files whose name differs only by case even on case sensitive - systems. - - ### Duplicate files ### - - If a cloud storage system allows duplicate files then it can have two - objects with the same name. - - This confuses rclone greatly when syncing - use the `rclone dedupe` - command to rename or remove duplicates. - - ### Restricted filenames ### - - Some cloud storage systems might have restrictions on the characters - that are usable in file or directory names. - When `rclone` detects such a name during a file upload, it will - transparently replace the restricted characters with similar looking - Unicode characters. - - This process is designed to avoid ambiguous file names as much as - possible and allow to move files between many cloud storage systems - transparently. - - The name shown by `rclone` to the user or during log output will only - contain a minimal set of [replaced characters](#restricted-characters) - to ensure correct formatting and not necessarily the actual name used - on the cloud storage. - - This transformation is reversed when downloading a file or parsing - `rclone` arguments. - For example, when uploading a file named `my file?.txt` to Onedrive - will be displayed as `my file?.txt` on the console, but stored as - `my file？.txt` (the `?` gets replaced by the similar looking `？` - character) to Onedrive. - The reverse transformation allows to read a file`unusual/name.txt` - from Google Drive, by passing the name `unusual／name.txt` (the `/` needs - to be replaced by the similar looking `／` character) on the command line. - - #### Default restricted characters {#restricted-characters} - - The table below shows the characters that are replaced by default. - - When a replacement character is found in a filename, this character - will be escaped with the `‛` character to avoid ambiguous file names. - (e.g. a file named `␀.txt` would shown as `‛␀.txt`) - - Each cloud storage backend can use a different set of characters, - which will be specified in the documentation for each backend. - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | SOH | 0x01 | ␁ | - | STX | 0x02 | ␂ | - | ETX | 0x03 | ␃ | - | EOT | 0x04 | ␄ | - | ENQ | 0x05 | ␅ | - | ACK | 0x06 | ␆ | - | BEL | 0x07 | ␇ | - | BS | 0x08 | ␈ | - | HT | 0x09 | ␉ | - | LF | 0x0A | ␊ | - | VT | 0x0B | ␋ | - | FF | 0x0C | ␌ | - | CR | 0x0D | ␍ | - | SO | 0x0E | ␎ | - | SI | 0x0F | ␏ | - | DLE | 0x10 | ␐ | - | DC1 | 0x11 | ␑ | - | DC2 | 0x12 | ␒ | - | DC3 | 0x13 | ␓ | - | DC4 | 0x14 | ␔ | - | NAK | 0x15 | ␕ | - | SYN | 0x16 | ␖ | - | ETB | 0x17 | ␗ | - | CAN | 0x18 | ␘ | - | EM | 0x19 | ␙ | - | SUB | 0x1A | ␚ | - | ESC | 0x1B | ␛ | - | FS | 0x1C | ␜ | - | GS | 0x1D | ␝ | - | RS | 0x1E | ␞ | - | US | 0x1F | ␟ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - - The default encoding will also encode these file names as they are - problematic with many cloud storage systems. - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - #### Invalid UTF-8 bytes {#invalid-utf8} - - Some backends only support a sequence of well formed UTF-8 bytes - as file or directory names. - - In this case all invalid UTF-8 bytes will be replaced with a quoted - representation of the byte value to allow uploading a file to such a - backend. For example, the invalid byte `0xFE` will be encoded as `‛FE`. - - A common source of invalid UTF-8 bytes are local filesystems, that store - names in a different encoding than UTF-8 or UTF-16, like latin1. See the - [local filenames](/local/#filenames) section for details. - - ### MIME Type ### - - MIME types (also known as media types) classify types of documents - using a simple text classification, eg `text/html` or - `application/pdf`. - - Some cloud storage systems support reading (`R`) the MIME type of - objects and some support writing (`W`) the MIME type of objects. - - The MIME type can be important if you are serving files directly to - HTTP from the storage system. - - If you are copying from a remote which supports reading (`R`) to a - remote which supports writing (`W`) then rclone will preserve the MIME - types. Otherwise they will be guessed from the extension, or the - remote itself may assign the MIME type. - - ## Optional Features ## - - All the remotes support a basic set of features, but there are some - optional features supported by some remotes used to make some - operations more efficient. - - | Name | Purge | Copy | Move | DirMove | CleanUp | ListR | StreamUpload | LinkSharing | About | EmptyDir | - | ---------------------------- |:-----:|:----:|:----:|:-------:|:-------:|:-----:|:------------:|:------------:|:-----:| :------: | - | 1Fichier | No | No | No | No | No | No | No | No | No | Yes | - | Amazon Drive | Yes | No | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Amazon S3 | No | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Backblaze B2 | No | Yes | No | No | Yes | Yes | Yes | Yes | No | No | - | Box | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | No | Yes | - | Citrix ShareFile | Yes | Yes | Yes | Yes | No | No | Yes | No | No | Yes | - | Dropbox | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | Yes | Yes | Yes | Yes | - | FTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Google Cloud Storage | Yes | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Google Drive | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Google Photos | No | No | No | No | No | No | No | No | No | No | - | HTTP | No | No | No | No | No | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | Yes | - | Hubic | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | Jottacloud | Yes | Yes | Yes | Yes | No | Yes | No | Yes | Yes | Yes | - | Mail.ru Cloud | Yes | Yes | Yes | Yes | Yes | No | No | Yes | Yes | Yes | - | Mega | Yes | No | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Microsoft Azure Blob Storage | Yes | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | Microsoft OneDrive | Yes | Yes | Yes | Yes | No [#575](https://github.com/rclone/rclone/issues/575) | No | No | Yes | Yes | Yes | - | OpenDrive | Yes | Yes | Yes | Yes | No | No | No | No | No | Yes | - | Openstack Swift | Yes † | Yes | No | No | No | Yes | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | No | - | pCloud | Yes | Yes | Yes | Yes | Yes | No | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | premiumize.me | Yes | No | Yes | Yes | No | No | No | Yes | Yes | Yes | - | put.io | Yes | No | Yes | Yes | Yes | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | QingStor | No | Yes | No | No | No | Yes | No | No [#2178](https://github.com/rclone/rclone/issues/2178) | No | No | - | SFTP | No | No | Yes | Yes | No | No | Yes | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | WebDAV | Yes | Yes | Yes | Yes | No | No | Yes ‡ | No [#2178](https://github.com/rclone/rclone/issues/2178) | Yes | Yes | - | Yandex Disk | Yes | Yes | Yes | Yes | Yes | No | Yes | Yes | Yes | Yes | - | The local filesystem | Yes | No | Yes | Yes | No | No | Yes | No | Yes | Yes | - - ### Purge ### - - This deletes a directory quicker than just deleting all the files in - the directory. - - † Note Swift and Hubic implement this in order to delete directory - markers but they don't actually have a quicker way of deleting files - other than deleting them individually. - - ‡ StreamUpload is not supported with Nextcloud - - ### Copy ### - - Used when copying an object to and from the same remote. This known - as a server side copy so you can copy a file without downloading it - and uploading it again. It is used if you use `rclone copy` or - `rclone move` if the remote doesn't support `Move` directly. - - If the server doesn't support `Copy` directly then for copy operations - the file is downloaded then re-uploaded. - - ### Move ### - - Used when moving/renaming an object on the same remote. This is known - as a server side move of a file. This is used in `rclone move` if the - server doesn't support `DirMove`. - - If the server isn't capable of `Move` then rclone simulates it with - `Copy` then delete. If the server doesn't support `Copy` then rclone - will download the file and re-upload it. - - ### DirMove ### - - This is used to implement `rclone move` to move a directory if - possible. If it isn't then it will use `Move` on each file (which - falls back to `Copy` then download and upload - see `Move` section). - - ### CleanUp ### - - This is used for emptying the trash for a remote by `rclone cleanup`. - - If the server can't do `CleanUp` then `rclone cleanup` will return an - error. - - ### ListR ### - - The remote supports a recursive list to list all the contents beneath - a directory quickly. This enables the `--fast-list` flag to work. - See the [rclone docs](/docs/#fast-list) for more details. - - ### StreamUpload ### - - Some remotes allow files to be uploaded without knowing the file size - in advance. This allows certain operations to work without spooling the - file to local disk first, e.g. `rclone rcat`. - - ### LinkSharing ### - - Sets the necessary permissions on a file or folder and prints a link - that allows others to access them, even if they don't have an account - on the particular cloud provider. - - ### About ### - - This is used to fetch quota information from the remote, like bytes - used/free/quota and bytes used in the trash. - - This is also used to return the space used, available for `rclone mount`. - - If the server can't do `About` then `rclone about` will return an - error. - - ### EmptyDir ### - - The remote supports empty directories. See [Limitations](/bugs/#limitations) - for details. Most Object/Bucket based remotes do not support this. - - # Global Flags - - This describes the global flags available to every rclone command - split into two groups, non backend and backend flags. - - ## Non Backend Flags - - These flags are available for every command. - - --ask-password Allow prompt for password for encrypted configuration. (default true) - --auto-confirm If enabled, do not request console confirmation. - --backup-dir string Make backups into hierarchy based in DIR. - --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. - --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) - --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. - --ca-cert string CA certificate used to verify servers - --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") - --checkers int Number of checkers to run in parallel. (default 8) - --c, –checksum Skip based on checksum (if available) & size, not mod-time -& size –client-cert string Client SSL certificate (PEM) for mutual TLS -auth –client-key string Client SSL private key (PEM) for mutual TLS auth -–compare-dest string use DIR to server side copy flies from. –config -string Config file. (default “$HOME/.config/rclone/rclone.conf”) -–contimeout duration Connect timeout (default 1m0s) –copy-dest string -Compare dest to DIR also. –cpuprofile string Write cpu profile to file -–delete-after When synchronizing, delete files on destination after -transferring (default) –delete-before When synchronizing, delete files -on destination before transferring –delete-during When synchronizing, -delete files during transfer –delete-excluded Delete files on dest -excluded from sync –disable string Disable a comma separated list of -features. Use help to see a list. -n, –dry-run Do a trial run with no -permanent changes –dump DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles -–dump-bodies Dump HTTP headers and bodies - may contain sensitive info -–dump-headers Dump HTTP headers - may contain sensitive info –exclude -stringArray Exclude files matching pattern –exclude-from stringArray -Read exclude patterns from file –exclude-if-present string Exclude -directories if filename is present –fast-list Use recursive list if -available. Uses more memory but fewer transactions. –files-from -stringArray Read list of source-file names from file -f, –filter -stringArray Add a file-filtering rule –filter-from stringArray Read -filtering patterns from a file –ignore-case Ignore case in filters (case -insensitive) –ignore-case-sync Ignore case when synchronizing -–ignore-checksum Skip post copy check of checksums. –ignore-errors -delete even if there are I/O errors –ignore-existing Skip all files that -exist on destination –ignore-size Ignore size when skipping use mod-time -or checksum. -I, –ignore-times Don’t skip files that match size and time -- transfer all files –immutable Do not modify files. Fail if existing -files have been modified. –include stringArray Include files matching -pattern –include-from stringArray Read include patterns from file -–log-file string Log everything to this file –log-format string Comma -separated list of log format options (default “date,time”) –log-level -string Log level DEBUG|INFO|NOTICE|ERROR (default “NOTICE”) -–low-level-retries int Number of low level retries to do. (default 10) -–max-age Duration Only transfer files younger than this in s or suffix -ms|s|m|h|d|w|M|y (default off) –max-backlog int Maximum number of -objects in sync or check backlog. (default 10000) –max-delete int When -synchronizing, limit the number of deletes (default -1) –max-depth int -If set limits the recursion depth to this. (default -1) –max-size -SizeSuffix Only transfer files smaller than this in k or suffix b|k|M|G -(default off) –max-stats-groups int Maximum number of stats groups to -keep in memory. On max oldest is discarded. (default 1000) –max-transfer -SizeSuffix Maximum size of data to transfer. (default off) –memprofile -string Write memory profile to file –min-age Duration Only transfer -files older than this in s or suffix ms|s|m|h|d|w|M|y (default off) -–min-size SizeSuffix Only transfer files bigger than this in k or suffix -b|k|M|G (default off) –modify-window duration Max time diff to be -considered the same (default 1ns) –multi-thread-cutoff SizeSuffix Use -multi-thread downloads for files above this size. (default 250M) -–multi-thread-streams int Max number of streams to use for multi-thread -downloads. (default 4) –no-check-certificate Do not verify the server -SSL certificate. Insecure. –no-gzip-encoding Don’t set Accept-Encoding: -gzip. –no-traverse Don’t traverse destination file system on copy. -–no-update-modtime Don’t update destination mod-time if files identical. --P, –progress Show progress during transfer. -q, –quiet Print as little -stuff as possible –rc Enable the remote control server. –rc-addr string -IPaddress:Port or :Port to bind server to. (default “localhost:5572”) -–rc-allow-origin string Set the allowed origin for CORS. –rc-baseurl -string Prefix for URLs - leave blank for root. –rc-cert string SSL PEM -key (concatenation of certificate and CA certificate) –rc-client-ca -string Client certificate authority to verify clients with –rc-files -string Path to local files to serve on the HTTP server. –rc-htpasswd -string htpasswd file - if not provided no authentication is done -–rc-job-expire-duration duration expire finished async jobs older than -this value (default 1m0s) –rc-job-expire-interval duration interval to -check for expired async jobs (default 10s) –rc-key string SSL PEM -Private key –rc-max-header-bytes int Maximum size of request header -(default 4096) –rc-no-auth Don’t require auth for certain methods. -–rc-pass string Password for authentication. –rc-realm string realm for -authentication (default “rclone”) –rc-serve Enable the serving of remote -objects. –rc-server-read-timeout duration Timeout for server reading -data (default 1h0m0s) –rc-server-write-timeout duration Timeout for -server writing data (default 1h0m0s) –rc-user string User name for -authentication. –rc-web-fetch-url string URL to fetch the releases for -webgui. (default -“https://api.github.com/repos/rclone/rclone-webui-react/releases/latest”) -–rc-web-gui Launch WebGUI on localhost –rc-web-gui-update Check and -update to latest version of web gui –retries int Retry operations this -many times if they fail (default 3) –retries-sleep duration Interval -between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to -disable) –size-only Skip based on size only, not mod-time or checksum -–stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 -to disable) (default 1m0s) –stats-file-name-length int Max file name -length in stats. 0 for no limit (default 45) –stats-log-level string Log -level to show –stats output DEBUG|INFO|NOTICE|ERROR (default “INFO”) -–stats-one-line Make the stats fit on one line. –stats-one-line-date -Enables –stats-one-line and add current date/time prefix. -–stats-one-line-date-format string Enables –stats-one-line-date and uses -custom formatted date. Enclose date string in double quotes (“). See -https://golang.org/pkg/time/#Time.Format –stats-unit string Show data -rate in stats as either ‘bits’ or ‘bytes’/s (default”bytes“) -–streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked -upload if file size is unknown. Upload starts after reaching cutoff or -when file ends. (default 100k) –suffix string Suffix to add to changed -files. –suffix-keep-extension Preserve the extension when using –suffix. -–syslog Use Syslog for logging –syslog-facility string Facility for -syslog, eg KERN,USER,… (default”DAEMON“) –timeout duration IO idle -timeout (default 5m0s) –tpslimit float Limit HTTP transactions per -second to this. –tpslimit-burst int Max burst of transactions for -–tpslimit. (default 1) –track-renames When synchronizing, track file -renames and do a server side move if possible –transfers int Number of -file transfers to run in parallel. (default 4) -u, –update Skip files -that are newer on the destination. –use-cookies Enable session -cookiejar. –use-json-log Use json log format. –use-mmap Use mmap -allocator (see docs). –use-server-modtime Use server modified time -instead of object metadata –user-agent string Set the user-agent to a -specified string. The default is rclone/ version -(default”rclone/v1.50.0") -v, –verbose count Print lots more stuff -(repeat for more) - - - ## Backend Flags - - These flags are available for every command. They control the backends - and may be set in the config file. - - --acd-auth-url string Auth server URL. - --acd-client-id string Amazon Application Client ID. - --acd-client-secret string Amazon Application Client Secret. - --acd-templink-threshold SizeSuffix Files >= this size will be downloaded via their tempLink. (default 9G) - --acd-token-url string Token server url. - --acd-upload-wait-per-gb Duration Additional time per GB to wait after a failed complete upload to see if it appears. (default 3m0s) - --alias-remote string Remote or path to alias. - --azureblob-access-tier string Access tier of blob: hot, cool or archive. - --azureblob-account string Storage Account Name (leave blank to use SAS URL or Emulator) - --azureblob-chunk-size SizeSuffix Upload chunk size (<= 100MB). (default 4M) - --azureblob-endpoint string Endpoint for the service - --azureblob-key string Storage Account Key (leave blank to use SAS URL or Emulator) - --azureblob-list-chunk int Size of blob list. (default 5000) - --azureblob-sas-url string SAS URL for container level access only - --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) - --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) - --b2-account string Account ID or Application Key ID - --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) - --b2-disable-checksum Disable checksums for large (> upload cutoff) files - --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) - --b2-download-url string Custom endpoint for downloads. - --b2-endpoint string Endpoint for the service. - --b2-hard-delete Permanently delete files on remote removal, otherwise hide files. - --b2-key string Application Key - --b2-test-mode string A flag string for X-Bz-Test-Mode header for debugging. - --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) - --b2-versions Include old versions in directory listings. - --box-box-config-file string Box App config.json location - --box-box-sub-type string (default "user") - --box-client-id string Box App Client Id. - --box-client-secret string Box App Client Secret - --box-commit-retries int Max number of times to try committing a multipart file. (default 100) - --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) - --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) - --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. - --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") - --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) - --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) - --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") - --cache-db-purge Clear all the cached data for this remote on start. - --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) - --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) - --cache-plex-insecure string Skip all certificate verifications when connecting to the Plex server - --cache-plex-password string The password of the Plex user - --cache-plex-url string The URL of the Plex server - --cache-plex-username string The username of the Plex user - --cache-read-retries int How many times to retry a read from a cache storage. (default 10) - --cache-remote string Remote to cache. - --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) - --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. - --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) - --cache-workers int How many workers should run in parallel to download chunks. (default 4) - --cache-writes Cache file data on writes through the FS - --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) - --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. - --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") - --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") - --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") - --chunker-remote string Remote to chunk/unchunk. - --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) - --L, –copy-links Follow symlinks and copy the pointed to item. -–crypt-directory-name-encryption Option to either encrypt directory -names or leave them intact. (default true) –crypt-filename-encryption -string How to encrypt the filenames. (default “standard”) -–crypt-password string Password or pass phrase for encryption. -–crypt-password2 string Password or pass phrase for salt. Optional but -recommended. –crypt-remote string Remote to encrypt/decrypt. -–crypt-show-mapping For all files listed show how the names encrypt. -–drive-acknowledge-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. -–drive-allow-import-name-change Allow the filetype to change when -uploading Google docs (e.g. file.doc to file.docx). This will confuse -sync and reupload every time. –drive-alternate-export Use alternate -export URLs for google documents export., –drive-auth-owner-only Only -consider files owned by the authenticated user. –drive-chunk-size -SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) -–drive-client-id string Google Application Client Id -–drive-client-secret string Google Application Client Secret -–drive-disable-http2 Disable drive using http2 (default true) -–drive-export-formats string Comma separated list of preferred formats -for downloading Google docs. (default “docx,xlsx,pptx,svg”) -–drive-formats string Deprecated: see export_formats –drive-impersonate -string Impersonate this user when using a service account. -–drive-import-formats string Comma separated list of preferred formats -for uploading Google docs. –drive-keep-revision-forever Keep new head -revision of each file forever. –drive-list-chunk int Size of listing -chunk 100-1000. 0 to disable. (default 1000) –drive-pacer-burst int -Number of API calls to allow without sleeping. (default 100) -–drive-pacer-min-sleep Duration Minimum time to sleep between API calls. -(default 100ms) –drive-root-folder-id string ID of the root folder -–drive-scope string Scope that rclone should use when requesting access -from drive. –drive-server-side-across-configs Allow server side -operations (eg copy) to work across different drive configs. -–drive-service-account-credentials string Service Account Credentials -JSON blob –drive-service-account-file string Service Account Credentials -JSON file path –drive-shared-with-me Only show files that are shared -with me. –drive-size-as-quota Show storage quota usage for file size. -–drive-skip-checksum-gphotos Skip MD5 checksum on Google photos and -videos only. –drive-skip-gdocs Skip google documents in all listings. -–drive-team-drive string ID of the Team Drive –drive-trashed-only Only -show files that are in the trash. –drive-upload-cutoff SizeSuffix Cutoff -for switching to chunked upload (default 8M) –drive-use-created-date Use -file created date instead of modified date., –drive-use-trash Send files -to the trash instead of deleting permanently. (default true) -–drive-v2-download-min-size SizeSuffix If Object’s are greater, use -drive v2 API to download. (default off) –dropbox-chunk-size SizeSuffix -Upload chunk size. (< 150M). (default 48M) –dropbox-client-id string -Dropbox App Client Id –dropbox-client-secret string Dropbox App Client -Secret –dropbox-impersonate string Impersonate this user when using a -business account. –fichier-api-key string Your API Key, get it from -https://1fichier.com/console/params.pl –fichier-shared-folder string If -you want to download a shared folder, add this parameter -–ftp-concurrency int Maximum number of FTP simultaneous connections, 0 -for unlimited –ftp-disable-epsv Disable using EPSV even if server -advertises support –ftp-host string FTP host to connect to -–ftp-no-check-certificate Do not verify the TLS certificate of the -server –ftp-pass string FTP password –ftp-port string FTP port, leave -blank to use default (21) –ftp-tls Use FTP over TLS (Implicit) –ftp-user -string FTP username, leave blank for current username, $USER -–gcs-bucket-acl string Access Control List for new buckets. -–gcs-bucket-policy-only Access checks should use bucket-level IAM -policies. –gcs-client-id string Google Application Client Id -–gcs-client-secret string Google Application Client Secret –gcs-location -string Location for the newly created buckets. –gcs-object-acl string -Access Control List for new objects. –gcs-project-number string Project -number. –gcs-service-account-file string Service Account Credentials -JSON file path –gcs-storage-class string The storage class to use when -storing objects in Google Cloud Storage. –gphotos-client-id string -Google Application Client Id –gphotos-client-secret string Google -Application Client Secret –gphotos-read-only Set to make the Google -Photos backend read only. –gphotos-read-size Set to read the size of -media items. –http-headers CommaSepList Set HTTP headers for all -transactions –http-no-head Don’t use HEAD requests to find file sizes in -dir listing –http-no-slash Set this if the site doesn’t end directories -with / –http-url string URL of http host to connect to –hubic-chunk-size -SizeSuffix Above this size files will be chunked into a _segments -container. (default 5G) –hubic-client-id string Hubic Client Id -–hubic-client-secret string Hubic Client Secret –hubic-no-chunk Don’t -chunk files during streaming upload. –jottacloud-hard-delete Delete -files permanently rather than putting them into the trash. -–jottacloud-md5-memory-limit SizeSuffix Files bigger than this will be -cached on disk to calculate the MD5 if required. (default 10M) -–jottacloud-unlink Remove existing public link to file/folder with link -command rather than creating. –jottacloud-upload-resume-limit SizeSuffix -Files bigger than this can be resumed if the upload fail’s. (default -10M) –koofr-endpoint string The Koofr API endpoint to use (default -“https://app.koofr.net”) –koofr-mountid string Mount ID of the mount to -use. If omitted, the primary mount is used. –koofr-password string Your -Koofr password for rclone (generate one at -https://app.koofr.net/app/admin/preferences/password) –koofr-setmtime -Does the backend support setting modification time. Set this to false if -you use a mount ID that points to a Dropbox or Amazon Drive backend. -(default true) –koofr-user string Your Koofr user name -l, –links -Translate symlinks to/from regular files with a ‘.rclonelink’ extension -–local-case-insensitive Force the filesystem to report itself as case -insensitive –local-case-sensitive Force the filesystem to report itself -as case sensitive. –local-no-check-updated Don’t check to see if the -files change during upload –local-no-unicode-normalization Don’t apply -unicode normalization to paths and filenames (Deprecated) –local-nounc -string Disable UNC (long path names) conversion on Windows -–mailru-check-hash What should copy do if file checksum is mismatched or -invalid (default true) –mailru-pass string Password -–mailru-speedup-enable Skip full upload if there is another file with -same data hash. (default true) –mailru-speedup-file-patterns string -Comma separated list of file name patterns eligible for speedup (put by -hash). (default “_.mkv,_.avi,_.mp4,_.mp3,_.zip,_.gz,_.rar,_.pdf”) -–mailru-speedup-max-disk SizeSuffix This option allows you to disable -speedup (put by hash) for large files (default 3G) -–mailru-speedup-max-memory SizeSuffix Files larger than the size given -below will always be hashed on disk. (default 32M) –mailru-user string -User name (usually email) –mega-debug Output more debug from Mega. -–mega-hard-delete Delete files permanently rather than putting them into -the trash. –mega-pass string Password. –mega-user string User name -x, -–one-file-system Don’t cross filesystem boundaries (unix/macOS only). -–onedrive-chunk-size SizeSuffix Chunk size to upload files with - must -be multiple of 320k (327,680 bytes). (default 10M) –onedrive-client-id -string Microsoft App Client Id –onedrive-client-secret string Microsoft -App Client Secret –onedrive-drive-id string The ID of the drive to use -–onedrive-drive-type string The type of the drive ( personal | business -| documentLibrary ) –onedrive-expose-onenote-files Set to make OneNote -files show up in directory listings. –opendrive-password string -Password. –opendrive-username string Username –pcloud-client-id string -Pcloud App Client Id –pcloud-client-secret string Pcloud App Client -Secret –qingstor-access-key-id string QingStor Access Key ID -–qingstor-chunk-size SizeSuffix Chunk size to use for uploading. -(default 4M) –qingstor-connection-retries int Number of connection -retries. (default 3) –qingstor-endpoint string Enter a endpoint URL to -connection QingStor API. –qingstor-env-auth Get QingStor credentials -from runtime. Only applies if access_key_id and secret_access_key is -blank. –qingstor-secret-access-key string QingStor Secret Access Key -(password) –qingstor-upload-concurrency int Concurrency for multipart -uploads. (default 1) –qingstor-upload-cutoff SizeSuffix Cutoff for -switching to chunked upload (default 200M) –qingstor-zone string Zone to -connect to. –s3-access-key-id string AWS Access Key ID. –s3-acl string -Canned ACL used when creating buckets and storing or copying objects. -–s3-bucket-acl string Canned ACL used when creating buckets. -–s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) -–s3-disable-checksum Don’t store MD5 checksum with object metadata -–s3-endpoint string Endpoint for S3 API. –s3-env-auth Get AWS -credentials from runtime (environment variables or EC2/ECS meta data if -no env vars). –s3-force-path-style If true use path style access if -false use virtual hosted style. (default true) –s3-leave-parts-on-error -If true avoid calling abort upload on a failure, leaving all -successfully uploaded parts on S3 for manual recovery. -–s3-location-constraint string Location constraint - must be set to -match the Region. –s3-provider string Choose your S3 provider. -–s3-region string Region to connect to. –s3-secret-access-key string AWS -Secret Access Key (password) –s3-server-side-encryption string The -server-side encryption algorithm used when storing this object in S3. -–s3-session-token string An AWS session token –s3-sse-kms-key-id string -If using KMS ID you must provide the ARN of Key. –s3-storage-class -string The storage class to use when storing new objects in S3. -–s3-upload-concurrency int Concurrency for multipart uploads. (default -4) –s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload -(default 200M) –s3-use-accelerate-endpoint If true use the AWS S3 -accelerated endpoint. –s3-v2-auth If true use v2 authentication. -–sftp-ask-password Allow asking for SFTP password when needed. -–sftp-disable-hashcheck Disable the execution of SSH commands to -determine if remote file hashing is available. –sftp-host string SSH -host to connect to –sftp-key-file string Path to PEM-encoded private key -file, leave blank or set key-use-agent to use ssh-agent. -–sftp-key-file-pass string The passphrase to decrypt the PEM-encoded -private key file. –sftp-key-use-agent When set forces the usage of the -ssh-agent. –sftp-md5sum-command string The command used to read md5 -hashes. Leave blank for autodetect. –sftp-pass string SSH password, -leave blank to use ssh-agent. –sftp-path-override string Override path -used by SSH connection. –sftp-port string SSH port, leave blank to use -default (22) –sftp-set-modtime Set the modified time on the remote if -set. (default true) –sftp-sha1sum-command string The command used to -read sha1 hashes. Leave blank for autodetect. –sftp-use-insecure-cipher -Enable the use of insecure ciphers and key exchange methods. –sftp-user -string SSH username, leave blank for current username, ncw -–sharefile-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= -256k. (default 64M) –sharefile-endpoint string Endpoint for API calls. -–sharefile-root-folder-id string ID of the root folder -–sharefile-upload-cutoff SizeSuffix Cutoff for switching to multipart -upload. (default 128M) –skip-links Don’t warn about skipped symlinks. -–swift-application-credential-id string Application Credential ID -(OS_APPLICATION_CREDENTIAL_ID) –swift-application-credential-name string -Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) -–swift-application-credential-secret string Application Credential -Secret (OS_APPLICATION_CREDENTIAL_SECRET) –swift-auth string -Authentication URL for server (OS_AUTH_URL). –swift-auth-token string -Auth Token from alternate authentication - optional (OS_AUTH_TOKEN) -–swift-auth-version int AuthVersion - optional - set to (1,2,3) if your -auth URL has no version (ST_AUTH_VERSION) –swift-chunk-size SizeSuffix -Above this size files will be chunked into a _segments container. -(default 5G) –swift-domain string User domain - optional (v3 auth) -(OS_USER_DOMAIN_NAME) –swift-endpoint-type string Endpoint type to -choose from the service catalogue (OS_ENDPOINT_TYPE) (default “public”) -–swift-env-auth Get swift credentials from environment variables in -standard OpenStack form. –swift-key string API key or password -(OS_PASSWORD). –swift-no-chunk Don’t chunk files during streaming -upload. –swift-region string Region name - optional (OS_REGION_NAME) -–swift-storage-policy string The storage policy to use when creating a -new container –swift-storage-url string Storage URL - optional -(OS_STORAGE_URL) –swift-tenant string Tenant name - optional for v1 -auth, this or tenant_id required otherwise (OS_TENANT_NAME or -OS_PROJECT_NAME) –swift-tenant-domain string Tenant domain - optional -(v3 auth) (OS_PROJECT_DOMAIN_NAME) –swift-tenant-id string Tenant ID - -optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) -–swift-user string User name to log in (OS_USERNAME). –swift-user-id -string User ID to log in - optional - most swift systems use user and -leave this blank (v3 auth) (OS_USER_ID). –union-remotes string List of -space separated remotes. –webdav-bearer-token string Bearer token -instead of user/pass (eg a Macaroon) –webdav-bearer-token-command string -Command to run to get a bearer token –webdav-pass string Password. -–webdav-url string URL of http host to connect to –webdav-user string -User name –webdav-vendor string Name of the Webdav site/service/software -you are using –yandex-client-id string Yandex Client Id -–yandex-client-secret string Yandex Client Secret –yandex-unlink Remove -existing public link to file/folder with link command rather than -creating. - - - 1Fichier - ----------------------------------------- - - This is a backend for the [1ficher](https://1fichier.com) cloud - storage service. Note that a Premium subscription is required to use - the API. - - Paths are specified as `remote:path` - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - The initial setup for 1Fichier involves getting the API key from the website which you - need to do in your browser. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Enter a string value. Press Enter for the default ("“). -Choose a number from below, or type in your own value [snip] XX / -1Fichier  ”fichier" [snip] Storage> fichier ** See help for fichier -backend at: https://rclone.org/fichier/ ** - -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. Press Enter for the default (""). api_key> example_key - -Edit advanced config? (y/n) y) Yes n) No y/n> Remote config ——————– -[remote] type = fichier api_key = example_key ——————– y) Yes this is OK -e) Edit this remote d) Delete this remote y/e/d> y - - - Once configured you can then use `rclone` like this, - - List directories in top level of your 1Fichier account - - rclone lsd remote: +OVERVIEW OF CLOUD STORAGE SYSTEMS - List all the files in your 1Fichier account - rclone ls remote: +Each cloud storage system is slightly different. Rclone attempts to +provide a unified interface to them, but some underlying differences +show through. - To copy a local directory to a 1Fichier directory called backup - rclone copy /home/source remote:backup +Features - ### Modified time and hashes ### +Here is an overview of the major features of each cloud storage system. - 1Fichier does not support modification times. It supports the Whirlpool hash algorithm. + 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 No - + Openstack Swift MD5 Yes No No R/W + pCloud MD5, SHA1 Yes No No W + premiumize.me - No Yes No R + put.io CRC-32 Yes No Yes R + QingStor MD5 No No No R/W + SFTP MD5, SHA1 ‡ Yes Depends No - + SugarSync - No No No - + WebDAV MD5, SHA1 †† Yes ††† Depends No - + Yandex Disk MD5 Yes No No R/W + The local filesystem All Yes Depends No - - ### Duplicated files ### +Hash - 1Fichier can have two files with exactly the same name and path (unlike a - normal file system). +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. - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. +To use the verify checksums when transferring between cloud storage +systems they must support a common hash type. - #### Restricted filename characters +† Note that Dropbox supports its own custom hash. This is an SHA256 sum +of all the 4MB block SHA256s. - In addition to the [default restricted characters set](/overview/#restricted-characters) - the following characters are also replaced: +‡ SFTP supports checksums if the same login has shell access and md5sum +or sha1sum as well as echo are in the remote’s PATH. + +†† WebDAV supports hashes when used with Owncloud and Nextcloud only. + +††† WebDAV supports modtimes when used with Owncloud and Nextcloud only. + +‡‡ Microsoft OneDrive Personal supports SHA1 hashes, whereas OneDrive +for business and SharePoint server support Microsoft’s own QuickXorHash. + +‡‡‡ Mail.ru uses its own modified SHA1 hash + +ModTime + +The cloud storage system supports setting modification times on objects. +If it does then this enables a using the modification times as part of +the sync. If not then only the size will be checked by default, though +the MD5SUM can be checked with the --checksum flag. + +All cloud storage systems support some kind of date on the object and +these will be set when transferring from the cloud storage system. + +Case Insensitive + +If a cloud storage systems is case sensitive then it is possible to have +two files which differ only in case, eg file.txt and FILE.txt. If a +cloud storage system is case insensitive then that isn’t possible. + +This can cause problems when syncing between a case insensitive system +and a case sensitive system. The symptom of this is that no matter how +many times you run the sync it never completes fully. + +The local filesystem and SFTP may or may not be case sensitive depending +on OS. + +- Windows - usually case insensitive, though case is preserved +- OSX - usually case insensitive, though it is possible to format case + sensitive +- Linux - usually case sensitive, but there are case insensitive file + systems (eg FAT formatted USB keys) + +Most of the time this doesn’t cause any problems as people tend to avoid +files whose name differs only by case even on case sensitive systems. + +Duplicate files + +If a cloud storage system allows duplicate files then it can have two +objects with the same name. + +This confuses rclone greatly when syncing - use the rclone dedupe +command to rename or remove duplicates. + +Restricted filenames + +Some cloud storage systems might have restrictions on the characters +that are usable in file or directory names. When rclone detects such a +name during a file upload, it will transparently replace the restricted +characters with similar looking Unicode characters. + +This process is designed to avoid ambiguous file names as much as +possible and allow to move files between many cloud storage systems +transparently. + +The name shown by rclone to the user or during log output will only +contain a minimal set of replaced characters to ensure correct +formatting and not necessarily the actual name used on the cloud +storage. + +This transformation is reversed when downloading a file or parsing +rclone arguments. For example, when uploading a file named my file?.txt +to Onedrive will be displayed as my file?.txt on the console, but stored +as my file？.txt (the ? gets replaced by the similar looking ？ +character) to Onedrive. The reverse transformation allows to read a +fileunusual/name.txt from Google Drive, by passing the name +unusual／name.txt (the / needs to be replaced by the similar looking ／ +character) on the command line. + +Default restricted characters + +The table below shows the characters that are replaced by default. + +When a replacement character is found in a filename, this character will +be escaped with the ‛ character to avoid ambiguous file names. (e.g. a +file named ␀.txt would shown as ‛␀.txt) + +Each cloud storage backend can use a different set of characters, which +will be specified in the documentation for each backend. + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + SOH 0x01 ␁ + STX 0x02 ␂ + ETX 0x03 ␃ + EOT 0x04 ␄ + ENQ 0x05 ␅ + ACK 0x06 ␆ + BEL 0x07 ␇ + BS 0x08 ␈ + HT 0x09 ␉ + LF 0x0A ␊ + VT 0x0B ␋ + FF 0x0C ␌ + CR 0x0D ␍ + SO 0x0E ␎ + SI 0x0F ␏ + DLE 0x10 ␐ + DC1 0x11 ␑ + DC2 0x12 ␒ + DC3 0x13 ␓ + DC4 0x14 ␔ + NAK 0x15 ␕ + SYN 0x16 ␖ + ETB 0x17 ␗ + CAN 0x18 ␘ + EM 0x19 ␙ + SUB 0x1A ␚ + ESC 0x1B ␛ + FS 0x1C ␜ + GS 0x1D ␝ + RS 0x1E ␞ + US 0x1F ␟ + / 0x2F ／ + DEL 0x7F ␡ + +The default encoding will also encode these file names as they are +problematic with many cloud storage systems. + + File name Replacement + ----------- ------------- + . ． + .. ．． + +Invalid UTF-8 bytes + +Some backends only support a sequence of well formed UTF-8 bytes as file +or directory names. + +In this case all invalid UTF-8 bytes will be replaced with a quoted +representation of the byte value to allow uploading a file to such a +backend. For example, the invalid byte 0xFE will be encoded as ‛FE. + +A common source of invalid UTF-8 bytes are local filesystems, that store +names in a different encoding than UTF-8 or UTF-16, like latin1. See the +local filenames section for details. + +Encoding option + +Most backends have an encoding options, specified as a flag +--backend-encoding where backend is the name of the backend, or as a +config parameter encoding (you’ll need to select the Advanced config in +rclone config to see it). + +This will have default value which encodes and decodes characters in +such a way as to preserve the maximum number of characters (see above). + +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as ＊ and ？ that you want to +remain as those characters on the remote rather than being translated to +* and ?. + +The --backend-encoding flags allow you to change that. You can disable +the encoding completely with --backend-encoding None or set +encoding = None in the config file. + +Encoding takes a comma separated list of encodings. You can see the list +of all available characters by passing an invalid value to this flag, eg +--local-encoding "help" and rclone help flags encoding will show you the +defaults for the backends. + + Encoding Characters + --------------- ------------------------------------------------------------- + Asterisk * + BackQuote ` + BackSlash \ + Colon : + CrLf CR 0x0D, LF 0x0A + Ctl All control characters 0x00-0x1F + Del DEL 0x7F + Dollar $ + Dot . + DoubleQuote " + Hash # + InvalidUtf8 An invalid UTF-8 character (eg latin1) + LeftCrLfHtVt CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string + LeftPeriod . on the left of a string + LeftSpace SPACE on the left of a string + LeftTilde ~ on the left of a string + LtGt <, > + None No characters are encoded + Percent % + Pipe | + Question ? + RightCrLfHtVt CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string + RightPeriod . on the right of a string + RightSpace SPACE on the right of a string + SingleQuote ' + Slash / + +To take a specific example, the FTP backend’s default encoding is + + --ftp-encoding "Slash,Del,Ctl,RightSpace,Dot" + +However, let’s say the FTP server is running on Windows and can’t have +any of the invalid Windows characters in file names. You are backing up +Linux servers to this FTP server which do have those characters in file +names. So you would add the Windows set which are + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +to the existing ones, giving: + + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot,Del,RightSpace + +This can be specified using the --ftp-encoding flag or using an encoding +parameter in the config file. + +Or let’s say you have a Windows server but you want to preserve ＊ and +？, you would then have this as the encoding (the Windows encoding minus +Asterisk and Question). + + Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot + +This can be specified using the --local-encoding flag or using an +encoding parameter in the config file. + +MIME Type + +MIME types (also known as media types) classify types of documents using +a simple text classification, eg text/html or application/pdf. + +Some cloud storage systems support reading (R) the MIME type of objects +and some support writing (W) the MIME type of objects. + +The MIME type can be important if you are serving files directly to HTTP +from the storage system. + +If you are copying from a remote which supports reading (R) to a remote +which supports writing (W) then rclone will preserve the MIME types. +Otherwise they will be guessed from the extension, or the remote itself +may assign the MIME type. + + +Optional Features + +All the remotes support a basic set of features, but there are some +optional features supported by some remotes used to make some operations +more efficient. + + Name Purge Copy Move DirMove CleanUp ListR StreamUpload LinkSharing About EmptyDir + ------------------------------ ------- ------ ------ --------- --------- ------- -------------- ------------- ------- ---------- + 1Fichier No No No No No No No No No Yes + Amazon Drive Yes No Yes Yes No #575 No No No #2178 No Yes + Amazon S3 No Yes No No No Yes Yes No #2178 No No + Backblaze B2 No Yes No No Yes Yes Yes Yes No No + Box Yes Yes Yes Yes No #575 No Yes Yes No Yes + Citrix ShareFile Yes Yes Yes Yes No No Yes No No Yes + Dropbox Yes Yes Yes Yes No #575 No Yes Yes Yes Yes + FTP No No Yes Yes No No Yes No #2178 No Yes + Google Cloud Storage Yes Yes No No No Yes Yes No #2178 No No + Google Drive Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes + Google Photos No No No No No No No No No No + HTTP No No No No No No No No #2178 No Yes + Hubic Yes † Yes No No No Yes Yes No #2178 Yes No + Jottacloud Yes Yes Yes Yes No Yes No Yes Yes Yes + Mail.ru Cloud Yes Yes Yes Yes Yes No No Yes Yes Yes + Mega Yes No Yes Yes Yes No No No #2178 Yes Yes + Memory No Yes No No No Yes Yes No No No + Microsoft Azure Blob Storage Yes Yes No No No Yes No No #2178 No No + Microsoft OneDrive Yes Yes Yes Yes No #575 No No Yes Yes Yes + OpenDrive Yes Yes Yes Yes No No No No No Yes + Openstack Swift Yes † Yes No No No Yes Yes No #2178 Yes No + pCloud Yes Yes Yes Yes Yes No No No #2178 Yes Yes + premiumize.me Yes No Yes Yes No No No Yes Yes Yes + put.io Yes No Yes Yes Yes No Yes No #2178 Yes Yes + QingStor No Yes No No No Yes No No #2178 No No + SFTP No No Yes Yes No No Yes No #2178 Yes Yes + SugarSync Yes Yes Yes Yes No No Yes Yes No Yes + WebDAV Yes Yes Yes Yes No No Yes ‡ No #2178 Yes Yes + Yandex Disk Yes Yes Yes Yes Yes No Yes Yes Yes Yes + The local filesystem Yes No Yes Yes No No Yes No Yes Yes - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | " | 0x22 | ＂ | - | $ | 0x24 | ＄ | - | ` | 0x60 | ｀ | - | ' | 0x27 | ＇ | +Purge - File names can also not start or end with the following characters. - These only get replaced if they are first or last character in the - name: +This deletes a directory quicker than just deleting all the files in the +directory. - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +† Note Swift and Hubic implement this in order to delete directory +markers but they don’t actually have a quicker way of deleting files +other than deleting them individually. - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. +‡ StreamUpload is not supported with Nextcloud - - ### Standard Options +Copy - Here are the standard options specific to fichier (1Fichier). +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. - #### --fichier-api-key +If the server doesn’t support Copy directly then for copy operations the +file is downloaded then re-uploaded. - Your API Key, get it from https://1fichier.com/console/params.pl +Move - - Config: api_key - - Env Var: RCLONE_FICHIER_API_KEY - - Type: string - - Default: "" +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. - ### Advanced Options +If the server isn’t capable of Move then rclone simulates it with Copy +then delete. If the server doesn’t support Copy then rclone will +download the file and re-upload it. + +DirMove + +This is used to implement rclone move to move a directory if possible. +If it isn’t then it will use Move on each file (which falls back to Copy +then download and upload - see Move section). + +CleanUp + +This is used for emptying the trash for a remote by rclone cleanup. + +If the server can’t do CleanUp then rclone cleanup will return an error. + +ListR + +The remote supports a recursive list to list all the contents beneath a +directory quickly. This enables the --fast-list flag to work. See the +rclone docs for more details. + +StreamUpload + +Some remotes allow files to be uploaded without knowing the file size in +advance. This allows certain operations to work without spooling the +file to local disk first, e.g. rclone rcat. + +LinkSharing + +Sets the necessary permissions on a file or folder and prints a link +that allows others to access them, even if they don’t have an account on +the particular cloud provider. + +About + +This is used to fetch quota information from the remote, like bytes +used/free/quota and bytes used in the trash. + +This is also used to return the space used, available for rclone mount. + +If the server can’t do About then rclone about will return an error. + +EmptyDir + +The remote supports empty directories. See Limitations for details. Most +Object/Bucket based remotes do not support this. + + + +GLOBAL FLAGS + + +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. + + +Non Backend Flags + +These flags are available for every command. + + --ask-password Allow prompt for password for encrypted configuration. (default true) + --auto-confirm If enabled, do not request console confirmation. + --backup-dir string Make backups into hierarchy based in DIR. + --bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + --buffer-size SizeSuffix In memory buffer size when reading files for each --transfer. (default 16M) + --bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + --ca-cert string CA certificate used to verify servers + --cache-dir string Directory rclone will use for caching. (default "$HOME/.cache/rclone") + --checkers int Number of checkers to run in parallel. (default 8) + -c, --checksum Skip based on checksum (if available) & size, not mod-time & size + --client-cert string Client SSL certificate (PEM) for mutual TLS auth + --client-key string Client SSL private key (PEM) for mutual TLS auth + --compare-dest string 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 + --delete-after When synchronizing, delete files on destination after transferring (default) + --delete-before When synchronizing, delete files on destination before transferring + --delete-during When synchronizing, delete files during transfer + --delete-excluded Delete files on dest excluded from sync + --disable string Disable a comma separated list of features. Use help to see a list. + -n, --dry-run Do a trial run with no permanent changes + --dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + --dump-bodies Dump HTTP headers and bodies - may contain sensitive info + --dump-headers Dump HTTP headers - may contain sensitive info + --exclude stringArray Exclude files matching pattern + --exclude-from stringArray Read exclude patterns from file + --exclude-if-present string Exclude directories if filename is present + --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 + -f, --filter stringArray Add a file-filtering rule + --filter-from stringArray Read filtering patterns from a file + --ignore-case Ignore case in filters (case insensitive) + --ignore-case-sync Ignore case when synchronizing + --ignore-checksum Skip post copy check of checksums. + --ignore-errors delete even if there are I/O errors + --ignore-existing Skip all files that exist on destination + --ignore-size Ignore size when skipping use mod-time or checksum. + -I, --ignore-times Don't skip files that match size and time - transfer all files + --immutable Do not modify files. Fail if existing files have been modified. + --include stringArray Include files matching pattern + --include-from stringArray Read include patterns from file + --log-file string Log everything to this file + --log-format string Comma separated list of log format options (default "date,time") + --log-level string Log level DEBUG|INFO|NOTICE|ERROR (default "NOTICE") + --low-level-retries int Number of low level retries to do. (default 10) + --max-age Duration Only transfer files younger than this in s or suffix ms|s|m|h|d|w|M|y (default off) + --max-backlog int Maximum number of objects in sync or check backlog. (default 10000) + --max-delete int When synchronizing, limit the number of deletes (default -1) + --max-depth int If set limits the recursion depth to this. (default -1) + --max-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-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-files string Path to local files to serve on the HTTP server. + --rc-htpasswd string htpasswd file - if not provided no authentication is done + --rc-job-expire-duration duration expire finished async jobs older than this value (default 1m0s) + --rc-job-expire-interval duration interval to check for expired async jobs (default 10s) + --rc-key string SSL PEM Private key + --rc-max-header-bytes int Maximum size of request header (default 4096) + --rc-no-auth Don't require auth for certain methods. + --rc-pass string Password for authentication. + --rc-realm string realm for authentication (default "rclone") + --rc-serve Enable the serving of remote objects. + --rc-server-read-timeout duration Timeout for server reading data (default 1h0m0s) + --rc-server-write-timeout duration Timeout for server writing data (default 1h0m0s) + --rc-user string User name for authentication. + --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") + --rc-web-gui Launch WebGUI on localhost + --rc-web-gui-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 + --retries int Retry operations this many times if they fail (default 3) + --retries-sleep duration Interval between retrying operations if they fail, e.g 500ms, 60s, 5m. (0 to disable) + --size-only Skip based on size only, not mod-time or checksum + --stats duration Interval between printing stats, e.g 500ms, 60s, 5m. (0 to disable) (default 1m0s) + --stats-file-name-length int Max file name length in stats. 0 for no limit (default 45) + --stats-log-level string Log level to show --stats output DEBUG|INFO|NOTICE|ERROR (default "INFO") + --stats-one-line Make the stats fit on one line. + --stats-one-line-date Enables --stats-one-line and add current date/time prefix. + --stats-one-line-date-format string Enables --stats-one-line-date and uses custom formatted date. Enclose date string in double quotes ("). See https://golang.org/pkg/time/#Time.Format + --stats-unit string Show data rate in stats as either 'bits' or 'bytes'/s (default "bytes") + --streaming-upload-cutoff SizeSuffix Cutoff for switching to chunked upload if file size is unknown. Upload starts after reaching cutoff or when file ends. (default 100k) + --suffix string Suffix to add to changed files. + --suffix-keep-extension Preserve the extension when using --suffix. + --syslog Use Syslog for logging + --syslog-facility string Facility for syslog, eg KERN,USER,... (default "DAEMON") + --timeout duration IO idle timeout (default 5m0s) + --tpslimit float Limit HTTP transactions per second to this. + --tpslimit-burst int Max burst of transactions for --tpslimit. (default 1) + --track-renames When synchronizing, track file renames and do a server side move if possible + --transfers int Number of file transfers to run in parallel. (default 4) + -u, --update Skip files that are newer on the destination. + --use-cookies Enable session cookiejar. + --use-json-log Use json log format. + --use-mmap Use mmap allocator (see docs). + --use-server-modtime Use server modified time instead of object metadata + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0") + -v, --verbose count Print lots more stuff (repeat for more) + + +Backend Flags + +These flags are available for every command. They control the backends +and may be set in the config file. + + --acd-auth-url string Auth server URL. + --acd-client-id string Amazon Application Client ID. + --acd-client-secret string Amazon Application Client Secret. + --acd-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-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-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-sas-url string SAS URL for container level access only + --azureblob-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + --azureblob-use-emulator Uses local storage emulator if provided as 'true' (leave blank if using real azure storage endpoint) + --b2-account string Account ID or Application Key ID + --b2-chunk-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + --b2-disable-checksum Disable checksums for large (> upload cutoff) files + --b2-download-auth-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + --b2-download-url string Custom endpoint for downloads. + --b2-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-test-mode string A flag string for X-Bz-Test-Mode header for debugging. + --b2-upload-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + --b2-versions Include old versions in directory listings. + --box-box-config-file string Box App config.json location + --box-box-sub-type string (default "user") + --box-client-id string Box App Client Id. + --box-client-secret string Box App Client Secret + --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + --box-upload-cutoff SizeSuffix Cutoff for switching to multipart upload (>= 50MB). (default 50M) + --cache-chunk-clean-interval Duration How often should the cache perform cleanups of the chunk storage. (default 1m0s) + --cache-chunk-no-memory Disable the in-memory cache for storing chunks during streaming. + --cache-chunk-path string Directory to cache chunk files. (default "$HOME/.cache/rclone/cache-backend") + --cache-chunk-size SizeSuffix The size of a chunk (partial file data). (default 5M) + --cache-chunk-total-size SizeSuffix The total size that the chunks can take up on the local disk. (default 10G) + --cache-db-path string Directory to store file structure metadata DB. (default "$HOME/.cache/rclone/cache-backend") + --cache-db-purge Clear all the cached data for this remote on start. + --cache-db-wait-time Duration How long to wait for the DB to be available - 0 is unlimited (default 1s) + --cache-info-age Duration How long to cache file structure information (directory listings, file size, times etc). (default 6h0m0s) + --cache-plex-insecure string Skip all certificate verifications when connecting to the Plex server + --cache-plex-password string The password of the Plex user + --cache-plex-url string The URL of the Plex server + --cache-plex-username string The username of the Plex user + --cache-read-retries int How many times to retry a read from a cache storage. (default 10) + --cache-remote string Remote to cache. + --cache-rps int Limits the number of requests per second to the source FS (-1 to disable) (default -1) + --cache-tmp-upload-path string Directory to keep temporary files until they are uploaded. + --cache-tmp-wait-time Duration How long should files be stored in local cache before being uploaded (default 15s) + --cache-workers int How many workers should run in parallel to download chunks. (default 4) + --cache-writes Cache file data on writes through the FS + --chunker-chunk-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + --chunker-fail-hard Choose how chunker should handle files with missing or invalid chunks. + --chunker-hash-type string Choose how chunker handles hash sums. All modes but "none" require metadata. (default "md5") + --chunker-meta-format string Format of the metadata object or "none". By default "simplejson". (default "simplejson") + --chunker-name-format string String format of chunk file names. (default "*.rclone_chunk.###") + --chunker-remote string Remote to chunk/unchunk. + --chunker-start-from int Minimum valid chunk number. Usually 0 or 1. (default 1) + -L, --copy-links Follow symlinks and copy the pointed to item. + --crypt-directory-name-encryption Option to either encrypt directory names or leave them intact. (default true) + --crypt-filename-encryption string How to encrypt the filenames. (default "standard") + --crypt-password string Password or pass phrase for encryption. + --crypt-password2 string Password or pass phrase for salt. Optional but recommended. + --crypt-remote string Remote to encrypt/decrypt. + --crypt-show-mapping For all files listed show how the names encrypt. + --drive-acknowledge-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + --drive-allow-import-name-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + --drive-alternate-export Use alternate export URLs for google documents export., + --drive-auth-owner-only Only consider files owned by the authenticated user. + --drive-chunk-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + --drive-client-id string Google Application Client Id + --drive-client-secret string Google Application Client Secret + --drive-disable-http2 Disable drive using http2 (default true) + --drive-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-stop-on-upload-limit Make upload limit errors be fatal + --drive-team-drive string ID of the Team Drive + --drive-trashed-only Only show files that are in the trash. + --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + --drive-use-created-date Use file created date instead of modified date., + --drive-use-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-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + --dropbox-client-id string Dropbox App Client Id + --dropbox-client-secret string Dropbox App Client Secret + --dropbox-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. + --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-host string FTP host to connect to + --ftp-no-check-certificate Do not verify the TLS certificate of the server + --ftp-pass string FTP password + --ftp-port string FTP port, leave blank to use default (21) + --ftp-tls Use FTP over TLS (Implicit) + --ftp-user string FTP username, leave blank for current username, $USER + --gcs-bucket-acl string Access Control List for new buckets. + --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. + --gcs-client-id string Google Application Client Id + --gcs-client-secret string Google Application Client Secret + --gcs-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. + --gphotos-client-id string Google Application Client Id + --gphotos-client-secret string Google Application Client Secret + --gphotos-read-only Set to make the Google Photos backend read only. + --gphotos-read-size Set to read the size of media items. + --http-headers CommaSepList Set HTTP headers for all transactions + --http-no-head Don't use HEAD requests to find file sizes in dir listing + --http-no-slash Set this if the site doesn't end directories with / + --http-url string URL of http host to connect to + --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + --hubic-client-id string Hubic Client Id + --hubic-client-secret string Hubic Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + --hubic-no-chunk Don't chunk files during streaming upload. + --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-unlink Remove existing public link to file/folder with link command rather than creating. + --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --koofr-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) + --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-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 + --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. + --mega-user string User name + -x, --one-file-system Don't cross filesystem boundaries (unix/macOS only). + --onedrive-chunk-size SizeSuffix Chunk size to upload files with - must be multiple of 320k (327,680 bytes). (default 10M) + --onedrive-client-id string Microsoft App Client Id + --onedrive-client-secret string Microsoft App Client Secret + --onedrive-drive-id string The ID of the drive to use + --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-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. + --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. + --opendrive-username string Username + --pcloud-client-id string Pcloud App Client Id + --pcloud-client-secret string Pcloud App Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --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 a endpoint URL to connection QingStor API. + --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + --qingstor-secret-access-key string QingStor Secret Access Key (password) + --qingstor-upload-concurrency int Concurrency for multipart uploads. (default 1) + --qingstor-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --qingstor-zone string Zone to connect to. + --s3-access-key-id string AWS Access Key ID. + --s3-acl string Canned ACL used when creating buckets and storing or copying objects. + --s3-bucket-acl string Canned ACL used when creating buckets. + --s3-chunk-size SizeSuffix Chunk size to use for uploading. (default 5M) + --s3-copy-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G) + --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-provider string Choose your S3 provider. + --s3-region string Region to connect to. + --s3-secret-access-key string AWS Secret Access Key (password) + --s3-server-side-encryption string The server-side encryption algorithm used when storing this object in S3. + --s3-session-token string An AWS session token + --s3-sse-kms-key-id string If using KMS ID you must provide the ARN of Key. + --s3-storage-class string The storage class to use when storing new objects in S3. + --s3-upload-concurrency int Concurrency for multipart uploads. (default 4) + --s3-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + --s3-use-accelerate-endpoint If true use the AWS S3 accelerated endpoint. + --s3-v2-auth If true use v2 authentication. + --sftp-ask-password Allow asking for SFTP password when needed. + --sftp-disable-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + --sftp-host string SSH host to connect to + --sftp-key-file string Path to PEM-encoded private key file, leave blank or set key-use-agent to use ssh-agent. + --sftp-key-file-pass string The passphrase to decrypt the PEM-encoded private key file. + --sftp-key-use-agent When set forces the usage of the ssh-agent. + --sftp-md5sum-command string The command used to read md5 hashes. Leave blank for autodetect. + --sftp-pass string SSH password, leave blank to use ssh-agent. + --sftp-path-override string Override path used by SSH connection. + --sftp-port string SSH port, leave blank to use default (22) + --sftp-set-modtime Set the modified time on the remote if set. (default true) + --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. + --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). + --union-remotes string List of space separated remotes. + --webdav-bearer-token string Bearer token instead of user/pass (eg a Macaroon) + --webdav-bearer-token-command string Command to run to get a bearer token + --webdav-pass string Password. + --webdav-url string URL of http host to connect to + --webdav-user string User name + --webdav-vendor string Name of the Webdav site/service/software you are using + --yandex-client-id string Yandex Client Id + --yandex-client-secret string Yandex Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + --yandex-unlink Remove existing public link to file/folder with link command rather than creating. + + +1Fichier + +This is a backend for the 1ficher cloud storage service. Note that a +Premium subscription is required to use the API. + +Paths are specified as remote:path + +Paths may be as deep as required, eg remote:directory/subdirectory. + +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: - Here are the advanced options specific to fichier (1Fichier). - - #### --fichier-shared-folder - - If you want to download a shared folder, add this parameter - - - Config: shared_folder - - Env Var: RCLONE_FICHIER_SHARED_FOLDER - - Type: string - - Default: "" - - - - Alias - ----------------------------------------- - - The `alias` remote provides a new name for another remote. - - Paths may be as deep as required or a local path, - eg `remote:directory/subdirectory` or `/directory/subdirectory`. - - During the initial setup with `rclone config` you will specify the target - remote. The target remote can either be a local path or another remote. - - Subfolders can be used in target remote. Assume a alias remote named `backup` - with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` - is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. - - There will be no special handling of paths containing `..` segments. - Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking - `rclone mkdir mydrive:private/backup/../desktop`. - The empty path is not allowed as a remote. To alias the current directory - use `.` instead. - - Here is an example of how to make a alias called `remote` for local folder. - First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Alias for an existing remote  “alias” [snip] Storage> alias 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 - - 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 a third party ouath proxy - in which case you will need to enter `client_id`, `client_secret`, - `auth_url` and `token_url`. - - Note also if you are not using Amazon's `auth_url` and `token_url`, - (ie you filled in something for those) then if setting up on a remote - machine you can only use the [copying the config method of - configuration](https://rclone.org/remote_setup/#configuring-by-copying-the-config-file) - - `rclone authorize` will not work. - - Here is an example of how to make a remote called `remote`. First run: - - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Choose a number from below, or type -in your own value [snip] XX / Amazon Drive  “amazon cloud drive” [snip] -Storage> amazon cloud drive Amazon Application Client Id - required. -client_id> your client ID goes here Amazon Application Client Secret - -required. client_secret> your client secret goes here Auth server URL - -leave blank to use Amazon’s. auth_url> Optional auth URL Token server -url - leave blank to use Amazon’s. token_url> Optional token URL Remote -config Make sure your Redirect URL is set to “http://127.0.0.1:53682/” -in your custom config. Use auto config? * Say Y if not sure * Say N if -you are working on a remote or headless machine y) Yes n) No y/n> y If -your browser doesn’t open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code… Got code ——————– [remote] client_id = your client ID -goes here client_secret = your client secret goes here auth_url = -Optional auth URL token_url = Optional token URL token = -{“access_token”:“xxxxxxxxxxxxxxxxxxxxxxx”,“token_type”:“bearer”,“refresh_token”:“xxxxxxxxxxxxxxxxxx”,“expiry”:“2015-09-06T16:07:39.658438471+01:00”} -——————– y) Yes this is OK e) Edit this remote d) Delete this remote -y/e/d> y - - - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. - - Note that rclone runs a webserver on your local machine to collect the - token as returned from Amazon. This only runs from the moment it - opens your browser to the moment you get back the verification - code. This is on `http://127.0.0.1:53682/` and this it may require - you to unblock it temporarily if you are running a host firewall. - - Once configured you can then use `rclone` like this, - - List directories in top level of your Amazon Drive - - rclone lsd remote: - - List all the files in your Amazon Drive - - rclone ls remote: - - To copy a local directory to an Amazon Drive directory called backup - - rclone copy /home/source remote:backup - - ### Modified time and MD5SUMs ### - - Amazon Drive doesn't allow modification times to be changed via - the API so these won't be accurate or used for syncing. - - It does store MD5SUMs so for a more accurate sync, you can use the - `--checksum` flag. - - #### Restricted filename characters - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. - - ### Deleting files ### - - Any files you delete with rclone will end up in the trash. Amazon - don't provide an API to permanently delete files, nor to empty the - trash, so you will have to do that with one of Amazon's apps or via - the Amazon Drive website. As of November 17, 2016, files are - automatically deleted by Amazon from the trash after 30 days. - - ### Using with non `.com` Amazon accounts ### - - Let's say you usually use `amazon.co.uk`. When you authenticate with - rclone it will take you to an `amazon.com` page to log in. Your - `amazon.co.uk` email and password should work here just fine. - - - ### Standard Options - - Here are the standard options specific to amazon cloud drive (Amazon Drive). - - #### --acd-client-id - - Amazon Application Client ID. - - - Config: client_id - - Env Var: RCLONE_ACD_CLIENT_ID - - Type: string - - Default: "" - - #### --acd-client-secret - - Amazon Application Client Secret. - - - Config: client_secret - - Env Var: RCLONE_ACD_CLIENT_SECRET - - Type: string - - Default: "" - - ### Advanced Options - - Here are the advanced options specific to amazon cloud drive (Amazon Drive). - - #### --acd-auth-url - - Auth server URL. - Leave blank to use Amazon's. - - - Config: auth_url - - Env Var: RCLONE_ACD_AUTH_URL - - Type: string - - Default: "" - - #### --acd-token-url - - Token server url. - leave blank to use Amazon's. - - - Config: token_url - - Env Var: RCLONE_ACD_TOKEN_URL - - Type: string - - Default: "" - - #### --acd-checkpoint - - Checkpoint for internal polling (debug). - - - Config: checkpoint - - Env Var: RCLONE_ACD_CHECKPOINT - - Type: string - - Default: "" - - #### --acd-upload-wait-per-gb - - Additional time per GB to wait after a failed complete upload to see if it appears. - - Sometimes Amazon Drive gives an error when a file has been fully - uploaded but the file appears anyway after a little while. This - happens sometimes for files over 1GB in size and nearly every time for - files bigger than 10GB. This parameter controls the time rclone waits - for the file to appear. - - The default value for this parameter is 3 minutes per GB, so by - default it will wait 3 minutes for every GB uploaded to see if the - file appears. - - You can disable this feature by setting it to 0. This may cause - conflict errors as rclone retries the failed upload but the file will - most likely appear correctly eventually. - - These values were determined empirically by observing lots of uploads - of big files for a range of file sizes. - - Upload with the "-v" flag to see more info about what rclone is doing - in this situation. - - - Config: upload_wait_per_gb - - Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB - - Type: Duration - - Default: 3m0s - - #### --acd-templink-threshold - - Files >= this size will be downloaded via their tempLink. - - Files this size or more will be downloaded via their "tempLink". This - is to work around a problem with Amazon Drive which blocks downloads - of files bigger than about 10GB. The default for this is 9GB which - shouldn't need to be changed. - - To download files above this threshold, rclone requests a "tempLink" - which downloads the file through a temporary URL directly from the - underlying S3 storage. - - - Config: templink_threshold - - Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD - - Type: SizeSuffix - - Default: 9G - - - - ### Limitations ### - - Note that Amazon Drive is case insensitive so you can't have a - file called "Hello.doc" and one called "hello.doc". - - Amazon Drive has rate limiting so you may notice errors in the - sync (429 errors). rclone will automatically retry the sync up to 3 - times by default (see `--retries` flag) which should hopefully work - around this problem. - - Amazon Drive has an internal limit of file sizes that can be uploaded - to the service. This limit is not officially published, but all files - larger than this will fail. - - At the time of writing (Jan 2016) is in the area of 50GB per file. - This means that larger files are likely to fail. - - Unfortunately there is no way for rclone to see that this failure is - because of file size, so it will retry the operation, as any other - failure. To avoid this problem, use `--max-size 50000M` option to limit - the maximum size of uploaded files. Note that `--max-size` does not split - files into segments, it only ignores files over this size. - - Amazon S3 Storage Providers - -------------------------------------------------------- - - The S3 backend can be used with a number of different providers: - - * AWS S3 - * Alibaba Cloud (Aliyun) Object Storage System (OSS) - * Ceph - * DigitalOcean Spaces - * Dreamhost - * IBM COS S3 - * Minio - * Wasabi - - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. - - Once you have made a remote (see the provider specific section above) - you can use it like this: - - See all buckets - - rclone lsd remote: - - Make a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. - - rclone sync /home/local/directory remote:bucket - - ## AWS S3 {#amazon-s3} - - Here is an example of making an s3 configuration. First run - - rclone config - - This will guide you through an interactive setup process. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM -COS, Minio)  “s3” [snip] Storage> s3 Choose your S3 provider. Choose a -number from below, or type in your own value 1 / Amazon Web Services -(AWS) S3  “AWS” 2 / Ceph Object Storage  “Ceph” 3 / Digital Ocean Spaces - “DigitalOcean” 4 / Dreamhost DreamObjects  “Dreamhost” 5 / IBM COS S3 - “IBMCOS” 6 / Minio Object Storage  “Minio” 7 / Wasabi Object Storage - “Wasabi” 8 / Any other S3 compatible provider  “Other” provider> 1 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). Only applies if access_key_id and secret_access_key is -blank. Choose a number from below, or type in your own value 1 / Enter -AWS credentials in the next step  “false” 2 / Get AWS credentials from -the environment (env vars or IAM)  “true” env_auth> 1 AWS Access Key ID -- leave blank for anonymous access or runtime credentials. -access_key_id> XXX AWS Secret Access Key (password) - leave blank for -anonymous access or runtime credentials. secret_access_key> YYY Region -to connect to. Choose a number from below, or type in your own value / -The default endpoint - a good choice if you are unsure. 1 | US Region, -Northern Virginia or Pacific Northwest. | Leave location constraint -empty.  “us-east-1” / US East (Ohio) Region 2 | Needs location -constraint us-east-2.  “us-east-2” / US West (Oregon) Region 3 | Needs -location constraint us-west-2.  “us-west-2” / US West (Northern -California) Region 4 | Needs location constraint us-west-1.  “us-west-1” -/ Canada (Central) Region 5 | Needs location constraint ca-central-1. - “ca-central-1” / EU (Ireland) Region 6 | Needs location constraint EU -or eu-west-1.  “eu-west-1” / EU (London) Region 7 | Needs location -constraint eu-west-2.  “eu-west-2” / EU (Frankfurt) Region 8 | Needs -location constraint eu-central-1.  “eu-central-1” / Asia Pacific -(Singapore) Region 9 | Needs location constraint ap-southeast-1. - “ap-southeast-1” / Asia Pacific (Sydney) Region 10 | Needs location -constraint ap-southeast-2.  “ap-southeast-2” / Asia Pacific (Tokyo) -Region 11 | Needs location constraint ap-northeast-1.  “ap-northeast-1” -/ Asia Pacific (Seoul) 12 | Needs location constraint ap-northeast-2. - “ap-northeast-2” / Asia Pacific (Mumbai) 13 | Needs location constraint -ap-south-1.  “ap-south-1” / South America (Sao Paulo) Region 14 | Needs -location constraint sa-east-1.  “sa-east-1” region> 1 Endpoint for S3 -API. Leave blank if using AWS to use the default endpoint for the -region. endpoint> Location constraint - must be set to match the Region. -Used when creating buckets only. Choose a number from below, or type in -your own value 1 / Empty for US Region, Northern Virginia or Pacific -Northwest.  "" 2 / US East (Ohio) Region.  “us-east-2” 3 / US West -(Oregon) Region.  “us-west-2” 4 / US West (Northern California) Region. - “us-west-1” 5 / Canada (Central) Region.  “ca-central-1” 6 / EU -(Ireland) Region.  “eu-west-1” 7 / EU (London) Region.  “eu-west-2” 8 / -EU Region.  “EU” 9 / Asia Pacific (Singapore) Region.  “ap-southeast-1” -10 / Asia Pacific (Sydney) Region.  “ap-southeast-2” 11 / Asia Pacific -(Tokyo) Region.  “ap-northeast-1” 12 / Asia Pacific (Seoul) - “ap-northeast-2” 13 / Asia Pacific (Mumbai)  “ap-south-1” 14 / South -America (Sao Paulo) Region.  “sa-east-1” location_constraint> 1 Canned -ACL used when creating buckets and/or storing objects in S3. For more -info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. No one else has access rights (default).  “private” 2 / -Owner gets FULL_CONTROL. The AllUsers group gets READ access. - “public-read” / Owner gets FULL_CONTROL. The AllUsers group gets READ -and WRITE access. 3 | Granting this on a bucket is generally not -recommended.  “public-read-write” 4 / Owner gets FULL_CONTROL. The -AuthenticatedUsers group gets READ access.  “authenticated-read” / -Object owner gets FULL_CONTROL. Bucket owner gets READ access. 5 | If -you specify this canned ACL when creating a bucket, Amazon S3 ignores -it.  “bucket-owner-read” / Both the object owner and the bucket owner -get FULL_CONTROL over the object. 6 | If you specify this canned ACL -when creating a bucket, Amazon S3 ignores it. - “bucket-owner-full-control” acl> 1 The server-side encryption algorithm -used when storing this object in S3. Choose a number from below, or type -in your own value 1 / None  "" 2 / AES256  “AES256” -server_side_encryption> 1 The storage class to use when storing objects -in S3. Choose a number from below, or type in your own value 1 / Default - "" 2 / Standard storage class  “STANDARD” 3 / Reduced redundancy -storage class  “REDUCED_REDUNDANCY” 4 / Standard Infrequent Access -storage class  “STANDARD_IA” 5 / One Zone Infrequent Access storage -class  “ONEZONE_IA” 6 / Glacier storage class  “GLACIER” 7 / Glacier -Deep Archive storage class  “DEEP_ARCHIVE” 8 / Intelligent-Tiering -storage class  “INTELLIGENT_TIERING” storage_class> 1 Remote config -——————– [remote] type = s3 provider = AWS env_auth = false access_key_id -= XXX secret_access_key = YYY region = us-east-1 endpoint = -location_constraint = acl = private server_side_encryption = -storage_class = ——————– y) Yes this is OK e) Edit this remote d) Delete -this remote y/e/d> - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](/docs/#fast-list) for more details. - - ### --update and --use-server-modtime ### - - As noted below, the modified time is stored on metadata on the object. It is - used by default for all operations that require checking the time a file was - last updated. It allows rclone to treat the remote more like a true filesystem, - but it is inefficient because it requires an extra API call to retrieve the - metadata. - - For many operations, the time the object was last uploaded to the remote is - sufficient to determine if it is "dirty". By using `--update` along with - `--use-server-modtime`, you can avoid the extra API call and simply upload - files whose local modtime is newer than the time it was last uploaded. - - ### Modified time ### - - The modified time is stored as metadata on the object as - `X-Amz-Meta-Mtime` as floating point since the epoch accurate to 1 ns. - - If the modification time needs to be updated rclone will attempt to perform a server - side copy to update the modification if the object can be copied in a single part. - In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive - storage the object will be uploaded rather than copied. - - #### Restricted filename characters - - S3 allows any valid UTF-8 string as a key. - - Invalid UTF-8 bytes will be [replaced](/overview/#invalid-utf8), as - they can't be used in XML. - - The following characters are replaced since these are problematic when - dealing with the REST API: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - - The encoding will also encode these file names as they don't seem to - work with the SDK properly: - - | File name | Replacement | - | --------- |:-----------:| - | . | ． | - | .. | ．． | - - ### Multipart uploads ### - - rclone supports multipart uploads with S3 which means that it can - upload files bigger than 5GB. - - Note that files uploaded *both* with multipart upload *and* through - crypt remotes do not have MD5 sums. - - rclone switches from single part uploads to multipart uploads at the - point specified by `--s3-upload-cutoff`. This can be a maximum of 5GB - and a minimum of 0 (ie always upload multipart files). - - The chunk sizes used in the multipart upload are specified by - `--s3-chunk-size` and the number of chunks uploaded concurrently is - specified by `--s3-upload-concurrency`. - - Multipart uploads will use `--transfers` * `--s3-upload-concurrency` * - `--s3-chunk-size` extra memory. Single part uploads to not use extra - memory. - - Single part transfers can be faster than multipart transfers or slower - depending on your latency from S3 - the more latency, the more likely - single part transfers will be faster. - - Increasing `--s3-upload-concurrency` will increase throughput (8 would - be a sensible value) and increasing `--s3-chunk-size` also increases - throughput (16M would be sensible). Increasing either of these will - use more memory. The default values are high enough to gain most of - the possible performance without using too much memory. - - - ### Buckets and Regions ### - - With Amazon S3 you can list buckets (`rclone lsd`) using any region, - but you can only access the content of a bucket from the region it was - created in. If you attempt to access a bucket from the wrong region, - you will get an error, `incorrect region, the bucket is not in 'XXX' - region`. - - ### Authentication ### - - There are a number of ways to supply `rclone` with a set of AWS - credentials, with and without using the environment. - - The different authentication methods are tried in this order: - - - Directly in the rclone configuration file (`env_auth = false` in the config file): - - `access_key_id` and `secret_access_key` are required. - - `session_token` can be optionally set when using AWS STS. - - Runtime configuration (`env_auth = true` in the config file): - - Export the following environment variables before running `rclone`: - - Access Key ID: `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` - - Secret Access Key: `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` - - Session Token: `AWS_SESSION_TOKEN` (optional) - - Or, use a [named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): - - Profile files are standard files used by AWS CLI tools - - By default it will use the profile in your home directory (eg `~/.aws/credentials` on unix based systems) file and the "default" profile, to change set these environment variables: - - `AWS_SHARED_CREDENTIALS_FILE` to control which file. - - `AWS_PROFILE` to control which profile to use. - - Or, run `rclone` in an ECS task with an IAM role (AWS only). - - Or, run `rclone` on an EC2 instance with an IAM role (AWS only). - - If none of these option actually end up providing `rclone` with AWS - credentials then S3 interaction will be non-authenticated (see below). - - ### S3 Permissions ### - - When using the `sync` subcommand of `rclone` the following minimum - permissions are required to be available on the bucket being written to: - - * `ListBucket` - * `DeleteObject` - * `GetObject` - * `PutObject` - * `PutObjectACL` - - When using the `lsd` subcommand, the `ListAllMyBuckets` permission is required. - - Example policy: - -{ “Version”: “2012-10-17”, “Statement”: [ { “Effect”: “Allow”, -“Principal”: { “AWS”: “arn:aws:iam::USER_SID:user/USER_NAME” }, -“Action”: [ “s3:ListBucket”, “s3:DeleteObject”, “s3:GetObject”, -“s3:PutObject”, “s3:PutObjectAcl” ], “Resource”: [ -"arn:aws:s3:::BUCKET_NAME/*“,”arn:aws:s3:::BUCKET_NAME" ] }, { “Effect”: -“Allow”, “Action”: “s3:ListAllMyBuckets”, “Resource”: "arn:aws:s3:::*" } -] } - - - Notes on above: - - 1. This is a policy that can be used when creating bucket. It assumes - that `USER_NAME` has been created. - 2. The Resource entry must include both resource ARNs, as one implies - the bucket and the other implies the bucket's objects. - - For reference, [here's an Ansible script](https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) - that will generate one or more buckets that will work with `rclone sync`. - - ### Key Management System (KMS) ### - - If you are using server side encryption with KMS then you will find - you can't transfer small objects. As a work-around you can use the - `--ignore-checksum` flag. - - A proper fix is being worked on in [issue #1824](https://github.com/rclone/rclone/issues/1824). - - ### Glacier and Glacier Deep Archive ### - - You can upload objects using the glacier storage class or transition them to glacier using a [lifecycle policy](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). - The bucket can still be synced or copied into normally, but if rclone - tries to access data from the glacier storage class you will see an error like below. - - 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file - - In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) - the object(s) in question before using rclone. - - Note that rclone only speaks the S3 API it does not speak the Glacier - Vault API, so rclone cannot directly access Glacier Vaults. - - - ### Standard Options - - Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-provider - - Choose your S3 provider. - - - Config: provider - - Env Var: RCLONE_S3_PROVIDER - - Type: string - - Default: "" - - Examples: - - "AWS" - - Amazon Web Services (AWS) S3 - - "Alibaba" - - Alibaba Cloud Object Storage System (OSS) formerly Aliyun - - "Ceph" - - Ceph Object Storage - - "DigitalOcean" - - Digital Ocean Spaces - - "Dreamhost" - - Dreamhost DreamObjects - - "IBMCOS" - - IBM COS S3 - - "Minio" - - Minio Object Storage - - "Netease" - - Netease Object Storage (NOS) - - "Wasabi" - - Wasabi Object Storage - - "Other" - - Any other S3 compatible provider - - #### --s3-env-auth - - Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). - Only applies if access_key_id and secret_access_key is blank. - - - Config: env_auth - - Env Var: RCLONE_S3_ENV_AUTH - - Type: bool - - Default: false - - Examples: - - "false" - - Enter AWS credentials in the next step - - "true" - - Get AWS credentials from the environment (env vars or IAM) - - #### --s3-access-key-id - - AWS Access Key ID. - Leave blank for anonymous access or runtime credentials. - - - Config: access_key_id - - Env Var: RCLONE_S3_ACCESS_KEY_ID - - Type: string - - Default: "" - - #### --s3-secret-access-key - - AWS Secret Access Key (password) - Leave blank for anonymous access or runtime credentials. - - - Config: secret_access_key - - Env Var: RCLONE_S3_SECRET_ACCESS_KEY - - Type: string - - Default: "" - - #### --s3-region - - Region to connect to. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "us-east-1" - - The default endpoint - a good choice if you are unsure. - - US Region, Northern Virginia or Pacific Northwest. - - Leave location constraint empty. - - "us-east-2" - - US East (Ohio) Region - - Needs location constraint us-east-2. - - "us-west-2" - - US West (Oregon) Region - - Needs location constraint us-west-2. - - "us-west-1" - - US West (Northern California) Region - - Needs location constraint us-west-1. - - "ca-central-1" - - Canada (Central) Region - - Needs location constraint ca-central-1. - - "eu-west-1" - - EU (Ireland) Region - - Needs location constraint EU or eu-west-1. - - "eu-west-2" - - EU (London) Region - - Needs location constraint eu-west-2. - - "eu-north-1" - - EU (Stockholm) Region - - Needs location constraint eu-north-1. - - "eu-central-1" - - EU (Frankfurt) Region - - Needs location constraint eu-central-1. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region - - Needs location constraint ap-southeast-1. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region - - Needs location constraint ap-southeast-2. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region - - Needs location constraint ap-northeast-1. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - Needs location constraint ap-northeast-2. - - "ap-south-1" - - Asia Pacific (Mumbai) - - Needs location constraint ap-south-1. - - "sa-east-1" - - South America (Sao Paulo) Region - - Needs location constraint sa-east-1. - - #### --s3-region - - Region to connect to. - Leave blank if you are using an S3 clone and you don't have a region. - - - Config: region - - Env Var: RCLONE_S3_REGION - - Type: string - - Default: "" - - Examples: - - "" - - Use this if unsure. Will use v4 signatures and an empty region. - - "other-v2-signature" - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - #### --s3-endpoint - - Endpoint for S3 API. - Leave blank if using AWS to use the default endpoint for the region. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - #### --s3-endpoint - - Endpoint for IBM COS S3 API. - Specify if using an IBM COS On Premise. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "s3-api.us-geo.objectstorage.softlayer.net" - - US Cross Region Endpoint - - "s3-api.dal.us-geo.objectstorage.softlayer.net" - - US Cross Region Dallas Endpoint - - "s3-api.wdc-us-geo.objectstorage.softlayer.net" - - US Cross Region Washington DC Endpoint - - "s3-api.sjc-us-geo.objectstorage.softlayer.net" - - US Cross Region San Jose Endpoint - - "s3-api.us-geo.objectstorage.service.networklayer.com" - - US Cross Region Private Endpoint - - "s3-api.dal-us-geo.objectstorage.service.networklayer.com" - - US Cross Region Dallas Private Endpoint - - "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" - - US Cross Region Washington DC Private Endpoint - - "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" - - US Cross Region San Jose Private Endpoint - - "s3.us-east.objectstorage.softlayer.net" - - US Region East Endpoint - - "s3.us-east.objectstorage.service.networklayer.com" - - US Region East Private Endpoint - - "s3.us-south.objectstorage.softlayer.net" - - US Region South Endpoint - - "s3.us-south.objectstorage.service.networklayer.com" - - US Region South Private Endpoint - - "s3.eu-geo.objectstorage.softlayer.net" - - EU Cross Region Endpoint - - "s3.fra-eu-geo.objectstorage.softlayer.net" - - EU Cross Region Frankfurt Endpoint - - "s3.mil-eu-geo.objectstorage.softlayer.net" - - EU Cross Region Milan Endpoint - - "s3.ams-eu-geo.objectstorage.softlayer.net" - - EU Cross Region Amsterdam Endpoint - - "s3.eu-geo.objectstorage.service.networklayer.com" - - EU Cross Region Private Endpoint - - "s3.fra-eu-geo.objectstorage.service.networklayer.com" - - EU Cross Region Frankfurt Private Endpoint - - "s3.mil-eu-geo.objectstorage.service.networklayer.com" - - EU Cross Region Milan Private Endpoint - - "s3.ams-eu-geo.objectstorage.service.networklayer.com" - - EU Cross Region Amsterdam Private Endpoint - - "s3.eu-gb.objectstorage.softlayer.net" - - Great Britain Endpoint - - "s3.eu-gb.objectstorage.service.networklayer.com" - - Great Britain Private Endpoint - - "s3.ap-geo.objectstorage.softlayer.net" - - APAC Cross Regional Endpoint - - "s3.tok-ap-geo.objectstorage.softlayer.net" - - APAC Cross Regional Tokyo Endpoint - - "s3.hkg-ap-geo.objectstorage.softlayer.net" - - APAC Cross Regional HongKong Endpoint - - "s3.seo-ap-geo.objectstorage.softlayer.net" - - APAC Cross Regional Seoul Endpoint - - "s3.ap-geo.objectstorage.service.networklayer.com" - - APAC Cross Regional Private Endpoint - - "s3.tok-ap-geo.objectstorage.service.networklayer.com" - - APAC Cross Regional Tokyo Private Endpoint - - "s3.hkg-ap-geo.objectstorage.service.networklayer.com" - - APAC Cross Regional HongKong Private Endpoint - - "s3.seo-ap-geo.objectstorage.service.networklayer.com" - - APAC Cross Regional Seoul Private Endpoint - - "s3.mel01.objectstorage.softlayer.net" - - Melbourne Single Site Endpoint - - "s3.mel01.objectstorage.service.networklayer.com" - - Melbourne Single Site Private Endpoint - - "s3.tor01.objectstorage.softlayer.net" - - Toronto Single Site Endpoint - - "s3.tor01.objectstorage.service.networklayer.com" - - Toronto Single Site Private Endpoint - - #### --s3-endpoint - - Endpoint for OSS API. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "oss-cn-hangzhou.aliyuncs.com" - - East China 1 (Hangzhou) - - "oss-cn-shanghai.aliyuncs.com" - - East China 2 (Shanghai) - - "oss-cn-qingdao.aliyuncs.com" - - North China 1 (Qingdao) - - "oss-cn-beijing.aliyuncs.com" - - North China 2 (Beijing) - - "oss-cn-zhangjiakou.aliyuncs.com" - - North China 3 (Zhangjiakou) - - "oss-cn-huhehaote.aliyuncs.com" - - North China 5 (Huhehaote) - - "oss-cn-shenzhen.aliyuncs.com" - - South China 1 (Shenzhen) - - "oss-cn-hongkong.aliyuncs.com" - - Hong Kong (Hong Kong) - - "oss-us-west-1.aliyuncs.com" - - US West 1 (Silicon Valley) - - "oss-us-east-1.aliyuncs.com" - - US East 1 (Virginia) - - "oss-ap-southeast-1.aliyuncs.com" - - Southeast Asia Southeast 1 (Singapore) - - "oss-ap-southeast-2.aliyuncs.com" - - Asia Pacific Southeast 2 (Sydney) - - "oss-ap-southeast-3.aliyuncs.com" - - Southeast Asia Southeast 3 (Kuala Lumpur) - - "oss-ap-southeast-5.aliyuncs.com" - - Asia Pacific Southeast 5 (Jakarta) - - "oss-ap-northeast-1.aliyuncs.com" - - Asia Pacific Northeast 1 (Japan) - - "oss-ap-south-1.aliyuncs.com" - - Asia Pacific South 1 (Mumbai) - - "oss-eu-central-1.aliyuncs.com" - - Central Europe 1 (Frankfurt) - - "oss-eu-west-1.aliyuncs.com" - - West Europe (London) - - "oss-me-east-1.aliyuncs.com" - - Middle East 1 (Dubai) - - #### --s3-endpoint - - Endpoint for S3 API. - Required when using an S3 clone. - - - Config: endpoint - - Env Var: RCLONE_S3_ENDPOINT - - Type: string - - Default: "" - - Examples: - - "objects-us-east-1.dream.io" - - Dream Objects endpoint - - "nyc3.digitaloceanspaces.com" - - Digital Ocean Spaces New York 3 - - "ams3.digitaloceanspaces.com" - - Digital Ocean Spaces Amsterdam 3 - - "sgp1.digitaloceanspaces.com" - - Digital Ocean Spaces Singapore 1 - - "s3.wasabisys.com" - - Wasabi US East endpoint - - "s3.us-west-1.wasabisys.com" - - Wasabi US West endpoint - - "s3.eu-central-1.wasabisys.com" - - Wasabi EU Central endpoint - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "" - - Empty for US Region, Northern Virginia or Pacific Northwest. - - "us-east-2" - - US East (Ohio) Region. - - "us-west-2" - - US West (Oregon) Region. - - "us-west-1" - - US West (Northern California) Region. - - "ca-central-1" - - Canada (Central) Region. - - "eu-west-1" - - EU (Ireland) Region. - - "eu-west-2" - - EU (London) Region. - - "eu-north-1" - - EU (Stockholm) Region. - - "EU" - - EU Region. - - "ap-southeast-1" - - Asia Pacific (Singapore) Region. - - "ap-southeast-2" - - Asia Pacific (Sydney) Region. - - "ap-northeast-1" - - Asia Pacific (Tokyo) Region. - - "ap-northeast-2" - - Asia Pacific (Seoul) - - "ap-south-1" - - Asia Pacific (Mumbai) - - "sa-east-1" - - South America (Sao Paulo) Region. - - #### --s3-location-constraint - - Location constraint - must match endpoint when using IBM Cloud Public. - For on-prem COS, do not make a selection from this list, hit enter - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - Examples: - - "us-standard" - - US Cross Region Standard - - "us-vault" - - US Cross Region Vault - - "us-cold" - - US Cross Region Cold - - "us-flex" - - US Cross Region Flex - - "us-east-standard" - - US East Region Standard - - "us-east-vault" - - US East Region Vault - - "us-east-cold" - - US East Region Cold - - "us-east-flex" - - US East Region Flex - - "us-south-standard" - - US South Region Standard - - "us-south-vault" - - US South Region Vault - - "us-south-cold" - - US South Region Cold - - "us-south-flex" - - US South Region Flex - - "eu-standard" - - EU Cross Region Standard - - "eu-vault" - - EU Cross Region Vault - - "eu-cold" - - EU Cross Region Cold - - "eu-flex" - - EU Cross Region Flex - - "eu-gb-standard" - - Great Britain Standard - - "eu-gb-vault" - - Great Britain Vault - - "eu-gb-cold" - - Great Britain Cold - - "eu-gb-flex" - - Great Britain Flex - - "ap-standard" - - APAC Standard - - "ap-vault" - - APAC Vault - - "ap-cold" - - APAC Cold - - "ap-flex" - - APAC Flex - - "mel01-standard" - - Melbourne Standard - - "mel01-vault" - - Melbourne Vault - - "mel01-cold" - - Melbourne Cold - - "mel01-flex" - - Melbourne Flex - - "tor01-standard" - - Toronto Standard - - "tor01-vault" - - Toronto Vault - - "tor01-cold" - - Toronto Cold - - "tor01-flex" - - Toronto Flex - - #### --s3-location-constraint - - Location constraint - must be set to match the Region. - Leave blank if not sure. Used when creating buckets only. - - - Config: location_constraint - - Env Var: RCLONE_S3_LOCATION_CONSTRAINT - - Type: string - - Default: "" - - #### --s3-acl - - Canned ACL used when creating buckets and storing or copying objects. - - This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too. - - For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl - - Note that this ACL is applied when server side copying objects as S3 - doesn't copy the ACL from the source but rather writes a fresh one. - - - Config: acl - - Env Var: RCLONE_S3_ACL - - Type: string - - Default: "" - - Examples: - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - - Granting this on a bucket is generally not recommended. - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - - "bucket-owner-read" - - Object owner gets FULL_CONTROL. Bucket owner gets READ access. - - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - - "bucket-owner-full-control" - - Both the object owner and the bucket owner get FULL_CONTROL over the object. - - If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS - - #### --s3-server-side-encryption - - The server-side encryption algorithm used when storing this object in S3. - - - Config: server_side_encryption - - Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION - - Type: string - - Default: "" - - Examples: - - "" - - None - - "AES256" - - AES256 - - "aws:kms" - - aws:kms - - #### --s3-sse-kms-key-id - - If using KMS ID you must provide the ARN of Key. - - - Config: sse_kms_key_id - - Env Var: RCLONE_S3_SSE_KMS_KEY_ID - - Type: string - - Default: "" - - Examples: - - "" - - None - - "arn:aws:kms:us-east-1:*" - - arn:aws:kms:* - - #### --s3-storage-class - - The storage class to use when storing new objects in S3. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "REDUCED_REDUNDANCY" - - Reduced redundancy storage class - - "STANDARD_IA" - - Standard Infrequent Access storage class - - "ONEZONE_IA" - - One Zone Infrequent Access storage class - - "GLACIER" - - Glacier storage class - - "DEEP_ARCHIVE" - - Glacier Deep Archive storage class - - "INTELLIGENT_TIERING" - - Intelligent-Tiering storage class - - #### --s3-storage-class - - The storage class to use when storing new objects in OSS. - - - Config: storage_class - - Env Var: RCLONE_S3_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "STANDARD" - - Standard storage class - - "GLACIER" - - Archive storage mode. - - "STANDARD_IA" - - Infrequent access storage mode. - - ### Advanced Options - - Here are the advanced options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc)). - - #### --s3-bucket-acl - - Canned ACL used when creating buckets. - - For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl - - Note that this ACL is applied when only when creating buckets. If it - isn't set then "acl" is used instead. - - - Config: bucket_acl - - Env Var: RCLONE_S3_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "private" - - Owner gets FULL_CONTROL. No one else has access rights (default). - - "public-read" - - Owner gets FULL_CONTROL. The AllUsers group gets READ access. - - "public-read-write" - - Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. - - Granting this on a bucket is generally not recommended. - - "authenticated-read" - - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. - - #### --s3-upload-cutoff - - Cutoff for switching to chunked upload - - Any files larger than this will be uploaded in chunks of chunk_size. - The minimum is 0 and the maximum is 5GB. - - - Config: upload_cutoff - - Env Var: RCLONE_S3_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M - - #### --s3-chunk-size - - Chunk size to use for uploading. - - When uploading files larger than upload_cutoff they will be uploaded - as multipart uploads using this chunk size. - - Note that "--s3-upload-concurrency" chunks of this size are buffered - in memory per transfer. - - If you are transferring large files over high speed links and you have - enough memory, then increasing this will speed up the transfers. - - - Config: chunk_size - - Env Var: RCLONE_S3_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - #### --s3-disable-checksum - - Don't store MD5 checksum with object metadata - - - Config: disable_checksum - - Env Var: RCLONE_S3_DISABLE_CHECKSUM - - Type: bool - - Default: false - - #### --s3-session-token - - An AWS session token - - - Config: session_token - - Env Var: RCLONE_S3_SESSION_TOKEN - - Type: string - - Default: "" - - #### --s3-upload-concurrency - - Concurrency for multipart uploads. - - This is the number of chunks of the same file that are uploaded - concurrently. - - If you are uploading small numbers of large file over high speed link - and these uploads do not fully utilize your bandwidth, then increasing - this may help to speed up the transfers. - - - Config: upload_concurrency - - Env Var: RCLONE_S3_UPLOAD_CONCURRENCY - - Type: int - - Default: 4 - - #### --s3-force-path-style - - If true use path style access if false use virtual hosted style. - - If this is true (the default) then rclone will use path style access, - if false then rclone will use virtual path style. See [the AWS S3 - docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) - for more info. - - Some providers (eg Aliyun OSS or Netease COS) require this set to false. - - - Config: force_path_style - - Env Var: RCLONE_S3_FORCE_PATH_STYLE - - Type: bool - - Default: true - - #### --s3-v2-auth - - If true use v2 authentication. - - If this is false (the default) then rclone will use v4 authentication. - If it is set then rclone will use v2 authentication. - - Use this only if v4 signatures don't work, eg pre Jewel/v10 CEPH. - - - Config: v2_auth - - Env Var: RCLONE_S3_V2_AUTH - - Type: bool - - Default: false - - #### --s3-use-accelerate-endpoint - - If true use the AWS S3 accelerated endpoint. - - See: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) - - - Config: use_accelerate_endpoint - - Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT - - Type: bool - - Default: false - - #### --s3-leave-parts-on-error - - If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery. - - It should be set to true for resuming uploads across different sessions. - - WARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up. - - - - Config: leave_parts_on_error - - Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR - - Type: bool - - Default: false - - - - ### Anonymous access to public buckets ### - - If you want to use rclone to access a public bucket, configure with a - blank `access_key_id` and `secret_access_key`. Your config should end - up looking like this: - -[anons3] type = s3 provider = AWS env_auth = false access_key_id = -secret_access_key = region = us-east-1 endpoint = location_constraint = -acl = private server_side_encryption = storage_class = - - - Then use it as normal with the name of the public bucket, eg - - rclone lsd anons3:1000genomes - - You will be able to list and copy data but not upload it. - - ### Ceph ### - - [Ceph](https://ceph.com/) is an open source unified, distributed - storage system designed for excellent performance, reliability and - scalability. It has an S3 compatible object storage interface. - - To use rclone with Ceph, configure as above but leave the region blank - and set the endpoint. You should end up with something like this in - your config: - -[ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX -secret_access_key = YYY region = endpoint = -https://ceph.endpoint.example.com location_constraint = acl = -server_side_encryption = storage_class = - - - If you are using an older version of CEPH, eg 10.2.x Jewel, then you - may need to supply the parameter `--s3-upload-cutoff 0` or put this in - the config file as `upload_cutoff 0` to work around a bug which causes - uploading of small files to fail. - - Note also that Ceph sometimes puts `/` in the passwords it gives - users. If you read the secret access key using the command line tools - you will get a JSON blob with the `/` escaped as `\/`. Make sure you - only write `/` in the secret access key. - - Eg the dump from Ceph looks something like this (irrelevant keys - removed). - -{ “user_id”: “xxx”, “display_name”: “xxxx”, “keys”: [ { “user”: “xxx”, -“access_key”: “xxxxxx”, “secret_key”: “xxxxxx/xxxx” } ], } - - - Because this is a json dump, it is encoding the `/` as `\/`, so if you - use the secret key as `xxxxxx/xxxx` it will work fine. - - ### Dreamhost ### - - Dreamhost [DreamObjects](https://www.dreamhost.com/cloud/storage/) is - an object storage system based on CEPH. - - To use rclone with Dreamhost, configure as above but leave the region blank - and set the endpoint. You should end up with something like this in - your config: - -[dreamobjects] type = s3 provider = DreamHost env_auth = false -access_key_id = your_access_key secret_access_key = your_secret_key -region = endpoint = objects-us-west-1.dream.io location_constraint = acl -= private server_side_encryption = storage_class = - - - ### DigitalOcean Spaces ### - - [Spaces](https://www.digitalocean.com/products/object-storage/) is an [S3-interoperable](https://developers.digitalocean.com/documentation/spaces/) object storage service from cloud provider DigitalOcean. - - To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the "[Applications & API](https://cloud.digitalocean.com/settings/api/tokens)" page of the DigitalOcean control panel. They will be needed when promted by `rclone config` for your `access_key_id` and `secret_access_key`. - - When prompted for a `region` or `location_constraint`, press enter to use the default value. The region must be included in the `endpoint` setting (e.g. `nyc3.digitaloceanspaces.com`). The default values can be used for other settings. - - Going through the whole process of creating a new remote by running `rclone config`, each prompt should be answered as shown below: - -Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY -secret_access_key> YOUR_SECRET_KEY region> endpoint> -nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> - - - The resulting configuration file should look like: - -[spaces] type = s3 provider = DigitalOcean env_auth = false -access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY -region = endpoint = nyc3.digitaloceanspaces.com location_constraint = -acl = server_side_encryption = storage_class = - - - Once configured, you can create a new Space and begin copying files. For example: - -rclone mkdir spaces:my-new-space rclone copy /path/to/files -spaces:my-new-space - - - ### IBM COS (S3) ### - - Information stored with IBM Cloud Object Storage is encrypted and dispersed across multiple geographic locations, and accessed through an implementation of the S3 API. This service makes use of the distributed storage technologies provided by IBM’s Cloud Object Storage System (formerly Cleversafe). For more information visit: (http://www.ibm.com/cloud/object-storage) - - To configure access to IBM COS S3, follow the steps below: - - 1. Run rclone config and select n for a new remote. - - 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults No remotes found - make a new one n) New remote s) Set configuration password q) Quit config n/s/q> n - - - 2. Enter the name for the configuration - - name> - - - 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. + 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 - 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] + XX / 1Fichier + \ "fichier" + [snip] + Storage> fichier + ** See help for fichier backend at: https://rclone.org/fichier/ ** -[snip] 34 / Toronto Single Site Private Endpoint - “s3.tor01.objectstorage.service.networklayer.com” endpoint>1 + 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 the following +characters are also replaced: + + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + < 0x3C ＜ + > 0x3E ＞ + " 0x22 ＂ + $ 0x24 ＄ + ` 0x60 ｀ + ’ 0x27 ＇ + +File names can also not start or end with the following characters. +These only get replaced if they are first or last character in the name: + + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + +Standard Options + +Here are the standard options specific to fichier (1Fichier). + +–fichier-api-key + +Your API Key, get it from https://1fichier.com/console/params.pl + +- Config: api_key +- Env Var: RCLONE_FICHIER_API_KEY +- Type: string +- Default: "" + +Advanced Options + +Here are the advanced options specific to fichier (1Fichier). + +–fichier-shared-folder + +If you want to download a shared folder, add this parameter + +- Config: shared_folder +- Env Var: RCLONE_FICHIER_SHARED_FOLDER +- Type: string +- Default: "" + +–fichier-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_FICHIER_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +Alias - 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 +The alias remote provides a new name for another remote. - 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" +Paths may be as deep as required or a local path, eg +remote:directory/subdirectory or /directory/subdirectory. -[snip] 32 / Toronto Flex  “tor01-flex” location_constraint>1 +During the initial setup with rclone config you will specify the target +remote. The target remote can either be a local path or another remote. + +Subfolders can be used in target remote. Assume a alias remote named +backup with the target mydrive:private/backup. Invoking +rclone mkdir backup:desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/desktop. + +There will be no special handling of paths containing .. segments. +Invoking rclone mkdir backup:../desktop is exactly the same as invoking +rclone mkdir mydrive:private/backup/../desktop. The empty path is not +allowed as a remote. To alias the current directory use . instead. + +Here is an example of how to make a alias called remote for local +folder. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Alias for an existing remote + \ "alias" + [snip] + Storage> alias + Remote or path to alias. + Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". + remote> /mnt/storage/backup + Remote config + -------------------- + [remote] + remote = /mnt/storage/backup + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + Current remotes: + + Name Type + ==== ==== + remote alias + + 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: "" - 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. +Amazon Drive -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 +Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage +service run by Amazon for consumers. +Status - 12. Review the displayed configuration and accept to save the "remote" then quit. The config file should look like this +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. - [xxx] +For the history on why rclone no longer has a set of Amazon Drive API +keys see the forum. + +If you happen to know anyone who works at Amazon then please ask them to +re-instate rclone into the Amazon Drive developer program - thanks! + + +Setup + +The initial setup for Amazon Drive involves getting a token from Amazon +which you need to do in your browser. rclone config walks you through +it. + +The configuration process for Amazon Drive may involve using an oauth +proxy. This is used to keep the Amazon credentials out of the source +code. The proxy runs in Google’s very secure App Engine environment and +doesn’t store any credentials which pass through it. + +Since rclone doesn’t currently have its own Amazon Drive credentials so +you will either need to have your own client_id and client_secret with +Amazon Drive, or use a a third party ouath proxy in which case you will +need to enter client_id, client_secret, auth_url and token_url. + +Note also if you are not using Amazon’s auth_url and token_url, (ie you +filled in something for those) then if setting up on a remote machine +you can only use the copying the config method of configuration - +rclone authorize will not work. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon Drive + \ "amazon cloud drive" + [snip] + Storage> amazon cloud drive + Amazon Application Client Id - required. + client_id> your client ID goes here + Amazon Application Client Secret - required. + client_secret> your client secret goes here + Auth server URL - leave blank to use Amazon's. + auth_url> Optional auth URL + Token server url - leave blank to use Amazon's. + token_url> Optional token URL + Remote config + Make sure your Redirect URL is set to "http://127.0.0.1:53682/" in your custom config. + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = your client ID goes here + client_secret = your client secret goes here + auth_url = Optional auth URL + token_url = Optional token URL + token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","refresh_token":"xxxxxxxxxxxxxxxxxx","expiry":"2015-09-06T16:07:39.658438471+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet browser available. + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Amazon. This only runs from the moment it opens +your browser to the moment you get back the verification code. This is +on http://127.0.0.1:53682/ and this it may require you to unblock it +temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your Amazon Drive + + rclone lsd remote: + +List all the files in your Amazon Drive + + rclone ls remote: + +To copy a local directory to an Amazon Drive directory called backup + + rclone copy /home/source remote:backup + +Modified time and MD5SUMs + +Amazon Drive doesn’t allow modification times to be changed via the API +so these won’t be accurate or used for syncing. + +It does store MD5SUMs so for a more accurate sync, you can use the +--checksum flag. + +Restricted filename characters + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. + +Deleting files + +Any files you delete with rclone will end up in the trash. Amazon don’t +provide an API to permanently delete files, nor to empty the trash, so +you will have to do that with one of Amazon’s apps or via the Amazon +Drive website. As of November 17, 2016, files are automatically deleted +by Amazon from the trash after 30 days. + +Using with non .com Amazon accounts + +Let’s say you usually use amazon.co.uk. When you authenticate with +rclone it will take you to an amazon.com page to log in. Your +amazon.co.uk email and password should work here just fine. + +Standard Options + +Here are the standard options specific to amazon cloud drive (Amazon +Drive). + +–acd-client-id + +Amazon Application Client ID. + +- Config: client_id +- Env Var: RCLONE_ACD_CLIENT_ID +- Type: string +- Default: "" + +–acd-client-secret + +Amazon Application Client Secret. + +- Config: client_secret +- Env Var: RCLONE_ACD_CLIENT_SECRET +- Type: string +- Default: "" + +Advanced Options + +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). + +–acd-auth-url + +Auth server URL. Leave blank to use Amazon’s. + +- Config: auth_url +- Env Var: RCLONE_ACD_AUTH_URL +- Type: string +- Default: "" + +–acd-token-url + +Token server url. leave blank to use Amazon’s. + +- Config: token_url +- Env Var: RCLONE_ACD_TOKEN_URL +- Type: string +- Default: "" + +–acd-checkpoint + +Checkpoint for internal polling (debug). + +- Config: checkpoint +- Env Var: RCLONE_ACD_CHECKPOINT +- Type: string +- Default: "" + +–acd-upload-wait-per-gb + +Additional time per GB to wait after a failed complete upload to see if +it appears. + +Sometimes Amazon Drive gives an error when a file has been fully +uploaded but the file appears anyway after a little while. This happens +sometimes for files over 1GB in size and nearly every time for files +bigger than 10GB. This parameter controls the time rclone waits for the +file to appear. + +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. + +You can disable this feature by setting it to 0. This may cause conflict +errors as rclone retries the failed upload but the file will most likely +appear correctly eventually. + +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. + +Upload with the “-v” flag to see more info about what rclone is doing in +this situation. + +- Config: upload_wait_per_gb +- Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +- Type: Duration +- Default: 3m0s + +–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 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 +- Wasabi + +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. + +Once you have made a remote (see the provider specific section above) +you can use it like this: + +See all buckets + + rclone lsd remote: + +Make a new bucket + + rclone mkdir remote:bucket + +List the contents of a bucket + + rclone ls remote:bucket + +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. + + rclone sync /home/local/directory remote:bucket + + +AWS S3 + +Here is an example of making an s3 configuration. First run + + rclone config + +This will guide you through an interactive setup process. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) + \ "s3" + [snip] + Storage> s3 + Choose your S3 provider. + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + 2 / Ceph Object Storage + \ "Ceph" + 3 / Digital Ocean Spaces + \ "DigitalOcean" + 4 / Dreamhost DreamObjects + \ "Dreamhost" + 5 / IBM COS S3 + \ "IBMCOS" + 6 / Minio Object Storage + \ "Minio" + 7 / Wasabi Object Storage + \ "Wasabi" + 8 / Any other S3 compatible provider + \ "Other" + provider> 1 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> XXX + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YYY + Region to connect to. + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + / US East (Ohio) Region + 2 | Needs location constraint us-east-2. + \ "us-east-2" + / US West (Oregon) Region + 3 | Needs location constraint us-west-2. + \ "us-west-2" + / US West (Northern California) Region + 4 | Needs location constraint us-west-1. + \ "us-west-1" + / Canada (Central) Region + 5 | Needs location constraint ca-central-1. + \ "ca-central-1" + / EU (Ireland) Region + 6 | Needs location constraint EU or eu-west-1. + \ "eu-west-1" + / EU (London) Region + 7 | Needs location constraint eu-west-2. + \ "eu-west-2" + / EU (Frankfurt) Region + 8 | Needs location constraint eu-central-1. + \ "eu-central-1" + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap-southeast-1. + \ "ap-southeast-1" + / Asia Pacific (Sydney) Region + 10 | Needs location constraint ap-southeast-2. + \ "ap-southeast-2" + / Asia Pacific (Tokyo) Region + 11 | Needs location constraint ap-northeast-1. + \ "ap-northeast-1" + / Asia Pacific (Seoul) + 12 | Needs location constraint ap-northeast-2. + \ "ap-northeast-2" + / Asia Pacific (Mumbai) + 13 | Needs location constraint ap-south-1. + \ "ap-south-1" + / 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 = IBMCOS - access_key_id = xxx - secret_access_key = yyy - endpoint = s3-api.us-geo.objectstorage.softlayer.net - location_constraint = us-standard + 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 - 13. Execute rclone commands +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. - 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 +–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. - ### Minio ### +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. - [Minio](https://minio.io/) is an object storage server built for cloud application developers and devops. +Modified time - It is very easy to install and provides an S3 compatible server which can be used by rclone. +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. - To use it, install Minio following the instructions [here](https://docs.minio.io/docs/minio-quickstart-guide). +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. - When it configures itself Minio will print something like this +Restricted filename characters -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 +S3 allows any valid UTF-8 string as a key. -Browser Access: http://192.168.1.106:9000 http://172.23.0.1:9000 +Invalid UTF-8 bytes will be replaced, as they can’t be used in XML. -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 +The following characters are replaced since these are problematic when +dealing with the REST API: -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 + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ -Drive Capacity: 26 GiB Free, 165 GiB Total +The encoding will also encode these file names as they don’t seem to +work with the SDK properly: + File name Replacement + ----------- ------------- + . ． + .. ．． - These details need to go into `rclone config` like this. Note that it - is important to put the region in as stated above. +Multipart uploads -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> +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. - Which makes the config file look like this +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). -[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 = +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. - So once set up, for example to copy files into a bucket +Single part transfers can be faster than multipart transfers or slower +depending on your latency from S3 - the more latency, the more likely +single part transfers will be faster. -rclone copy /path/to/files minio: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. +Buckets and Regions - ### Scaleway {#scaleway} +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. - [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. +Authentication - Scaleway provides an S3 interface which can be configured for use with rclone like this: +There are a number of ways to supply rclone with a set of AWS +credentials, with and without using the environment. -[scaleway] type = s3 env_auth = false endpoint = s3.nl-ams.scw.cloud -access_key_id = SCWXXXXXXXXXXXXXX secret_access_key = -1111111-2222-3333-44444-55555555555555 region = nl-ams -location_constraint = acl = private force_path_style = false -server_side_encryption = storage_class = +The different authentication methods are tried in this order: +- Directly in the rclone configuration file (env_auth = false in the + config file): + - access_key_id and secret_access_key are required. + - session_token can be optionally set when using AWS STS. +- Runtime configuration (env_auth = true in the config file): + - Export the following environment variables before running + rclone: + - Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY + - Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY + - Session Token: AWS_SESSION_TOKEN (optional) + - Or, use a named profile: + - Profile files are standard files used by AWS CLI tools + - By default it will use the profile in your home directory + (eg ~/.aws/credentials on unix based systems) file and the + “default” profile, to change set these environment + variables: + - AWS_SHARED_CREDENTIALS_FILE to control which file. + - AWS_PROFILE to control which profile to use. + - Or, run rclone in an ECS task with an IAM role (AWS only). + - Or, run rclone on an EC2 instance with an IAM role (AWS only). + - Or, run rclone in an EKS pod with an IAM role that is associated + with a service account (AWS only). - ### Wasabi ### +If none of these option actually end up providing rclone with AWS +credentials then S3 interaction will be non-authenticated (see below). - [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. +S3 Permissions - Wasabi provides an S3 interface which can be configured for use with - rclone like this. +When using the sync subcommand of rclone the following minimum +permissions are required to be available on the bucket being written to: -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 +- ListBucket +- DeleteObject +- GetObject +- PutObject +- PutObjectACL +When using the lsd subcommand, the ListAllMyBuckets permission is +required. - This will leave the config file looking like this. +Example policy: -[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 = + { + "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: - ### Alibaba OSS {#alibaba-oss} +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. - Here is an example of making an [Alibaba Cloud (Aliyun) OSS](https://www.alibabacloud.com/product/oss/) - configuration. First run: +For reference, here’s an Ansible script that will generate one or more +buckets that will work with rclone sync. - rclone config +Key Management System (KMS) - This will guide you through an interactive setup process. +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. -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 +A proper fix is being worked on in issue #1824. + +Glacier and Glacier Deep Archive + +You can upload objects using the glacier storage class or transition +them to glacier using a lifecycle policy. The bucket can still be synced +or copied into normally, but if rclone tries to access data from the +glacier storage class you will see an error like below. + + 2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file + +In this case you need to restore the object(s) in question before using +rclone. + +Note that rclone only speaks the S3 API it does not speak the Glacier +Vault API, so rclone cannot directly access Glacier Vaults. + +Standard Options + +Here are the standard options specific to s3 (Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, -Minio, etc)  ”s3" [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 +Minio, etc)). + +–s3-provider + +Choose your S3 provider. + +- Config: provider +- Env Var: RCLONE_S3_PROVIDER +- Type: string +- Default: "" +- Examples: + - “AWS” + - Amazon Web Services (AWS) S3 + - “Alibaba” + - Alibaba Cloud Object Storage System (OSS) formerly Aliyun + - “Ceph” + - Ceph Object Storage + - “DigitalOcean” + - Digital Ocean Spaces + - “Dreamhost” + - Dreamhost DreamObjects + - “IBMCOS” + - IBM COS S3 + - “Minio” + - Minio Object Storage + - “Netease” + - Netease Object Storage (NOS) + - “Wasabi” + - Wasabi Object Storage + - “Other” + - Any other S3 compatible provider + +–s3-env-auth + +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). Only applies if access_key_id and +secret_access_key is blank. + +- Config: env_auth +- Env Var: RCLONE_S3_ENV_AUTH +- Type: bool +- Default: false +- Examples: + - “false” + - Enter AWS credentials in the next step + - “true” + - Get AWS credentials from the environment (env vars or IAM) + +–s3-access-key-id + AWS Access Key ID. Leave blank for anonymous access or runtime -credentials. 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. +credentials. + +- Config: access_key_id +- Env Var: RCLONE_S3_ACCESS_KEY_ID +- Type: string +- Default: "" + +–s3-secret-access-key + +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. + +- Config: secret_access_key +- Env Var: RCLONE_S3_SECRET_ACCESS_KEY +- Type: string +- Default: "" + +–s3-region + +Region to connect to. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - “us-east-1” + - The default endpoint - a good choice if you are unsure. + - US Region, Northern Virginia or Pacific Northwest. + - Leave location constraint empty. + - “us-east-2” + - US East (Ohio) Region + - Needs location constraint us-east-2. + - “us-west-2” + - US West (Oregon) Region + - Needs location constraint us-west-2. + - “us-west-1” + - US West (Northern California) Region + - Needs location constraint us-west-1. + - “ca-central-1” + - Canada (Central) Region + - Needs location constraint ca-central-1. + - “eu-west-1” + - EU (Ireland) Region + - Needs location constraint EU or eu-west-1. + - “eu-west-2” + - EU (London) Region + - Needs location constraint eu-west-2. + - “eu-north-1” + - EU (Stockholm) Region + - Needs location constraint eu-north-1. + - “eu-central-1” + - EU (Frankfurt) Region + - Needs location constraint eu-central-1. + - “ap-southeast-1” + - Asia Pacific (Singapore) Region + - Needs location constraint ap-southeast-1. + - “ap-southeast-2” + - Asia Pacific (Sydney) Region + - Needs location constraint ap-southeast-2. + - “ap-northeast-1” + - Asia Pacific (Tokyo) Region + - Needs location constraint ap-northeast-1. + - “ap-northeast-2” + - Asia Pacific (Seoul) + - Needs location constraint ap-northeast-2. + - “ap-south-1” + - Asia Pacific (Mumbai) + - Needs location constraint ap-south-1. + - “ap-east-1” + - Asia Patific (Hong Kong) Region + - Needs location constraint ap-east-1. + - “sa-east-1” + - South America (Sao Paulo) Region + - Needs location constraint sa-east-1. + +–s3-region + +Region to connect to. Leave blank if you are using an S3 clone and you +don’t have a region. + +- Config: region +- Env Var: RCLONE_S3_REGION +- Type: string +- Default: "" +- Examples: + - "" + - Use this if unsure. Will use v4 signatures and an empty + region. + - “other-v2-signature” + - Use this only if v4 signatures don’t work, eg pre Jewel/v10 + CEPH. + +–s3-endpoint + +Endpoint for S3 API. Leave blank if using AWS to use the default +endpoint for the region. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" + +–s3-endpoint + +Endpoint for IBM COS S3 API. Specify if using an IBM COS On Premise. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - “s3-api.us-geo.objectstorage.softlayer.net” + - US Cross Region Endpoint + - “s3-api.dal.us-geo.objectstorage.softlayer.net” + - US Cross Region Dallas Endpoint + - “s3-api.wdc-us-geo.objectstorage.softlayer.net” + - US Cross Region Washington DC Endpoint + - “s3-api.sjc-us-geo.objectstorage.softlayer.net” + - US Cross Region San Jose Endpoint + - “s3-api.us-geo.objectstorage.service.networklayer.com” + - US Cross Region Private Endpoint + - “s3-api.dal-us-geo.objectstorage.service.networklayer.com” + - US Cross Region Dallas Private Endpoint + - “s3-api.wdc-us-geo.objectstorage.service.networklayer.com” + - US Cross Region Washington DC Private Endpoint + - “s3-api.sjc-us-geo.objectstorage.service.networklayer.com” + - US Cross Region San Jose Private Endpoint + - “s3.us-east.objectstorage.softlayer.net” + - US Region East Endpoint + - “s3.us-east.objectstorage.service.networklayer.com” + - US Region East Private Endpoint + - “s3.us-south.objectstorage.softlayer.net” + - US Region South Endpoint + - “s3.us-south.objectstorage.service.networklayer.com” + - US Region South Private Endpoint + - “s3.eu-geo.objectstorage.softlayer.net” + - EU Cross Region Endpoint + - “s3.fra-eu-geo.objectstorage.softlayer.net” + - EU Cross Region Frankfurt Endpoint + - “s3.mil-eu-geo.objectstorage.softlayer.net” + - EU Cross Region Milan Endpoint + - “s3.ams-eu-geo.objectstorage.softlayer.net” + - EU Cross Region Amsterdam Endpoint + - “s3.eu-geo.objectstorage.service.networklayer.com” + - EU Cross Region Private Endpoint + - “s3.fra-eu-geo.objectstorage.service.networklayer.com” + - EU Cross Region Frankfurt Private Endpoint + - “s3.mil-eu-geo.objectstorage.service.networklayer.com” + - EU Cross Region Milan Private Endpoint + - “s3.ams-eu-geo.objectstorage.service.networklayer.com” + - EU Cross Region Amsterdam Private Endpoint + - “s3.eu-gb.objectstorage.softlayer.net” + - Great Britain Endpoint + - “s3.eu-gb.objectstorage.service.networklayer.com” + - Great Britain Private Endpoint + - “s3.ap-geo.objectstorage.softlayer.net” + - APAC Cross Regional Endpoint + - “s3.tok-ap-geo.objectstorage.softlayer.net” + - APAC Cross Regional Tokyo Endpoint + - “s3.hkg-ap-geo.objectstorage.softlayer.net” + - APAC Cross Regional HongKong Endpoint + - “s3.seo-ap-geo.objectstorage.softlayer.net” + - APAC Cross Regional Seoul Endpoint + - “s3.ap-geo.objectstorage.service.networklayer.com” + - APAC Cross Regional Private Endpoint + - “s3.tok-ap-geo.objectstorage.service.networklayer.com” + - APAC Cross Regional Tokyo Private Endpoint + - “s3.hkg-ap-geo.objectstorage.service.networklayer.com” + - APAC Cross Regional HongKong Private Endpoint + - “s3.seo-ap-geo.objectstorage.service.networklayer.com” + - APAC Cross Regional Seoul Private Endpoint + - “s3.mel01.objectstorage.softlayer.net” + - Melbourne Single Site Endpoint + - “s3.mel01.objectstorage.service.networklayer.com” + - Melbourne Single Site Private Endpoint + - “s3.tor01.objectstorage.softlayer.net” + - Toronto Single Site Endpoint + - “s3.tor01.objectstorage.service.networklayer.com” + - Toronto Single Site Private Endpoint + +–s3-endpoint + +Endpoint for OSS API. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - “oss-cn-hangzhou.aliyuncs.com” + - East China 1 (Hangzhou) + - “oss-cn-shanghai.aliyuncs.com” + - East China 2 (Shanghai) + - “oss-cn-qingdao.aliyuncs.com” + - North China 1 (Qingdao) + - “oss-cn-beijing.aliyuncs.com” + - North China 2 (Beijing) + - “oss-cn-zhangjiakou.aliyuncs.com” + - North China 3 (Zhangjiakou) + - “oss-cn-huhehaote.aliyuncs.com” + - North China 5 (Huhehaote) + - “oss-cn-shenzhen.aliyuncs.com” + - South China 1 (Shenzhen) + - “oss-cn-hongkong.aliyuncs.com” + - Hong Kong (Hong Kong) + - “oss-us-west-1.aliyuncs.com” + - US West 1 (Silicon Valley) + - “oss-us-east-1.aliyuncs.com” + - US East 1 (Virginia) + - “oss-ap-southeast-1.aliyuncs.com” + - Southeast Asia Southeast 1 (Singapore) + - “oss-ap-southeast-2.aliyuncs.com” + - Asia Pacific Southeast 2 (Sydney) + - “oss-ap-southeast-3.aliyuncs.com” + - Southeast Asia Southeast 3 (Kuala Lumpur) + - “oss-ap-southeast-5.aliyuncs.com” + - Asia Pacific Southeast 5 (Jakarta) + - “oss-ap-northeast-1.aliyuncs.com” + - Asia Pacific Northeast 1 (Japan) + - “oss-ap-south-1.aliyuncs.com” + - Asia Pacific South 1 (Mumbai) + - “oss-eu-central-1.aliyuncs.com” + - Central Europe 1 (Frankfurt) + - “oss-eu-west-1.aliyuncs.com” + - West Europe (London) + - “oss-me-east-1.aliyuncs.com” + - Middle East 1 (Dubai) + +–s3-endpoint + +Endpoint for S3 API. Required when using an S3 clone. + +- Config: endpoint +- Env Var: RCLONE_S3_ENDPOINT +- Type: string +- Default: "" +- Examples: + - “objects-us-east-1.dream.io” + - Dream Objects endpoint + - “nyc3.digitaloceanspaces.com” + - Digital Ocean Spaces New York 3 + - “ams3.digitaloceanspaces.com” + - Digital Ocean Spaces Amsterdam 3 + - “sgp1.digitaloceanspaces.com” + - Digital Ocean Spaces Singapore 1 + - “s3.wasabisys.com” + - Wasabi US East endpoint + - “s3.us-west-1.wasabisys.com” + - Wasabi US West endpoint + - “s3.eu-central-1.wasabisys.com” + - Wasabi EU Central endpoint + +–s3-location-constraint + +Location constraint - must be set to match the Region. Used when +creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - "" + - Empty for US Region, Northern Virginia or Pacific Northwest. + - “us-east-2” + - US East (Ohio) Region. + - “us-west-2” + - US West (Oregon) Region. + - “us-west-1” + - US West (Northern California) Region. + - “ca-central-1” + - Canada (Central) Region. + - “eu-west-1” + - EU (Ireland) Region. + - “eu-west-2” + - EU (London) Region. + - “eu-north-1” + - EU (Stockholm) Region. + - “EU” + - EU Region. + - “ap-southeast-1” + - Asia Pacific (Singapore) Region. + - “ap-southeast-2” + - Asia Pacific (Sydney) Region. + - “ap-northeast-1” + - Asia Pacific (Tokyo) Region. + - “ap-northeast-2” + - Asia Pacific (Seoul) + - “ap-south-1” + - Asia Pacific (Mumbai) + - “ap-east-1” + - Asia Pacific (Hong Kong) + - “sa-east-1” + - South America (Sao Paulo) Region. + +–s3-location-constraint + +Location constraint - must match endpoint when using IBM Cloud Public. +For on-prem COS, do not make a selection from this list, hit enter + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" +- Examples: + - “us-standard” + - US Cross Region Standard + - “us-vault” + - US Cross Region Vault + - “us-cold” + - US Cross Region Cold + - “us-flex” + - US Cross Region Flex + - “us-east-standard” + - US East Region Standard + - “us-east-vault” + - US East Region Vault + - “us-east-cold” + - US East Region Cold + - “us-east-flex” + - US East Region Flex + - “us-south-standard” + - US South Region Standard + - “us-south-vault” + - US South Region Vault + - “us-south-cold” + - US South Region Cold + - “us-south-flex” + - US South Region Flex + - “eu-standard” + - EU Cross Region Standard + - “eu-vault” + - EU Cross Region Vault + - “eu-cold” + - EU Cross Region Cold + - “eu-flex” + - EU Cross Region Flex + - “eu-gb-standard” + - Great Britain Standard + - “eu-gb-vault” + - Great Britain Vault + - “eu-gb-cold” + - Great Britain Cold + - “eu-gb-flex” + - Great Britain Flex + - “ap-standard” + - APAC Standard + - “ap-vault” + - APAC Vault + - “ap-cold” + - APAC Cold + - “ap-flex” + - APAC Flex + - “mel01-standard” + - Melbourne Standard + - “mel01-vault” + - Melbourne Vault + - “mel01-cold” + - Melbourne Cold + - “mel01-flex” + - Melbourne Flex + - “tor01-standard” + - Toronto Standard + - “tor01-vault” + - Toronto Vault + - “tor01-cold” + - Toronto Cold + - “tor01-flex” + - Toronto Flex + +–s3-location-constraint + +Location constraint - must be set to match the Region. Leave blank if +not sure. Used when creating buckets only. + +- Config: location_constraint +- Env Var: RCLONE_S3_LOCATION_CONSTRAINT +- Type: string +- Default: "" + +–s3-acl + +Canned ACL used when creating buckets and storing or copying objects. + +This ACL is used for creating objects and if bucket_acl isn’t set, for +creating buckets too. + +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl Note that this ACL is applied when server side copying objects as S3 doesn’t copy the ACL from the source but rather writes a fresh one. -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 +- Config: acl +- Env Var: RCLONE_S3_ACL +- Type: string +- Default: "" +- Examples: + - “private” + - Owner gets FULL_CONTROL. No one else has access rights + (default). + - “public-read” + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. + - “public-read-write” + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. + - Granting this on a bucket is generally not recommended. + - “authenticated-read” + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. + - “bucket-owner-read” + - Object owner gets FULL_CONTROL. Bucket owner gets READ + access. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - “bucket-owner-full-control” + - Both the object owner and the bucket owner get FULL_CONTROL + over the object. + - If you specify this canned ACL when creating a bucket, + Amazon S3 ignores it. + - “private” + - Owner gets FULL_CONTROL. No one else has access rights + (default). This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise COS + - “public-read” + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. This acl is available on IBM Cloud (Infra), IBM + Cloud (Storage), On-Premise IBM COS + - “public-read-write” + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. This acl is available on IBM Cloud (Infra), + On-Premise IBM COS + - “authenticated-read” + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. Not supported on Buckets. This acl is available + on IBM Cloud (Infra) and On-Premise IBM COS + +–s3-server-side-encryption + +The server-side encryption algorithm used when storing this object in +S3. + +- Config: server_side_encryption +- Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +- Type: string +- Default: "" +- Examples: + - "" + - None + - “AES256” + - AES256 + - “aws:kms” + - aws:kms + +–s3-sse-kms-key-id + +If using KMS ID you must provide the ARN of Key. + +- Config: sse_kms_key_id +- Env Var: RCLONE_S3_SSE_KMS_KEY_ID +- Type: string +- Default: "" +- Examples: + - "" + - None + - "arn:aws:kms:us-east-1:*" + - arn:aws:kms:* + +–s3-storage-class + +The storage class to use when storing new objects in S3. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - “STANDARD” + - Standard storage class + - “REDUCED_REDUNDANCY” + - Reduced redundancy storage class + - “STANDARD_IA” + - Standard Infrequent Access storage class + - “ONEZONE_IA” + - One Zone Infrequent Access storage class + - “GLACIER” + - Glacier storage class + - “DEEP_ARCHIVE” + - Glacier Deep Archive storage class + - “INTELLIGENT_TIERING” + - Intelligent-Tiering storage class + +–s3-storage-class + +The storage class to use when storing new objects in OSS. + +- Config: storage_class +- Env Var: RCLONE_S3_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - “STANDARD” + - Standard storage class + - “GLACIER” + - Archive storage mode. + - “STANDARD_IA” + - Infrequent access storage mode. + +Advanced Options + +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, etc)). + +–s3-bucket-acl + +Canned ACL used when creating buckets. + +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + +Note that this ACL is applied when only when creating buckets. If it +isn’t set then “acl” is used instead. + +- Config: bucket_acl +- Env Var: RCLONE_S3_BUCKET_ACL +- Type: string +- Default: "" +- Examples: + - “private” + - Owner gets FULL_CONTROL. No one else has access rights + (default). + - “public-read” + - Owner gets FULL_CONTROL. The AllUsers group gets READ + access. + - “public-read-write” + - Owner gets FULL_CONTROL. The AllUsers group gets READ and + WRITE access. + - Granting this on a bucket is generally not recommended. + - “authenticated-read” + - Owner gets FULL_CONTROL. The AuthenticatedUsers group gets + READ access. + +–s3-upload-cutoff + +Cutoff for switching to chunked upload + +Any files larger than this will be uploaded in chunks of chunk_size. The +minimum is 0 and the maximum is 5GB. - ### Netease NOS ### +- Config: upload_cutoff +- Env Var: RCLONE_S3_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M - 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. +–s3-chunk-size - Backblaze B2 - ---------------------------------------- +Chunk size to use for uploading. - B2 is [Backblaze's cloud storage system](https://www.backblaze.com/b2/). +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. - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. +Note that “–s3-upload-concurrency” chunks of this size are buffered in +memory per transfer. - Here is an example of making a b2 configuration. First run +If you are transferring large files over high speed links and you have +enough memory, then increasing this will speed up the transfers. - rclone config +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. - 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. +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. -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 +- Config: chunk_size +- Env Var: RCLONE_S3_CHUNK_SIZE +- Type: SizeSuffix +- Default: 5M +–s3-copy-cutoff - This remote is called `remote` and can now be used like this +Cutoff for switching to multipart copy - See all buckets +Any files larger than this that need to be server side copied will be +copied in chunks of this size. - rclone lsd remote: +The minimum is 0 and the maximum is 5GB. - Create a new bucket +- Config: copy_cutoff +- Env Var: RCLONE_S3_COPY_CUTOFF +- Type: SizeSuffix +- Default: 5G - rclone mkdir remote:bucket +–s3-disable-checksum - List the contents of a bucket +Don’t store MD5 checksum with object metadata - rclone ls remote:bucket +- Config: disable_checksum +- Env Var: RCLONE_S3_DISABLE_CHECKSUM +- Type: bool +- Default: false - Sync `/home/local/directory` to the remote bucket, deleting any - excess files in the bucket. +–s3-session-token - rclone sync /home/local/directory remote:bucket +An AWS session token - ### Application Keys ### +- Config: session_token +- Env Var: RCLONE_S3_SESSION_TOKEN +- Type: string +- Default: "" - B2 supports multiple [Application Keys for different access permission - to B2 Buckets](https://www.backblaze.com/b2/docs/application_keys.html). +–s3-upload-concurrency - You can use these with rclone too; you will need to use rclone version 1.43 - or later. +Concurrency for multipart uploads. - 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`. +This is the number of chunks of the same file that are uploaded +concurrently. - 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. +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. - ### --fast-list ### +- Config: upload_concurrency +- Env Var: RCLONE_S3_UPLOAD_CONCURRENCY +- Type: int +- Default: 4 - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](/docs/#fast-list) for more details. +–s3-force-path-style - ### Modified time ### +If true use path style access if false use virtual hosted style. - 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. +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. - 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. +Some providers (eg AWS, Aliyun OSS or Netease COS) require this set to +false - rclone will do this automatically based on the provider setting. - #### Restricted filename characters +- Config: force_path_style +- Env Var: RCLONE_S3_FORCE_PATH_STYLE +- Type: bool +- Default: true - In addition to the [default restricted characters set](/overview/#restricted-characters) - the following characters are also replaced: +–s3-v2-auth - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | +If true use v2 authentication. - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. +If this is false (the default) then rclone will use v4 authentication. +If it is set then rclone will use v2 authentication. - ### SHA1 checksums ### +Use this only if v4 signatures don’t work, eg pre Jewel/v10 CEPH. - The SHA1 checksums of the files are checked on upload and download and - will be used in the syncing process. +- Config: v2_auth +- Env Var: RCLONE_S3_V2_AUTH +- Type: bool +- Default: false - 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. +–s3-use-accelerate-endpoint - For a large file to be uploaded with an SHA1 checksum, the source - needs to support SHA1 checksums. The local disk supports SHA1 - checksums so large file transfers from local disk will have an SHA1. - See [the overview](/overview/#features) for exactly which remotes - support SHA1. +If true use the AWS S3 accelerated endpoint. - 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)). +See: AWS S3 Transfer acceleration - Files sizes below `--b2-upload-cutoff` will always have an SHA1 - regardless of the source. +- Config: use_accelerate_endpoint +- Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +- Type: bool +- Default: false - ### Transfers ### +–s3-leave-parts-on-error - 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. +If true avoid calling abort upload on a failure, leaving all +successfully uploaded parts on S3 for manual recovery. - 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. +It should be set to true for resuming uploads across different sessions. - ### Versions ### +WARNING: Storing parts of an incomplete multipart upload counts towards +space usage on S3 and will add additional costs if not cleaned up. - 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. +- Config: leave_parts_on_error +- Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR +- Type: bool +- Default: false - Old versions of files, where available, are visible using the - `--b2-versions` flag. +–s3-list-chunk - **NB** Note that `--b2-versions` does not work with crypt at the - moment [#1627](https://github.com/rclone/rclone/issues/1627). Using - [--backup-dir](/docs/#backup-dir-dir) with rclone is the recommended - way of working around this. +Size of listing chunk (response list for each ListObject S3 request). - 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`. +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. - Note that `cleanup` will remove partially uploaded files from the bucket - if they are more than a day old. +- Config: list_chunk +- Env Var: RCLONE_S3_LIST_CHUNK +- Type: int +- Default: 1000 - When you `purge` a bucket, the current and the old versions will be - deleted then the bucket will be deleted. +–s3-encoding - However `delete` will cause the current versions of the files to - become hidden old versions. +This sets the encoding for the backend. - Here is a session showing the listing and retrieval of an old - version followed by a `cleanup` of the old versions. +See: the encoding section in the overview for more info. - Show current version and all the versions with `--b2-versions` flag. +- Config: encoding +- Env Var: RCLONE_S3_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot -$ rclone -q ls b2:cleanup-test 9 one.txt +Anonymous access to public buckets -$ 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 +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 = - Retrieve an old version +Then use it as normal with the name of the public bucket, eg -$ rclone -q –b2-versions copy -b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp + rclone lsd anons3:1000genomes + +You will be able to list and copy data but not upload it. -$ 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 +Ceph +Ceph is an open source unified, distributed storage system designed for +excellent performance, reliability and scalability. It has an S3 +compatible object storage interface. + +To use rclone with Ceph, configure as above but leave the region blank +and set the endpoint. You should end up with something like this in your +config: + + [ceph] + type = s3 + provider = Ceph + env_auth = false + access_key_id = XXX + secret_access_key = YYY + region = + endpoint = https://ceph.endpoint.example.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +If you are using an older version of CEPH, eg 10.2.x Jewel, then you may +need to supply the parameter --s3-upload-cutoff 0 or put this in the +config file as upload_cutoff 0 to work around a bug which causes +uploading of small files to fail. + +Note also that Ceph sometimes puts / in the passwords it gives users. If +you read the secret access key using the command line tools you will get +a JSON blob with the / escaped as \/. Make sure you only write / in the +secret access key. + +Eg the dump from Ceph looks something like this (irrelevant keys +removed). + + { + "user_id": "xxx", + "display_name": "xxxx", + "keys": [ + { + "user": "xxx", + "access_key": "xxxxxx", + "secret_key": "xxxxxx\/xxxx" + } + ], + } + +Because this is a json dump, it is encoding the / as \/, so if you use +the secret key as xxxxxx/xxxx it will work fine. + +Dreamhost + +Dreamhost DreamObjects is an object storage system based on CEPH. + +To use rclone with Dreamhost, configure as above but leave the region +blank and set the endpoint. You should end up with something like this +in your config: + + [dreamobjects] + type = s3 + provider = DreamHost + env_auth = false + access_key_id = your_access_key + secret_access_key = your_secret_key + region = + endpoint = objects-us-west-1.dream.io + location_constraint = + acl = private + server_side_encryption = + storage_class = + +DigitalOcean Spaces + +Spaces is an S3-interoperable object storage service from cloud provider +DigitalOcean. + +To connect to DigitalOcean Spaces you will need an access key and secret +key. These can be retrieved on the “Applications & API” page of the +DigitalOcean control panel. They will be needed when promted by +rclone config for your access_key_id and secret_access_key. + +When prompted for a region or location_constraint, press enter to use +the default value. The region must be included in the endpoint setting +(e.g. nyc3.digitaloceanspaces.com). The default values can be used for +other settings. + +Going through the whole process of creating a new remote by running +rclone config, each prompt should be answered as shown below: + + Storage> s3 + env_auth> 1 + access_key_id> YOUR_ACCESS_KEY + secret_access_key> YOUR_SECRET_KEY + region> + endpoint> nyc3.digitaloceanspaces.com + location_constraint> + acl> + storage_class> + +The resulting configuration file should look like: + + [spaces] + type = s3 + provider = DigitalOcean + env_auth = false + access_key_id = YOUR_ACCESS_KEY + secret_access_key = YOUR_SECRET_KEY + region = + endpoint = nyc3.digitaloceanspaces.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +Once configured, you can create a new Space and begin copying files. For +example: + + rclone mkdir spaces:my-new-space + rclone copy /path/to/files spaces:my-new-space + +IBM COS (S3) + +Information stored with IBM Cloud Object Storage is encrypted and +dispersed across multiple geographic locations, and accessed through an +implementation of the S3 API. This service makes use of the distributed +storage technologies provided by IBM’s Cloud Object Storage System +(formerly Cleversafe). For more information visit: +(http://www.ibm.com/cloud/object-storage) + +To configure access to IBM COS S3, follow the steps below: + +1. Run rclone config and select n for a new remote. + + 2018/02/14 14:13:11 NOTICE: Config file "C:\\Users\\a\\.config\\rclone\\rclone.conf" not found - using defaults + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + +2. Enter the name for the configuration + + name> + +3. Select “s3” storage. + + Choose a number from below, or type in your own value + 1 / Alias for an existing remote + \ "alias" + 2 / Amazon Drive + \ "amazon cloud drive" + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + \ "s3" + 4 / Backblaze B2 + \ "b2" + [snip] + 23 / http Connection + \ "http" + Storage> 3 + +4. Select IBM COS as the S3 Storage Provider. + + Choose the S3 provider. + Choose a number from below, or type in your own value + 1 / Choose this option to configure Storage to AWS S3 + \ "AWS" + 2 / Choose this option to configure Storage to Ceph Systems + \ "Ceph" + 3 / Choose this option to configure Storage to Dreamhost + \ "Dreamhost" + 4 / Choose this option to the configure Storage to IBM COS S3 + \ "IBMCOS" + 5 / Choose this option to the configure Storage to Minio + \ "Minio" + Provider>4 + +5. Enter the Access Key and Secret. + + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> <> + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> <> + +6. Specify the endpoint for IBM COS. For Public IBM COS, choose from + the option below. For On Premise IBM COS, enter an enpoint address. + + Endpoint for IBM COS S3 API. + Specify if using an IBM COS On Premise. + Choose a number from below, or type in your own value + 1 / US Cross Region Endpoint + \ "s3-api.us-geo.objectstorage.softlayer.net" + 2 / US Cross Region Dallas Endpoint + \ "s3-api.dal.us-geo.objectstorage.softlayer.net" + 3 / US Cross Region Washington DC Endpoint + \ "s3-api.wdc-us-geo.objectstorage.softlayer.net" + 4 / US Cross Region San Jose Endpoint + \ "s3-api.sjc-us-geo.objectstorage.softlayer.net" + 5 / US Cross Region Private Endpoint + \ "s3-api.us-geo.objectstorage.service.networklayer.com" + 6 / US Cross Region Dallas Private Endpoint + \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com" + 7 / US Cross Region Washington DC Private Endpoint + \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com" + 8 / US Cross Region San Jose Private Endpoint + \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com" + 9 / US Region East Endpoint + \ "s3.us-east.objectstorage.softlayer.net" + 10 / US Region East Private Endpoint + \ "s3.us-east.objectstorage.service.networklayer.com" + 11 / US Region South Endpoint + [snip] + 34 / Toronto Single Site Private Endpoint + \ "s3.tor01.objectstorage.service.networklayer.com" + endpoint>1 + +7. Specify a IBM COS Location Constraint. The location constraint must + match endpoint when using IBM Cloud Public. For on-prem COS, do not + make a selection from this list, hit enter + + 1 / US Cross Region Standard + \ "us-standard" + 2 / US Cross Region Vault + \ "us-vault" + 3 / US Cross Region Cold + \ "us-cold" + 4 / US Cross Region Flex + \ "us-flex" + 5 / US East Region Standard + \ "us-east-standard" + 6 / US East Region Vault + \ "us-east-vault" + 7 / US East Region Cold + \ "us-east-cold" + 8 / US East Region Flex + \ "us-east-flex" + 9 / US South Region Standard + \ "us-south-standard" + 10 / US South Region Vault + \ "us-south-vault" + [snip] + 32 / Toronto Flex + \ "tor01-flex" + location_constraint>1 + +9. Specify a canned ACL. IBM Cloud (Strorage) supports “public-read” + and “private”. IBM Cloud(Infra) supports all the canned ACLs. + On-Premise COS supports all the canned ACLs. + + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS + \ "private" + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS + \ "public-read" + 3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS + \ "public-read-write" + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS + \ "authenticated-read" + acl> 1 + +12. Review the displayed configuration and accept to save the “remote” + then quit. The config file should look like this + + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3-api.us-geo.objectstorage.softlayer.net + location_constraint = us-standard + acl = private + +13. Execute rclone commands + + 1) Create a bucket. + rclone mkdir IBM-COS-XREGION:newbucket + 2) List available buckets. + rclone lsd IBM-COS-XREGION: + -1 2017-11-08 21:16:22 -1 test + -1 2018-02-14 20:16:39 -1 newbucket + 3) List contents of a bucket. + rclone ls IBM-COS-XREGION:newbucket + 18685952 test.exe + 4) Copy a file from local to remote. + rclone copy /Users/file.txt IBM-COS-XREGION:newbucket + 5) Copy a file from remote to local. + rclone copy IBM-COS-XREGION:newbucket/file.txt . + 6) Delete a file on remote. + rclone delete IBM-COS-XREGION:newbucket/file.txt + +Minio + +Minio is an object storage server built for cloud application developers +and devops. + +It is very easy to install and provides an S3 compatible server which +can be used by rclone. + +To use it, install Minio following the instructions here. + +When it configures itself Minio will print something like this + + Endpoint: http://192.168.1.106:9000 http://172.23.0.1:9000 + AccessKey: USWUXHGYZQYFYFFIT3RE + SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + Region: us-east-1 + SQS ARNs: arn:minio:sqs:us-east-1:1:redis arn:minio:sqs:us-east-1:2:redis + + Browser Access: + http://192.168.1.106:9000 http://172.23.0.1:9000 + + Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide + $ mc config host add myminio http://192.168.1.106:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + + Object API (Amazon S3 compatible): + Go: https://docs.minio.io/docs/golang-client-quickstart-guide + Java: https://docs.minio.io/docs/java-client-quickstart-guide + Python: https://docs.minio.io/docs/python-client-quickstart-guide + JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide + .NET: https://docs.minio.io/docs/dotnet-client-quickstart-guide + + Drive Capacity: 26 GiB Free, 165 GiB Total + +These details need to go into rclone config like this. Note that it is +important to put the region in as stated above. + + env_auth> 1 + access_key_id> USWUXHGYZQYFYFFIT3RE + secret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region> us-east-1 + endpoint> http://192.168.1.106:9000 + location_constraint> + server_side_encryption> + +Which makes the config file look like this + + [minio] + type = s3 + provider = Minio + env_auth = false + access_key_id = USWUXHGYZQYFYFFIT3RE + secret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 + region = us-east-1 + endpoint = http://192.168.1.106:9000 + location_constraint = + server_side_encryption = + +So once set up, for example to copy files into a bucket + + rclone copy /path/to/files minio:bucket + +Scaleway + +Scaleway The Object Storage platform allows you to store anything from +backups, logs and web assets to documents and photos. Files can be +dropped from the Scaleway console or transferred through our API and CLI +or using any S3-compatible tool. + +Scaleway provides an S3 interface which can be configured for use with +rclone like this: + + [scaleway] + type = s3 + env_auth = false + endpoint = s3.nl-ams.scw.cloud + access_key_id = SCWXXXXXXXXXXXXXX + secret_access_key = 1111111-2222-3333-44444-55555555555555 + region = nl-ams + location_constraint = + acl = private + force_path_style = false + server_side_encryption = + storage_class = + +Wasabi + +Wasabi is a cloud-based object storage service for a broad range of +applications and use cases. Wasabi is designed for individuals and +organizations that require a high-performance, reliable, and secure data +storage infrastructure at minimal cost. + +Wasabi provides an S3 interface which can be configured for use with +rclone like this. + + No remotes found - make a new one + n) New remote + s) Set configuration password + n/s> n + name> wasabi + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \ "s3" + [snip] + Storage> s3 + Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. + Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" + env_auth> 1 + AWS Access Key ID - leave blank for anonymous access or runtime credentials. + access_key_id> YOURACCESSKEY + AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. + secret_access_key> YOURSECRETACCESSKEY + Region to connect to. + Choose a number from below, or type in your own value + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + [snip] + region> us-east-1 + Endpoint for S3 API. + Leave blank if using AWS to use the default endpoint for the region. + Specify if using an S3 clone such as Ceph. + endpoint> s3.wasabisys.com + Location constraint - must be set to match the Region. Used when creating buckets only. + Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \ "" + [snip] + location_constraint> + Canned ACL used when creating buckets and/or storing objects in S3. + For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl + Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \ "private" + [snip] + acl> + The server-side encryption algorithm used when storing this object in S3. + Choose a number from below, or type in your own value + 1 / None + \ "" + 2 / AES256 + \ "AES256" + server_side_encryption> + The storage class to use when storing objects in S3. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Standard storage class + \ "STANDARD" + 3 / Reduced redundancy storage class + \ "REDUCED_REDUNDANCY" + 4 / Standard Infrequent Access storage class + \ "STANDARD_IA" + storage_class> + Remote config + -------------------- + [wasabi] + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = us-east-1 + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +This will leave the config file looking like this. + + [wasabi] + type = s3 + provider = Wasabi + env_auth = false + access_key_id = YOURACCESSKEY + secret_access_key = YOURSECRETACCESSKEY + region = + endpoint = s3.wasabisys.com + location_constraint = + acl = + server_side_encryption = + storage_class = + +Alibaba OSS + +Here is an example of making an Alibaba Cloud (Aliyun) OSS +configuration. First run: + + rclone config + +This will guide you through an interactive setup process. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> oss + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) + \ "s3" + [snip] + Storage> s3 + Choose your S3 provider. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \ "AWS" + 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun + \ "Alibaba" + 3 / Ceph Object Storage + \ "Ceph" + [snip] + provider> Alibaba + 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. + +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. + +Here is an example of making a b2 configuration. First run + + rclone config + +This will guide you through an interactive setup process. To +authenticate you will either need your Account ID (a short hex number) +and Master Application Key (a long hex number) OR an Application Key, +which is the recommended method. See below for further details on +generating and using an Application Key. + + No remotes found - make a new one + n) New remote + q) Quit config + n/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Backblaze B2 + \ "b2" + [snip] + Storage> b2 Account ID or Application Key ID - - - Config: account - - Env Var: RCLONE_B2_ACCOUNT - - Type: string - - Default: "" - - #### --b2-key - + account> 123456789abc Application Key + key> 0123456789abcdef0123456789abcdef0123456789 + Endpoint for the service - leave blank normally. + endpoint> + Remote config + -------------------- + [remote] + account = 123456789abc + key = 0123456789abcdef0123456789abcdef0123456789 + endpoint = + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: key - - Env Var: RCLONE_B2_KEY - - Type: string - - Default: "" +This remote is called remote and can now be used like this - #### --b2-hard-delete +See all buckets - Permanently delete files on remote removal, otherwise hide files. + rclone lsd remote: - - Config: hard_delete - - Env Var: RCLONE_B2_HARD_DELETE - - Type: bool - - Default: false +Create a new bucket - ### Advanced Options + rclone mkdir remote:bucket - Here are the advanced options specific to b2 (Backblaze B2). +List the contents of a bucket - #### --b2-endpoint + rclone ls remote:bucket - Endpoint for the service. - Leave blank normally. +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. - - Config: endpoint - - Env Var: RCLONE_B2_ENDPOINT - - Type: string - - Default: "" + rclone sync /home/local/directory remote:bucket - #### --b2-test-mode +Application Keys - A flag string for X-Bz-Test-Mode header for debugging. +B2 supports multiple Application Keys for different access permission to +B2 Buckets. - This is for debugging purposes only. Setting it to one of the strings - below will cause b2 to return specific errors: +You can use these with rclone too; you will need to use rclone version +1.43 or later. - * "fail_some_uploads" - * "expire_some_account_authorization_tokens" - * "force_cap_exceeded" +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. - 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). +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. - - Config: test_mode - - Env Var: RCLONE_B2_TEST_MODE - - Type: string - - Default: "" +–fast-list - #### --b2-versions +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. - 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. +Modified time - - Config: versions - - Env Var: RCLONE_B2_VERSIONS - - Type: bool - - Default: false +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. - #### --b2-upload-cutoff +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. - Cutoff for switching to chunked upload. +Restricted filename characters - Files above this size will be uploaded in chunks of "--b2-chunk-size". +In addition to the default restricted characters set the following +characters are also replaced: - This value should be set no larger than 4.657GiB (== 5GB). + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ - - Config: upload_cutoff - - Env Var: RCLONE_B2_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 200M +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. - #### --b2-chunk-size +SHA1 checksums - Upload chunk size. Must fit in memory. +The SHA1 checksums of the files are checked on upload and download and +will be used in the syncing process. - 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. +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. - - Config: chunk_size - - Env Var: RCLONE_B2_CHUNK_SIZE - - Type: SizeSuffix - - Default: 96M +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. - #### --b2-disable-checksum +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). - Disable checksums for large (> upload cutoff) files +Files sizes below --b2-upload-cutoff will always have an SHA1 regardless +of the source. - - Config: disable_checksum - - Env Var: RCLONE_B2_DISABLE_CHECKSUM - - Type: bool - - Default: false +Transfers - #### --b2-download-url +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. - Custom endpoint for downloads. +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. - 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. +Versions - - Config: download_url - - Env Var: RCLONE_B2_DOWNLOAD_URL - - Type: string - - Default: "" +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. - #### --b2-download-auth-duration +Old versions of files, where available, are visible using the +--b2-versions flag. - Time before the authorization token will expire in s or suffix ms|s|m|h|d. +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. - The duration before the download authorization token will expire. - The minimum value is 1 second. The maximum value is one week. +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. - - Config: download_auth_duration - - Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION - - Type: Duration - - Default: 1w +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. - Box - ----------------------------------------- +However delete will cause the current versions of the files to become +hidden old versions. - Paths are specified as `remote:path` +Here is a session showing the listing and retrieval of an old version +followed by a cleanup of the old versions. - Paths may be as deep as required, eg `remote:directory/subdirectory`. +Show current version and all the versions with --b2-versions flag. - 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. + $ rclone -q ls b2:cleanup-test + 9 one.txt - Here is an example of how to make a remote called `remote`. First run: + $ 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 - rclone config +Retrieve an old version - This will guide you through an interactive setup process: + $ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Box  “box” [snip] Storage> box Box App Client Id - leave blank -normally. client_id> Box App Client Secret - leave blank normally. -client_secret> Box App config.json location Leave blank normally. Enter -a string value. Press Enter for the default ("“). config_json> -‘enterprise’ or ‘user’ depending on the type of token being requested. -Enter a string value. Press Enter for the default (”user“). -box_sub_type> Remote config Use auto config? * Say Y if not sure * Say N -if you are working on a remote or headless machine y) Yes n) No y/n> y -If your browser doesn’t open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code… Got code ——————– [remote] client_id = client_secret = -token = -{”access_token“:”XXX“,”token_type“:”bearer“,”refresh_token“:”XXX“,”expiry“:”XXX"} -——————– y) Yes this is OK e) Edit this remote d) Delete this remote -y/e/d> y + $ 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. - 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 -q cleanup b2:cleanup-test - 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. + $ rclone -q ls b2:cleanup-test + 9 one.txt - Once configured you can then use `rclone` like this, + $ rclone -q --b2-versions ls b2:cleanup-test + 9 one.txt - List directories in top level of your Box +Data usage - rclone lsd remote: +It is useful to know how many requests are sent to the server in +different scenarios. - List all the files in your Box +All copy commands send the following 4 requests: - rclone ls remote: + /b2api/v1/b2_authorize_account + /b2api/v1/b2_create_bucket + /b2api/v1/b2_list_buckets + /b2api/v1/b2_list_file_names - To copy a local directory to an Box directory called backup +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. - rclone copy /home/source remote:backup +Uploading files that do not require chunking, will send 2 requests per +file upload: - ### Using rclone with an Enterprise account with SSO ### + /b2api/v1/b2_get_upload_url + /b2api/v1/b2_upload_file/ - 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. +Uploading files requiring chunking, will send 2 requests (one each to +start and finish the upload) and another 2 requests for each chunk: - 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. + /b2api/v1/b2_start_large_file + /b2api/v1/b2_get_upload_part_url + /b2api/v1/b2_upload_part/ + /b2api/v1/b2_finish_large_file - ### Invalid refresh token ### +Versions - According to the [box docs](https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): +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 - > Each refresh_token is valid for one use in 60 days. +Listing without --b2-versions - This means that if you + $ rclone -q ls b2:cleanup-test + 9 one.txt - * 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 +And with - then rclone will return an error which includes the text `Invalid - refresh token`. + $ 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 - 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. +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. - Here is how to do it. +Note that when using --b2-versions no file write operations are +permitted, so you can’t upload files or delete them. -$ rclone config Current remotes: +B2 and rclone link -Name Type ==== ==== remote box +Rclone supports generating file share links for private B2 buckets. They +can either be for a file for example: -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? + ./rclone link B2:bucket/path/to/file.txt + https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx -- Say Y if not sure -- Say N if you are working on a remote or headless machine +or if run on a directory you will get: -y) Yes -z) No y/n> y If your browser doesn’t open automatically go to the - following link: http://127.0.0.1:53682/auth Log in and authorize - rclone for access Waiting for code… Got code ——————– [remote] type = - box token = - {“access_token”:“YYY”,“token_type”:“bearer”,“refresh_token”:“YYY”,“expiry”:“2017-07-23T12:22:29.259137901+01:00”} - ——————– -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y + ./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: - ### Modified time and hashes ### + 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 - 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. +Standard Options - Box supports SHA1 type hashes, so you can use the `--checksum` - flag. +Here are the standard options specific to b2 (Backblaze B2). - #### Restricted filename characters +–b2-account - In addition to the [default restricted characters set](/overview/#restricted-characters) - the following characters are also replaced: +Account ID or Application Key ID - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \ | 0x5C | ＼ | +- Config: account +- Env Var: RCLONE_B2_ACCOUNT +- Type: string +- Default: "" - File names can also not end with the following characters. - These only get replaced if they are last character in the name: +–b2-key - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +Application Key - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. +- Config: key +- Env Var: RCLONE_B2_KEY +- Type: string +- Default: "" - ### Transfers ### +–b2-hard-delete - 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. +Permanently delete files on remote removal, otherwise hide files. - ### Deleting files ### +- Config: hard_delete +- Env Var: RCLONE_B2_HARD_DELETE +- Type: bool +- Default: false - Depending on the enterprise settings for your user, the item will - either be actually deleted from Box or moved to the trash. +Advanced Options - - ### Standard Options +Here are the advanced options specific to b2 (Backblaze B2). - Here are the standard options specific to box (Box). +–b2-endpoint - #### --box-client-id +Endpoint for the service. Leave blank normally. - Box App Client Id. - Leave blank normally. +- Config: endpoint +- Env Var: RCLONE_B2_ENDPOINT +- Type: string +- Default: "" - - Config: client_id - - Env Var: RCLONE_BOX_CLIENT_ID - - Type: string - - Default: "" +–b2-test-mode - #### --box-client-secret +A flag string for X-Bz-Test-Mode header for debugging. - Box App Client Secret - Leave blank normally. +This is for debugging purposes only. Setting it to one of the strings +below will cause b2 to return specific errors: - - Config: client_secret - - Env Var: RCLONE_BOX_CLIENT_SECRET - - Type: string - - Default: "" +- “fail_some_uploads” +- “expire_some_account_authorization_tokens” +- “force_cap_exceeded” - #### --box-box-config-file +These will be set in the “X-Bz-Test-Mode” header which is documented in +the b2 integrations checklist. +- Config: test_mode +- Env Var: RCLONE_B2_TEST_MODE +- Type: string +- Default: "" + +–b2-versions + +Include old versions in directory listings. Note that when using this no +file write operations are permitted, so you can’t upload files or delete +them. + +- Config: versions +- Env Var: RCLONE_B2_VERSIONS +- Type: bool +- Default: false + +–b2-upload-cutoff + +Cutoff for switching to chunked upload. + +Files above this size will be uploaded in chunks of “–b2-chunk-size”. + +This value should be set no larger than 4.657GiB (== 5GB). + +- Config: upload_cutoff +- Env Var: RCLONE_B2_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 200M + +–b2-chunk-size + +Upload chunk size. Must fit in memory. + +When uploading large files, chunk the file into this size. Note that +these chunks are buffered in memory and there might a maximum of +“–transfers” chunks in progress at once. 5,000,000 Bytes is the minimum +size. + +- Config: chunk_size +- Env Var: RCLONE_B2_CHUNK_SIZE +- Type: SizeSuffix +- Default: 96M + +–b2-disable-checksum + +Disable checksums for large (> upload cutoff) files + +- Config: disable_checksum +- Env Var: RCLONE_B2_DISABLE_CHECKSUM +- Type: bool +- Default: false + +–b2-download-url + +Custom endpoint for downloads. + +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. This is +probably only useful for a public bucket. Leave blank if you want to use +the endpoint provided by Backblaze. + +- Config: download_url +- Env Var: RCLONE_B2_DOWNLOAD_URL +- Type: string +- Default: "" + +–b2-download-auth-duration + +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. + +The duration before the download authorization token will expire. The +minimum value is 1 second. The maximum value is one week. + +- Config: download_auth_duration +- Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +- Type: Duration +- Default: 1w + +–b2-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_B2_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + + +Box + +Paths are specified as remote:path + +Paths may be as deep as required, eg remote:directory/subdirectory. + +The initial setup for Box involves getting a token from Box which you +can do either in your browser, or with a config.json downloaded from Box +to use JWT authentication. rclone config walks you through it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Box + \ "box" + [snip] + Storage> box + Box App Client Id - leave blank normally. + client_id> + Box App Client Secret - leave blank normally. + client_secret> Box App config.json location Leave blank normally. + Enter a string value. Press Enter for the default (""). + config_json> + 'enterprise' or 'user' depending on the type of token being requested. + Enter a string value. Press Enter for the default ("user"). + box_sub_type> + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + client_id = + client_secret = + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs 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: box_config_file - - Env Var: RCLONE_BOX_BOX_CONFIG_FILE - - 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: - ### Advanced Options + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ - Here are the advanced options specific to box (Box). +File names can also not end with the following characters. These only +get replaced if they are last character in the name: - #### --box-upload-cutoff + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ - Cutoff for switching to multipart upload (>= 50MB). +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. - - Config: upload_cutoff - - Env Var: RCLONE_BOX_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 50M +Transfers - #### --box-commit-retries +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. - Max number of times to try committing a multipart file. +Deleting files - - Config: commit_retries - - Env Var: RCLONE_BOX_COMMIT_RETRIES - - Type: int - - Default: 100 +Depending on the enterprise settings for your user, the item will either +be actually deleted from Box or moved to the trash. - +Standard Options - ### Limitations ### +Here are the standard options specific to box (Box). - Note that Box is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". +–box-client-id - Box file names can't have the `\` character in. rclone maps this to - and from an identical looking unicode equivalent `＼`. +Box App Client Id. Leave blank normally. - Box only supports filenames up to 255 characters in length. +- Config: client_id +- Env Var: RCLONE_BOX_CLIENT_ID +- Type: string +- Default: "" - Cache (BETA) - ----------------------------------------- +–box-client-secret - The `cache` remote wraps another existing remote and stores file structure - and its data for long running tasks like `rclone mount`. +Box App Client Secret Leave blank normally. - To get started you just need to have an existing remote which can be configured - with `cache`. +- Config: client_secret +- Env Var: RCLONE_BOX_CLIENT_SECRET +- Type: string +- Default: "" - Here is an example of how to make a remote called `test-cache`. First run: +–box-box-config-file - rclone config +Box App config.json location Leave blank normally. - This will guide you through an interactive setup process: +- Config: box_config_file +- Env Var: RCLONE_BOX_BOX_CONFIG_FILE +- Type: string +- Default: "" -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -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 +–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 - You can then use it like this, +Advanced Options - List directories in top level of your drive +Here are the advanced options specific to box (Box). - rclone lsd test-cache: +–box-upload-cutoff - List all the files in your drive +Cutoff for switching to multipart upload (>= 50MB). - rclone ls test-cache: +- Config: upload_cutoff +- Env Var: RCLONE_BOX_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 50M - To start a cached mount +–box-commit-retries - rclone mount --allow-other test-cache: /var/tmp/test-cache +Max number of times to try committing a multipart file. - ### Write Features ### +- Config: commit_retries +- Env Var: RCLONE_BOX_COMMIT_RETRIES +- Type: int +- Default: 100 - ### Offline uploading ### +–box-encoding - 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`. +This sets the encoding for the backend. - A files goes through these states when using this feature: +See: the encoding section in the overview for more info. - 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) +- Config: encoding +- Env Var: RCLONE_BOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot - 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. +Limitations - ### Write Support ### +Note that Box is case insensitive so you can’t have a file called +“Hello.doc” and one called “hello.doc”. - 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. +Box file names can’t have the \ character in. rclone maps this to and +from an identical looking unicode equivalent ＼. - 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. +Box only supports filenames up to 255 characters in length. - ### Read Features ### - #### Multiple connections #### +Cache (BETA) - 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. +The cache remote wraps another existing remote and stores file structure +and its data for long running tasks like rclone mount. - 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. +To get started you just need to have an existing remote which can be +configured with cache. - #### Plex Integration #### +Here is an example of how to make a remote called test-cache. First run: - 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. + rclone config - Scans will have a minimum amount of workers (1) while in a confirmed playback cache - will deploy the configured number of workers. - - This integration opens the doorway to additional performance improvements - which will be explored in the near future. - - **Note:** If Plex options are not configured, `cache` will function with its - configured options without adapting any of its settings. - - How to enable? Run `rclone config` and add all the Plex options (endpoint, username - and password) in your remote and it will be automatically enabled. - - Affected settings: - - `cache-workers`: _Configured value_ during confirmed playback or _1_ all the other times - - ##### Certificate Validation ##### - - When the Plex server is configured to only accept secure connections, it is - possible to use `.plex.direct` URL's to ensure certificate validation succeeds. - These URL's are used by Plex internally to connect to the Plex server securely. - - The format for this URL's is the following: - - https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - - The `ip-with-dots-replaced` part can be any IPv4 address, where the dots - have been replaced with dashes, e.g. `127.0.0.1` becomes `127-0-0-1`. - - To get the `server-hash` part, the easiest way is to visit - - https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - - This page will list all the available Plex servers for your account - with at least one `.plex.direct` link for each. Copy one URL and replace - the IP address with the desired address. This can be used as the - `plex_url` value. - - ### Known issues ### - - #### Mount and --dir-cache-time #### - - --dir-cache-time controls the first layer of directory caching which works at the mount layer. - Being an independent caching mechanism from the `cache` backend, it will manage its own entries - based on the configured time. - - To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct - one, try to set `--dir-cache-time` to a lower time than `--cache-info-age`. Default values are - already configured in this way. - - #### Windows support - Experimental #### - - There are a couple of issues with Windows `mount` functionality that still require some investigations. - It should be considered as experimental thus far as fixes come in for this OS. - - Most of the issues seem to be related to the difference between filesystems - on Linux flavors and Windows as cache is heavily dependant on them. - - Any reports or feedback on how cache behaves on this OS is greatly appreciated. - - - https://github.com/rclone/rclone/issues/1935 - - https://github.com/rclone/rclone/issues/1907 - - https://github.com/rclone/rclone/issues/1834 - - #### Risk of throttling #### - - Future iterations of the cache backend will make use of the pooling functionality - of the cloud provider to synchronize and at the same time make writing through it - more tolerant to failures. - - There are a couple of enhancements in track to add these but in the meantime - there is a valid concern that the expiring cache listings can lead to cloud provider - throttles or bans due to repeated queries on it for very large mounts. - - Some recommendations: - - don't use a very small interval for entry informations (`--cache-info-age`) - - while writes aren't yet optimised, you can still write through `cache` which gives you the advantage - of adding the file in the cache at the same time if configured to do so. - - Future enhancements: - - - https://github.com/rclone/rclone/issues/1937 - - https://github.com/rclone/rclone/issues/1936 - - #### cache and crypt #### - - One common scenario is to keep your data encrypted in the cloud provider - using the `crypt` remote. `crypt` uses a similar technique to wrap around - an existing remote and handles this translation in a seamless way. - - There is an issue with wrapping the remotes in this order: - **cloud remote** -> **crypt** -> **cache** - - During testing, I experienced a lot of bans with the remotes in this order. - I suspect it might be related to how crypt opens files on the cloud provider - which makes it think we're downloading the full file instead of small chunks. - Organizing the remotes in this order yields better results: - **cloud remote** -> **cache** -> **crypt** - - #### absolute remote paths #### - - `cache` can not differentiate between relative and absolute paths for the wrapped remote. - Any path given in the `remote` config setting and on the command line will be passed to - the wrapped remote as is, but for storing the chunks on disk the path will be made - relative by removing any leading `/` character. - - This behavior is irrelevant for most backend types, but there are backends where a leading `/` - changes the effective directory, e.g. in the `sftp` backend paths starting with a `/` are - relative to the root of the SSH server and paths without are relative to the user home directory. - As a result `sftp:bin` and `sftp:/bin` will share the same cache folder, even if they represent - a different directory on the SSH server. - - ### Cache and Remote Control (--rc) ### - Cache supports the new `--rc` mode in rclone and can be remote controlled through the following end points: - By default, the listener is disabled if you do not add the flag. - - ### rc cache/expire - Purge a remote from the cache backend. Supports either a directory or a file. - It supports both encrypted and unencrypted file names if cache is wrapped by crypt. - - Params: - - **remote** = path to remote **(required)** - - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - - - ### Standard Options - - Here are the standard options specific to cache (Cache a remote). - - #### --cache-remote +This will guide you through an interactive setup process: + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> test-cache + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Cache a remote + \ "cache" + [snip] + Storage> cache Remote to cache. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). + remote> local:/test + Optional: The URL of the Plex server + plex_url> http://127.0.0.1:32400 + Optional: The username of the Plex user + plex_username> dummyusername + Optional: The password of the Plex user + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank + y/g/n> y + Enter the password: + password: + Confirm the password: + password: + The size of a chunk. Lower value good for slow connections but can affect seamless reading. + Default: 5M + Choose a number from below, or type in your own value + 1 / 1MB + \ "1m" + 2 / 5 MB + \ "5M" + 3 / 10 MB + \ "10M" + chunk_size> 2 + How much time should object info (file size, file hashes etc) be stored in cache. Use a very high value if you don't plan on changing the source FS from outside the cache. + Accepted units are: "s", "m", "h". + Default: 5m + Choose a number from below, or type in your own value + 1 / 1 hour + \ "1h" + 2 / 24 hours + \ "24h" + 3 / 24 hours + \ "48h" + info_age> 2 + The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted. + Default: 10G + Choose a number from below, or type in your own value + 1 / 500 MB + \ "500M" + 2 / 1 GB + \ "1G" + 3 / 10 GB + \ "10G" + chunk_total_size> 3 + Remote config + -------------------- + [test-cache] + remote = local:/test + plex_url = http://127.0.0.1:32400 + plex_username = dummyusername + plex_password = *** ENCRYPTED *** + chunk_size = 5M + info_age = 48h + chunk_total_size = 10G + +You can then use it like this, + +List directories in top level of your drive + + rclone lsd test-cache: + +List all the files in your drive + + rclone ls test-cache: + +To start a cached mount + + rclone mount --allow-other test-cache: /var/tmp/test-cache + +Write Features + +Offline uploading + +In an effort to make writing through cache more reliable, the backend +now supports this feature which can be activated by specifying a +cache-tmp-upload-path. + +A files goes through these states when using this feature: + +1. An upload is started (usually by copying a file on the cache remote) +2. When the copy to the temporary location is complete the file is part + of the cached remote and looks and behaves like any other file + (reading included) +3. After cache-tmp-wait-time passes and the file is next in line, + rclone move is used to move the file to the cloud provider +4. Reading the file still works during the upload but most + modifications on it will be prohibited +5. Once the move is complete the file is unlocked for modifications as + it becomes as any other regular file +6. If the file is being read through cache when it’s actually deleted + from the temporary path then cache will simply swap the source to + the cloud provider without interrupting the reading (small blip can + happen though) + +Files are uploaded in sequence and only one file is uploaded at a time. +Uploads will be stored in a queue and be processed based on the order +they were added. The queue and the temporary storage is persistent +across restarts but can be cleared on startup with the --cache-db-purge +flag. + +Write Support + +Writes are supported through cache. One caveat is that a mounted cache +remote does not add any retry or fallback mechanism to the upload +operation. This will depend on the implementation of the wrapped remote. +Consider using Offline uploading for reliable writes. + +One special case is covered with cache-writes which will cache the file +data at the same time as the upload when it is enabled making it +available from the cache store immediately once the upload is finished. + +Read Features + +Multiple connections + +To counter the high latency between a local PC where rclone is running +and cloud providers, the cache remote can split multiple requests to the +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. - - Config: remote - - Env Var: RCLONE_CACHE_REMOTE - - Type: string - - Default: "" +This is similar to buffering when media files are played online. Rclone +will stay around the current marker but always try its best to stay +ahead and prepare the data before. - #### --cache-plex-url +Plex Integration - The URL of the Plex server +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. This helps cache to +adapt how it queries the cloud provider depending on what is needed for. - - Config: plex_url - - Env Var: RCLONE_CACHE_PLEX_URL - - Type: string - - Default: "" +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. - #### --cache-plex-username +This integration opens the doorway to additional performance +improvements which will be explored in the near future. - The username of the Plex user +NOTE: If Plex options are not configured, cache will function with its +configured options without adapting any of its settings. - - Config: plex_username - - Env Var: RCLONE_CACHE_PLEX_USERNAME - - Type: string - - Default: "" +How to enable? Run rclone config and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. - #### --cache-plex-password +Affected settings: - cache-workers: _Configured value_ during confirmed +playback or _1_ all the other times - The password of the Plex user +Certificate Validation - - Config: plex_password - - Env Var: RCLONE_CACHE_PLEX_PASSWORD - - Type: string - - Default: "" +When the Plex server is configured to only accept secure connections, it +is possible to use .plex.direct URL’s to ensure certificate validation +succeeds. These URL’s are used by Plex internally to connect to the Plex +server securely. - #### --cache-chunk-size +The format for this URL’s is the following: - The size of a chunk (partial file data). +https://ip-with-dots-replaced.server-hash.plex.direct:32400/ - 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. +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. - - Config: chunk_size - - Env Var: RCLONE_CACHE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 5M - - Examples: - - "1m" - - 1MB - - "5M" - - 5 MB - - "10M" - - 10 MB +To get the server-hash part, the easiest way is to visit - #### --cache-info-age +https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token - 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. +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. - - Config: info_age - - Env Var: RCLONE_CACHE_INFO_AGE - - Type: Duration - - Default: 6h0m0s - - Examples: - - "1h" - - 1 hour - - "24h" - - 24 hours - - "48h" - - 48 hours +Known issues - #### --cache-chunk-total-size +Mount and –dir-cache-time - The total size that the chunks can take up on the local disk. +–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. - If the cache exceeds this value then it will start to delete the - oldest chunks until it goes under this value. +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. - - 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 +Windows support - Experimental - ### Advanced Options +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. - Here are the advanced options specific to cache (Cache a remote). +Most of the issues seem to be related to the difference between +filesystems on Linux flavors and Windows as cache is heavily dependant +on them. - #### --cache-plex-token +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. - The plex token for authentication - auto set normally +- https://github.com/rclone/rclone/issues/1935 +- https://github.com/rclone/rclone/issues/1907 +- https://github.com/rclone/rclone/issues/1834 - - Config: plex_token - - Env Var: RCLONE_CACHE_PLEX_TOKEN - - Type: string - - Default: "" +Risk of throttling - #### --cache-plex-insecure +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. - Skip all certificate verifications when connecting to the Plex server +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. - - Config: plex_insecure - - Env Var: RCLONE_CACHE_PLEX_INSECURE - - Type: string - - Default: "" +Some recommendations: - don’t use a very small interval for entry +informations (--cache-info-age) - while writes aren’t yet optimised, you +can still write through cache which gives you the advantage of adding +the file in the cache at the same time if configured to do so. - #### --cache-db-path +Future enhancements: - Directory to store file structure metadata DB. - The remote name is used as the DB file name. +- https://github.com/rclone/rclone/issues/1937 +- https://github.com/rclone/rclone/issues/1936 - - Config: db_path - - Env Var: RCLONE_CACHE_DB_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +cache and crypt - #### --cache-chunk-path +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. - Directory to cache chunk files. +There is an issue with wrapping the remotes in this order: CLOUD REMOTE +-> CRYPT -> CACHE - Path to where partial file data (chunks) are stored locally. The remote - name is appended to the final path. +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 - 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". +absolute remote paths - - Config: chunk_path - - Env Var: RCLONE_CACHE_CHUNK_PATH - - Type: string - - Default: "$HOME/.cache/rclone/cache-backend" +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. - #### --cache-db-purge +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. - Clear all the cached data for this remote on start. +Cache and Remote Control (–rc) - - Config: db_purge - - Env Var: RCLONE_CACHE_DB_PURGE - - Type: bool - - Default: false +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. - #### --cache-chunk-clean-interval +rc cache/expire - 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. +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. - - Config: chunk_clean_interval - - Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL - - Type: Duration - - Default: 1m0s +Params: - REMOTE = path to remote (REQUIRED) - WITHDATA = true/false to +delete cached data (chunks) as well _(optional, false by default)_ - #### --cache-read-retries +Standard Options - How many times to retry a read from a cache storage. +Here are the standard options specific to cache (Cache a 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. +–cache-remote - For really slow connections, increase this to a point where the stream is - able to provide data but your experience will be very stuttering. +Remote to cache. Normally should contain a ‘:’ and a path, eg +“myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not +recommended). - - Config: read_retries - - Env Var: RCLONE_CACHE_READ_RETRIES - - Type: int - - Default: 10 +- Config: remote +- Env Var: RCLONE_CACHE_REMOTE +- Type: string +- Default: "" - #### --cache-workers +–cache-plex-url - How many workers should run in parallel to download chunks. +The URL of the Plex server - 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. +- Config: plex_url +- Env Var: RCLONE_CACHE_PLEX_URL +- Type: string +- Default: "" - **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. +–cache-plex-username - - Config: workers - - Env Var: RCLONE_CACHE_WORKERS - - Type: int - - Default: 4 +The username of the Plex user - #### --cache-chunk-no-memory +- Config: plex_username +- Env Var: RCLONE_CACHE_PLEX_USERNAME +- Type: string +- Default: "" - Disable the in-memory cache for storing chunks during streaming. +–cache-plex-password - By default, cache will keep file data during streaming in RAM as well - to provide it to readers as fast as possible. +The password of the Plex user - 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 verifications 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 - - - - Chunker (BETA) - ---------------------------------------- - - The `chunker` overlay transparently splits large files into smaller chunks - during upload to wrapped remote and transparently assembles them back - when the file is downloaded. This allows to effectively overcome size limits - imposed by storage providers. - - To use it, first set up the underlying remote following the configuration - instructions for that remote. You can also use a local pathname instead of - a remote. - - First check your chosen remote is working - we'll call it `remote:path` here. - Note that anything inside `remote:path` will be chunked and anything outside - won't. This means that if you are using a bucket based remote (eg S3, B2, swift) - then you should probably put the bucket in the remote `s3:bucket`. - - Now configure `chunker` using `rclone config`. We will call this one `overlay` - to separate it from the `remote` itself. - -No remotes found - make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. Choose a number from below, or type in your own value [snip] -XX / Transparently chunk/split large files  “chunker” [snip] Storage> -chunker Remote to chunk/unchunk. Normally should contain a ‘:’ and a -path, eg “myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” -(not recommended). Enter a string value. Press Enter for the default -("“). remote> remote:path Files larger than chunk size will be split in -chunks. Enter a size with suffix k,M,G,T. Press Enter for the default -(”2G“). chunk_size> 100M Choose how chunker handles hash sums. All modes -but”none" require metadata. Enter a string value. Press Enter for the -default (“md5”). Choose a number from below, or type in your own value 1 -/ Pass any hash supported by wrapped remote for non-chunked files, -return nothing otherwise  “none” 2 / MD5 for composite files  “md5” 3 / -SHA1 for composite files  “sha1” 4 / MD5 for all files  “md5all” 5 / -SHA1 for all files  “sha1all” 6 / Copying a file to chunker will request -MD5 from the source falling back to SHA1 if unsupported  “md5quick” 7 / -Similar to “md5quick” but prefers SHA1 over MD5  “sha1quick” hash_type> -md5 Edit advanced config? (y/n) y) Yes n) No y/n> n Remote config -——————– [overlay] type = chunker remote = remote:bucket chunk_size = -100M hash_type = md5 ——————– y) Yes this is OK e) Edit this remote d) -Delete this remote y/e/d> y - - - ### Specifying the remote - - In normal use, make sure the remote has a `:` in. If you specify the remote - without a `:` then rclone will use a local directory of that name. - So if you use a remote of `/path/to/secret/files` then rclone will - chunk stuff in that directory. If you use a remote of `name` then rclone - will put files in a directory called `name` in the current directory. - - - ### Chunking - - When rclone starts a file upload, chunker checks the file size. If it - doesn't exceed the configured chunk size, chunker will just pass the file - to the wrapped remote. If a file is large, chunker will transparently cut - data in pieces with temporary names and stream them one by one, on the fly. - Each data chunk will contain the specified number of bytes, except for the - last one which may have less data. If file size is unknown in advance - (this is called a streaming upload), chunker will internally create - a temporary copy, record its size and repeat the above process. - - When upload completes, temporary chunk files are finally renamed. - This scheme guarantees that operations can be run in parallel and look - from outside as atomic. - A similar method with hidden temporary chunks is used for other operations - (copy/move/rename etc). If an operation fails, hidden chunks are normally - destroyed, and the target composite file stays intact. - - When a composite file download is requested, chunker transparently - assembles it by concatenating data chunks in order. As the split is trivial - one could even manually concatenate data chunks together to obtain the - original content. - - When the `list` rclone command scans a directory on wrapped remote, - the potential chunk files are accounted for, grouped and assembled into - composite directory entries. Any temporary chunks are hidden. - - List and other commands can sometimes come across composite files with - missing or invalid chunks, eg. shadowed by like-named directory or - another file. This usually means that wrapped file system has been directly - tampered with or damaged. If chunker detects a missing chunk it will - by default print warning, skip the whole incomplete group of chunks but - proceed with current command. - You can set the `--chunker-fail-hard` flag to have commands abort with - error message in such cases. - - - #### Chunk names - - The default chunk name format is `*.rclone-chunk.###`, hence by default - chunk names are `BIG_FILE_NAME.rclone-chunk.001`, - `BIG_FILE_NAME.rclone-chunk.002` etc. You can configure a different name - format using the `--chunker-name-format` option. The format uses asterisk - `*` as a placeholder for the base file name and one or more consecutive - hash characters `#` as a placeholder for sequential chunk number. - There must be one and only one asterisk. The number of consecutive hash - characters defines the minimum length of a string representing a chunk number. - If decimal chunk number has less digits than the number of hashes, it is - left-padded by zeros. If the decimal string is longer, it is left intact. - By default numbering starts from 1 but there is another option that allows - user to start from 0, eg. for compatibility with legacy software. - - For example, if name format is `big_*-##.part` and original file name is - `data.txt` and numbering starts from 0, then the first chunk will be named - `big_data.txt-00.part`, the 99th chunk will be `big_data.txt-98.part` - and the 302nd chunk will become `big_data.txt-301.part`. - - Note that `list` assembles composite directory entries only when chunk names - match the configured format and treats non-conforming file names as normal - non-chunked files. - - - ### Metadata - - Besides data chunks chunker will by default create metadata object for - a composite file. The object is named after the original file. - Chunker allows user to disable metadata completely (the `none` format). - Note that metadata is normally not created for files smaller than the - configured chunk size. This may change in future rclone releases. - - #### Simple JSON metadata format - - This is the default format. It supports hash sums and chunk validation - for composite files. Meta objects carry the following fields: - - - `ver` - version of format, currently `1` - - `size` - total size of composite file - - `nchunks` - number of data chunks in file - - `md5` - MD5 hashsum of composite file (if present) - - `sha1` - SHA1 hashsum (if present) - - There is no field for composite file name as it's simply equal to the name - of meta object on the wrapped remote. Please refer to respective sections - for details on hashsums and modified time handling. - - #### No metadata - - You can disable meta objects by setting the meta format option to `none`. - In this mode chunker will scan directory for all files that follow - configured chunk name format, group them by detecting chunks with the same - base name and show group names as virtual composite files. - This method is more prone to missing chunk errors (especially missing - last chunk) than format with metadata enabled. - - - ### Hashsums - - Chunker supports hashsums only when a compatible metadata is present. - Hence, if you choose metadata format of `none`, chunker will report hashsum - as `UNSUPPORTED`. - - Please note that by default metadata is stored only for composite files. - If a file is smaller than configured chunk size, chunker will transparently - redirect hash requests to wrapped remote, so support depends on that. - You will see the empty string as a hashsum of requested type for small - files if the wrapped remote doesn't support it. - - Many storage backends support MD5 and SHA1 hash types, so does chunker. - With chunker you can choose one or another but not both. - MD5 is set by default as the most supported type. - Since chunker keeps hashes for composite files and falls back to the - wrapped remote hash for non-chunked ones, we advise you to choose the same - hash type as supported by wrapped remote so that your file listings - look coherent. - - If your storage backend does not support MD5 or SHA1 but you need consistent - file hashing, configure chunker with `md5all` or `sha1all`. These two modes - guarantee given hash for all files. If wrapped remote doesn't support it, - chunker will then add metadata to all files, even small. However, this can - double the amount of small files in storage and incur additional service charges. - - Normally, when a file is copied to chunker controlled remote, chunker - will ask the file source for compatible file hash and revert to on-the-fly - calculation if none is found. This involves some CPU overhead but provides - a guarantee that given hashsum is available. Also, chunker will reject - a server-side copy or move operation if source and destination hashsum - types are different resulting in the extra network bandwidth, too. - In some rare cases this may be undesired, so chunker provides two optional - choices: `sha1quick` and `md5quick`. If the source does not support primary - hash type and the quick mode is enabled, chunker will try to fall back to - the secondary type. This will save CPU and bandwidth but can result in empty - hashsums at destination. Beware of consequences: the `sync` command will - revert (sometimes silently) to time/size comparison if compatible hashsums - between source and target are not found. - - - ### Modified time - - Chunker stores modification times using the wrapped remote so support - depends on that. For a small non-chunked file the chunker overlay simply - manipulates modification time of the wrapped remote file. - For a composite file with metadata chunker will get and set - modification time of the metadata object on the wrapped remote. - If file is chunked but metadata format is `none` then chunker will - use modification time of the first data chunk. - - - ### Migrations - - The idiomatic way to migrate to a different chunk size, hash type or - chunk naming scheme is to: - - - Collect all your chunked files under a directory and have your - chunker remote point to it. - - Create another directory (most probably on the same cloud storage) - and configure a new remote with desired metadata format, - hash type, chunk naming etc. - - Now run `rclone sync oldchunks: newchunks:` and all your data - will be transparently converted in transfer. - This may take some time, yet chunker will try server-side - copy if possible. - - After checking data integrity you may remove configuration section - of the old remote. - - If rclone gets killed during a long operation on a big composite file, - hidden temporary chunks may stay in the directory. They will not be - shown by the `list` command but will eat up your account quota. - Please note that the `deletefile` command deletes only active - chunks of a file. As a workaround, you can use remote of the wrapped - file system to see them. - An easy way to get rid of hidden garbage is to copy littered directory - somewhere using the chunker remote and purge the original directory. - The `copy` command will copy only active chunks while the `purge` will - remove everything including garbage. - - - ### Caveats and Limitations - - Chunker requires wrapped remote to support server side `move` (or `copy` + - `delete`) operations, otherwise it will explicitly refuse to start. - This is because it internally renames temporary chunk files to their final - names when an operation completes successfully. - - Note that a move implemented using the copy-and-delete method may incur - double charging with some cloud storage providers. - - Chunker will not automatically rename existing chunks when you run - `rclone config` on a live remote and change the chunk name format. - Beware that in result of this some files which have been treated as chunks - before the change can pop up in directory listings as normal files - and vice versa. The same warning holds for the chunk size. - If you desperately need to change critical chunking setings, you should - run data migration as described above. - - If wrapped remote is case insensitive, the chunker overlay will inherit - that property (so you can't have a file called "Hello.doc" and "hello.doc" - in the same directory). - - - - ### Standard Options - - Here are the standard options specific to chunker (Transparently chunk/split large files). - - #### --chunker-remote +–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 + + +Chunker (BETA) + +The chunker overlay transparently splits large files into smaller chunks +during upload to wrapped remote and transparently assembles them back +when the file is downloaded. This allows to effectively overcome size +limits imposed by storage providers. + +To use it, first set up the underlying remote following the +configuration instructions for that remote. You can also use a local +pathname instead of a remote. + +First check your chosen remote is working - we’ll call it remote:path +here. Note that anything inside remote:path will be chunked and anything +outside won’t. This means that if you are using a bucket based remote +(eg S3, B2, swift) then you should probably put the bucket in the remote +s3:bucket. + +Now configure chunker using rclone config. We will call this one overlay +to separate it from the remote itself. + + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> overlay + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Transparently chunk/split large files + \ "chunker" + [snip] + Storage> chunker Remote to chunk/unchunk. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CHUNKER_REMOTE - - Type: string - - Default: "" - - #### --chunker-chunk-size - + Enter a string value. Press Enter for the default (""). + remote> remote:path Files larger than chunk size will be split in chunks. - - - Config: chunk_size - - Env Var: RCLONE_CHUNKER_CHUNK_SIZE - - Type: SizeSuffix - - Default: 2G - - #### --chunker-hash-type - + Enter a size with suffix k,M,G,T. Press Enter for the default ("2G"). + chunk_size> 100M Choose how chunker handles hash sums. All modes but "none" require metadata. + Enter a string value. Press Enter for the default ("md5"). + Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise + \ "none" + 2 / MD5 for composite files + \ "md5" + 3 / SHA1 for composite files + \ "sha1" + 4 / MD5 for all files + \ "md5all" + 5 / SHA1 for all files + \ "sha1all" + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \ "md5quick" + 7 / Similar to "md5quick" but prefers SHA1 over MD5 + \ "sha1quick" + hash_type> md5 + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + -------------------- + [overlay] + type = chunker + remote = remote:bucket + chunk_size = 100M + hash_type = md5 + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: hash_type - - Env Var: RCLONE_CHUNKER_HASH_TYPE - - Type: string - - Default: "md5" - - Examples: - - "none" - - Pass any hash supported by wrapped remote for non-chunked files, return nothing otherwise - - "md5" - - MD5 for composite files - - "sha1" - - SHA1 for composite files - - "md5all" - - MD5 for all files - - "sha1all" - - SHA1 for all files - - "md5quick" - - Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported - - "sha1quick" - - Similar to "md5quick" but prefers SHA1 over MD5 +Specifying the remote - ### Advanced Options +In normal use, make sure the remote has a : in. If you specify the +remote without a : then rclone will use a local directory of that name. +So if you use a remote of /path/to/secret/files then rclone will chunk +stuff in that directory. If you use a remote of name then rclone will +put files in a directory called name in the current directory. - Here are the advanced options specific to chunker (Transparently chunk/split large files). +Chunking - #### --chunker-name-format +When rclone starts a file upload, chunker checks the file size. If it +doesn’t exceed the configured chunk size, chunker will just pass the +file to the wrapped remote. If a file is large, chunker will +transparently cut data in pieces with temporary names and stream them +one by one, on the fly. Each data chunk will contain the specified +number of bytes, except for the last one which may have less data. If +file size is unknown in advance (this is called a streaming upload), +chunker will internally create a temporary copy, record its size and +repeat the above process. - String format of chunk file names. - The two placeholders are: base file name (*) and chunk number (#...). - There must be one and only one asterisk and one or more consecutive hash characters. - If chunk number has less digits than the number of hashes, it is left-padded by zeros. - If there are more digits in the number, they are left as is. - Possible chunk files are ignored if their name does not match given format. +When upload completes, temporary chunk files are finally renamed. This +scheme guarantees that operations can be run in parallel and look from +outside as atomic. A similar method with hidden temporary chunks is used +for other operations (copy/move/rename etc). If an operation fails, +hidden chunks are normally destroyed, and the target composite file +stays intact. - - Config: name_format - - Env Var: RCLONE_CHUNKER_NAME_FORMAT - - Type: string - - Default: "*.rclone_chunk.###" +When a composite file download is requested, chunker transparently +assembles it by concatenating data chunks in order. As the split is +trivial one could even manually concatenate data chunks together to +obtain the original content. - #### --chunker-start-from +When the list rclone command scans a directory on wrapped remote, the +potential chunk files are accounted for, grouped and assembled into +composite directory entries. Any temporary chunks are hidden. - Minimum valid chunk number. Usually 0 or 1. - By default chunk numbers start from 1. +List and other commands can sometimes come across composite files with +missing or invalid chunks, eg. shadowed by like-named directory or +another file. This usually means that wrapped file system has been +directly tampered with or damaged. If chunker detects a missing chunk it +will by default print warning, skip the whole incomplete group of chunks +but proceed with current command. You can set the --chunker-fail-hard +flag to have commands abort with error message in such cases. - - Config: start_from - - Env Var: RCLONE_CHUNKER_START_FROM - - Type: int - - Default: 1 +Chunk names - #### --chunker-meta-format +The default chunk name format is *.rclone_chunk.###, hence by default +chunk names are BIG_FILE_NAME.rclone_chunk.001, +BIG_FILE_NAME.rclone_chunk.002 etc. You can configure another name +format using the name_format configuration file option. The format uses +asterisk * as a placeholder for the base file name and one or more +consecutive hash characters # as a placeholder for sequential chunk +number. There must be one and only one asterisk. The number of +consecutive hash characters defines the minimum length of a string +representing a chunk number. If decimal chunk number has less digits +than the number of hashes, it is left-padded by zeros. If the decimal +string is longer, it is left intact. By default numbering starts from 1 +but there is another option that allows user to start from 0, eg. for +compatibility with legacy software. - Format of the metadata object or "none". By default "simplejson". - Metadata is a small JSON file named after the composite file. +For example, if name format is big_*-##.part and original file name is +data.txt and numbering starts from 0, then the first chunk will be named +big_data.txt-00.part, the 99th chunk will be big_data.txt-98.part and +the 302nd chunk will become big_data.txt-301.part. - - Config: meta_format - - Env Var: RCLONE_CHUNKER_META_FORMAT - - Type: string - - Default: "simplejson" - - Examples: - - "none" - - Do not use metadata files at all. Requires hash type "none". - - "simplejson" - - Simple JSON supports hash sums and chunk validation. - - It has the following fields: ver, size, nchunks, md5, sha1. +Note that list assembles composite directory entries only when chunk +names match the configured format and treats non-conforming file names +as normal non-chunked files. - #### --chunker-fail-hard +Metadata - Choose how chunker should handle files with missing or invalid chunks. +Besides data chunks chunker will by default create metadata object for a +composite file. The object is named after the original file. Chunker +allows user to disable metadata completely (the none format). Note that +metadata is normally not created for files smaller than the configured +chunk size. This may change in future rclone releases. - - Config: fail_hard - - Env Var: RCLONE_CHUNKER_FAIL_HARD - - Type: bool - - Default: false - - Examples: - - "true" - - Report errors and abort current command. - - "false" - - Warn user, skip incomplete file and proceed. +Simple JSON metadata format - +This is the default format. It supports hash sums and chunk validation +for composite files. Meta objects carry the following fields: - ## Citrix ShareFile +- 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) - [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. +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. - 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. +No metadata - Here is an example of how to make a remote called `remote`. First run: +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. - rclone config +Hashsums - This will guide you through an interactive setup process: +Chunker supports hashsums only when a compatible metadata is present. +Hence, if you choose metadata format of none, chunker will report +hashsum as UNSUPPORTED. -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/ ** +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. -ID of the root folder +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. -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 +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 expence 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 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 setings, you should run +data migration as described above. + +If wrapped remote is case insensitive, the chunker overlay will inherit +that property (so you can’t have a file called “Hello.doc” and +“hello.doc” in the same directory). + +Standard Options + +Here are the standard options specific to chunker (Transparently +chunk/split large files). + +–chunker-remote + +Remote to chunk/unchunk. Normally should contain a ‘:’ and a path, eg +“myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not +recommended). + +- Config: remote +- Env Var: RCLONE_CHUNKER_REMOTE +- Type: string +- Default: "" + +–chunker-chunk-size + +Files larger than chunk size will be split in chunks. + +- Config: chunk_size +- Env Var: RCLONE_CHUNKER_CHUNK_SIZE +- Type: SizeSuffix +- Default: 2G + +–chunker-hash-type + +Choose how chunker handles hash sums. All modes but “none” require +metadata. + +- Config: hash_type +- Env Var: RCLONE_CHUNKER_HASH_TYPE +- Type: string +- Default: “md5” +- Examples: + - “none” + - Pass any hash supported by wrapped remote for non-chunked + files, return nothing otherwise + - “md5” + - MD5 for composite files + - “sha1” + - SHA1 for composite files + - “md5all” + - MD5 for all files + - “sha1all” + - SHA1 for all files + - “md5quick” + - Copying a file to chunker will request MD5 from the source + falling back to SHA1 if unsupported + - “sha1quick” + - Similar to “md5quick” but prefers SHA1 over MD5 + +Advanced Options + +Here are the advanced options specific to chunker (Transparently +chunk/split large files). + +–chunker-name-format + +String format of chunk file names. The two placeholders are: base file +name (*) and chunk number (#…). There must be one and only one asterisk +and one or more consecutive hash characters. If chunk number has less +digits than the number of hashes, it is left-padded by zeros. If there +are more digits in the number, they are left as is. Possible chunk files +are ignored if their name does not match given format. + +- Config: name_format +- Env Var: RCLONE_CHUNKER_NAME_FORMAT +- Type: string +- Default: "*.rclone_chunk.###" + +–chunker-start-from + +Minimum valid chunk number. Usually 0 or 1. By default chunk numbers +start from 1. + +- Config: start_from +- Env Var: RCLONE_CHUNKER_START_FROM +- Type: int +- Default: 1 + +–chunker-meta-format + +Format of the metadata object or “none”. By default “simplejson”. +Metadata is a small JSON file named after the composite file. + +- Config: meta_format +- Env Var: RCLONE_CHUNKER_META_FORMAT +- Type: string +- Default: “simplejson” +- Examples: + - “none” + - Do not use metadata files at all. Requires hash type “none”. + - “simplejson” + - Simple JSON supports hash sums and chunk validation. + - It has the following fields: ver, size, nchunks, md5, sha1. + +–chunker-fail-hard + +Choose how chunker should handle files with missing or invalid chunks. + +- Config: fail_hard +- Env Var: RCLONE_CHUNKER_FAIL_HARD +- Type: bool +- Default: false +- Examples: + - “true” + - Report errors and abort current command. + - “false” + - Warn user, skip incomplete file and proceed. - See the [remote setup docs](https://rclone.org/remote_setup/) for how to set it up on a - machine with no Internet browser available. +Citrix ShareFile - 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. +Citrix ShareFile is a secure file sharing and transfer service aimed as +business. - Once configured you can then use `rclone` like this, +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. - List directories in top level of your ShareFile +Here is an example of how to make a remote called remote. First run: - rclone lsd remote: + rclone config - List all the files in your ShareFile +This will guide you through an interactive setup process: - rclone ls remote: - - To copy a local directory to an ShareFile directory called backup - - rclone copy /home/source remote:backup - - Paths may be as deep as required, eg `remote:directory/subdirectory`. - - ### Modified time and hashes ### - - ShareFile allows modification times to be set on objects accurate to 1 - second. These will be used to detect whether objects need syncing or - not. - - ShareFile supports MD5 type hashes, so you can use the `--checksum` - flag. - - ### Transfers ### - - For files above 128MB rclone will use a chunked transfer. Rclone will - upload up to `--transfers` chunks at the same time (shared among all - the multipart uploads). Chunks are buffered in memory and are - normally 64MB so increasing `--transfers` will increase memory use. - - ### Limitations ### - - Note that ShareFile is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". - - ShareFile only supports filenames up to 256 characters in length. - - #### Restricted filename characters - - In addition to the [default restricted characters set](/overview/#restricted-characters) - the following characters are also replaced: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | \\ | 0x5C | ＼ | - | * | 0x2A | ＊ | - | < | 0x3C | ＜ | - | > | 0x3E | ＞ | - | ? | 0x3F | ？ | - | : | 0x3A | ： | - | \| | 0x7C | ｜ | - | " | 0x22 | ＂ | - - File names can also not start or end with the following characters. - These only get replaced if they are first or last character in the - name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - | . | 0x2E | ． | - - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. - - - ### Standard Options - - Here are the standard options specific to sharefile (Citrix Sharefile). - - #### --sharefile-root-folder-id + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + XX / Citrix Sharefile + \ "sharefile" + Storage> sharefile + ** See help for sharefile backend at: https://rclone.org/sharefile/ ** ID of the root folder Leave blank to access "Personal Folders". You can use one of the standard values here or any folder ID (long hex number ID). + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \ "" + 2 / Access the Favorites folder. + \ "favorites" + 3 / Access all the shared folders. + \ "allshared" + 4 / Access all the individual connectors. + \ "connectors" + 5 / Access the home, favorites, and shared folders as well as the connectors. + \ "top" + root_folder_id> + Edit advanced config? (y/n) + y) Yes + n) No + y/n> n + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = sharefile + endpoint = https://XXX.sharefile.com + token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +See the remote setup docs for how to set it up on a machine with no +Internet browser available. + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Citrix ShareFile. This only runs from the moment +it opens your browser to the moment you get back the verification code. +This is on http://127.0.0.1:53682/ and this it may require you to +unblock it temporarily if you are running a host firewall. + +Once configured you can then use rclone like this, + +List directories in top level of your ShareFile + + rclone lsd remote: + +List all the files in your ShareFile + + rclone ls remote: + +To copy a local directory to an ShareFile directory called backup + + rclone copy /home/source remote:backup + +Paths may be as deep as required, eg remote:directory/subdirectory. + +Modified time and hashes + +ShareFile allows modification times to be set on objects accurate to 1 +second. These will be used to detect whether objects need syncing or +not. - - 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 supports MD5 type hashes, so you can use the --checksum flag. - Crypt - ---------------------------------------- +Transfers - The `crypt` remote encrypts and decrypts another remote. +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. - 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. +Limitations - 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. +Note that ShareFile is case insensitive so you can’t have a file called +“Hello.doc” and one called “hello.doc”. - Now configure `crypt` using `rclone config`. We will call this one - `secret` to differentiate it from the `remote`. +ShareFile only supports filenames up to 256 characters in length. -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 +Restricted filename characters +In addition to the default restricted characters set the following +characters are also replaced: - **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. + Character Value Replacement + ----------- ------- ------------- + \ 0x5C ＼ + * 0x2A ＊ + < 0x3C ＜ + > 0x3E ＞ + ? 0x3F ？ + : 0x3A ： + | 0x7C ｜ + " 0x22 ＂ - A long passphrase is recommended, or you can use a random one. Note - that if you reconfigure rclone with the same passwords/passphrases - elsewhere it will be compatible - all the secrets used are derived - from those two passwords/passphrases. +File names can also not start or end with the following characters. +These only get replaced if they are first or last character in the name: - Note that rclone does not encrypt + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ + . 0x2E ． - * file length - this can be calcuated within 16 bytes - * modification time - used for syncing +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. - ## Specifying the remote ## +Standard 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 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. +Here are the standard options specific to sharefile (Citrix Sharefile). - 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. +–sharefile-root-folder-id - 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. +ID of the root folder - ## Example ## +Leave blank to access “Personal Folders”. You can use one of the +standard values here or any folder ID (long hex number ID). - To test I made a little directory of files using "standard" file name - encryption. +- 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. -plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── -file3.txt └── subsubdir └── file4.txt +Advanced Options +Here are the advanced options specific to sharefile (Citrix Sharefile). - Copy these to the remote and list them back +–sharefile-upload-cutoff -$ 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 +Cutoff for switching to multipart upload. +- Config: upload_cutoff +- Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 128M - Now see what that looked like when encrypted +–sharefile-chunk-size -$ rclone -q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps +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. - Note that this retains the directory structure which means you can do this +Reducing this will reduce memory usage but decrease performance. -$ rclone -q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt +- Config: chunk_size +- Env Var: RCLONE_SHAREFILE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 64M +–sharefile-endpoint - 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. +Endpoint for API calls. -$ 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 +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: "" - ### File name encryption modes ### +–sharefile-encoding - Here are some of the features of the file name encryption modes +This sets the encoding for the backend. - Off +See: the encoding section in the overview for more info. - * doesn't hide file names or directory structure - * allows for longer file names (~246 characters) - * can use sub paths and copy single files +- 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 - 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 +Crypt - Obfuscation +The crypt remote encrypts and decrypts another remote. - 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" +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. - 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. +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. - There is a possibility with some unicode based filenames that the - obfuscation is weak and may map lower case characters to upper case - equivalents. You can not rely on this for strong protection. - - * file names very lightly obfuscated - * file names can be longer than standard encryption - * can use sub paths and copy single files - * directory structure visible - * identical files names will have identical uploaded names - - Cloud storage systems have various limits on file name length and - total path length which you are more likely to hit using "Standard" - file name encryption. If you keep your file names to below 156 - characters in length then you should be OK on all providers. - - There may be an even more secure file name encryption mode in the - future which will address the long file name problem. - - ### Directory name encryption ### - Crypt offers the option of encrypting dir names or leaving them intact. - There are two options: - - True - - Encrypts the whole file path including directory names - Example: - `1/12/123.txt` is encrypted to - `p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0` - - False - - Only encrypts file names, skips directory names - Example: - `1/12/123.txt` is encrypted to - `1/12/qgm4avr35m5loi1th53ato71v0` - - - ### Modified time and hashes ### - - Crypt stores modification times using the underlying remote so support - depends on that. - - Hashes are not stored for crypt. However the data integrity is - protected by an extremely strong crypto authenticator. - - Note that you should use the `rclone cryptcheck` command to check the - integrity of a crypted remote instead of `rclone check` which can't - check the checksums properly. - - - ### Standard Options - - Here are the standard options specific to crypt (Encrypt/Decrypt a remote). - - #### --crypt-remote +Now configure crypt using rclone config. We will call this one secret to +differentiate it from the remote. + No remotes found - make a new one + n) New remote + s) Set configuration password + q) Quit config + n/s/q> n + name> secret + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Encrypt/Decrypt a remote + \ "crypt" + [snip] + Storage> crypt Remote to encrypt/decrypt. Normally should contain a ':' and a path, eg "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended). - - - Config: remote - - Env Var: RCLONE_CRYPT_REMOTE - - Type: string - - Default: "" - - #### --crypt-filename-encryption - + remote> remote:path How to encrypt the filenames. - - - Config: filename_encryption - - Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION - - Type: string - - Default: "standard" - - Examples: - - "off" - - Don't encrypt the file names. Adds a ".bin" extension only. - - "standard" - - Encrypt the filenames see the docs for the details. - - "obfuscate" - - Very simple filename obfuscation. - - #### --crypt-directory-name-encryption - + 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. - - - Config: directory_name_encryption - - Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION - - Type: bool - - Default: true - - Examples: - - "true" - - Encrypt directory names. - - "false" - - Don't encrypt directory names, leave them intact. - - #### --crypt-password - + Choose a number from below, or type in your own value + 1 / Encrypt directory names. + \ "true" + 2 / Don't encrypt directory names, leave them intact. + \ "false" + filename_encryption> 1 Password or pass phrase for encryption. - - - Config: password - - Env Var: RCLONE_CRYPT_PASSWORD - - Type: string - - Default: "" - - #### --crypt-password2 - + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: Password or pass phrase for salt. Optional but recommended. Should be different to the previous password. + y) Yes type in my own password + g) Generate random password + n) No leave this optional password blank + y/g/n> g + Password strength in bits. + 64 is just about memorable + 128 is secure + 1024 is the maximum + Bits> 128 + Your password is: JAsJvRcgR-_veXNfy_sGmQ + Use this password? + y) Yes + n) No + y/n> y + Remote config + -------------------- + [secret] + remote = remote:path + filename_encryption = standard + password = *** ENCRYPTED *** + password2 = *** ENCRYPTED *** + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y - - Config: password2 - - Env Var: RCLONE_CRYPT_PASSWORD2 - - Type: string - - Default: "" +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. - ### Advanced Options +A long passphrase is recommended, or you can use a random one. Note that +if you reconfigure rclone with the same passwords/passphrases elsewhere +it will be compatible - all the secrets used are derived from those two +passwords/passphrases. - Here are the advanced options specific to crypt (Encrypt/Decrypt a remote). +Note that rclone does not encrypt - #### --crypt-show-mapping +- file length - this can be calcuated within 16 bytes +- modification time - used for syncing - 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. +Specifying the remote - 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. +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. - - Config: show_mapping - - Env Var: RCLONE_CRYPT_SHOW_MAPPING - - Type: bool - - Default: false +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. - ## Backing up a crypted remote ## - If you wish to backup a crypted remote, it it recommended that you use - `rclone sync` on the encrypted files, and make sure the passwords are - the same in the new encrypted remote. +Example - This will have the following advantages +To test I made a little directory of files using “standard” file name +encryption. - * `rclone sync` will check the checksums while copying - * you can use `rclone check` between the encrypted remotes - * you don't decrypt and encrypt unnecessarily + plaintext/ + ├── file0.txt + ├── file1.txt + └── subdir + ├── file2.txt + ├── file3.txt + └── subsubdir + └── file4.txt - 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:`. +Copy these to the remote and list them back - To sync the two remotes you would do + $ 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 - rclone sync remote:crypt remote2:crypt +Now see what that looked like when encrypted - And to check the integrity you would do + $ rclone -q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps - rclone check remote:crypt remote2:crypt +Note that this retains the directory structure which means you can do +this - ## File formats ## + $ rclone -q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt - ### File encryption ### +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. - Files are encrypted 1:1 source file to destination object. The file - has a header and is divided into chunks. + $ 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 - #### Header #### +File name encryption modes - * 8 bytes magic string `RCLONE\x00\x00` - * 24 bytes Nonce (IV) +Here are some of the features of the file name encryption modes - 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. +Off - #### Chunk #### +- doesn’t hide file names or directory structure +- allows for longer file names (~246 characters) +- can use sub paths and copy single files - 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. +Standard - Each chunk contains: +- 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 - * 16 Bytes of Poly1305 authenticator - * 1 - 65536 bytes XSalsa20 encrypted data +Obfuscation - 64k chunk size was chosen as the best performing chunk size (the - authenticator takes too much time below this and the performance drops - off due to cache effects above this). Note that these chunks are - buffered in memory so they can't be too big. +This is 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 uses a 32 byte (256 bit key) key derived from the user password. +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. - #### Examples #### +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. - 1 byte file will encrypt to +- 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 - * 32 bytes header - * 17 bytes data chunk +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. - 49 bytes total +There may be an even more secure file name encryption mode in the future +which will address the long file name problem. - 1MB (1048576 bytes) file will encrypt to +Directory name encryption - * 32 bytes header - * 16 chunks of 65568 bytes +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: - 1049120 bytes total (a 0.05% overhead). This is the overhead for big - files. +True - ### Name encryption ### +Encrypts the whole file path including directory names Example: +1/12/123.txt is encrypted to +p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0 - File names are encrypted segment by segment - the path is broken up - into `/` separated strings and these are encrypted individually. +False - File segments are padded using using PKCS#7 to a multiple of 16 bytes - before encryption. +Only encrypts file names, skips directory names Example: 1/12/123.txt is +encrypted to 1/12/qgm4avr35m5loi1th53ato71v0 - 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. +Modified time and hashes - 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. +Crypt stores modification times using the underlying remote so support +depends on that. - This means that +Hashes are not stored for crypt. However the data integrity is protected +by an extremely strong crypto authenticator. - * filenames with the same name will encrypt the same - * filenames which start the same won't have a common prefix +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. - This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of - which are derived from the user password. +Standard Options - 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: +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). - * it becomes lower case (no-one likes upper case filenames!) - * we strip the padding character `=` +–crypt-remote - `base32` is used rather than the more efficient `base64` so rclone can be - used on case insensitive remotes (eg Windows, Amazon Drive). +Remote to encrypt/decrypt. Normally should contain a ‘:’ and a path, eg +“myremote:path/to/dir”, “myremote:bucket” or maybe “myremote:” (not +recommended). - ### Key derivation ### +- Config: remote +- Env Var: RCLONE_CRYPT_REMOTE +- Type: string +- Default: "" - 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. +–crypt-filename-encryption - `scrypt` makes it impractical to mount a dictionary attack on rclone - encrypted data. For full protection against this you should always use - a salt. +How to encrypt the filenames. - Dropbox - --------------------------------- +- 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. - Paths are specified as `remote:path` +–crypt-directory-name-encryption - Dropbox paths may be as deep as required, eg - `remote:directory/subdirectory`. +Option to either encrypt directory names or leave them intact. - 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. +- 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. - Here is an example of how to make a remote called `remote`. First run: +–crypt-password - rclone config +Password or pass phrase for encryption. - This will guide you through an interactive setup process: +- Config: password +- Env Var: RCLONE_CRYPT_PASSWORD +- Type: string +- Default: "" -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: +–crypt-password2 + +Password or pass phrase for salt. Optional but recommended. Should be +different to the previous password. + +- Config: password2 +- Env Var: RCLONE_CRYPT_PASSWORD2 +- Type: string +- Default: "" + +Advanced Options + +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). + +–crypt-show-mapping + +For all files listed show how the names encrypt. + +If this flag is set then for each file that the remote is asked to list, +it will log (at level INFO) a line stating the decrypted file name and +the encrypted file name. + +This is so you can work out which encrypted names are which decrypted +names just in case you need to do something with the encrypted file +names, or for debugging purposes. + +- Config: show_mapping +- Env Var: RCLONE_CRYPT_SHOW_MAPPING +- Type: bool +- Default: false + + +Backing up a crypted remote + +If you wish to backup a crypted remote, it it recommended that you use +rclone sync on the encrypted files, and make sure the passwords are the +same in the new encrypted remote. + +This will have the following advantages + +- rclone sync will check the checksums while copying +- you can use rclone check between the encrypted remotes +- you don’t decrypt and encrypt unnecessarily + +For example, let’s say you have your original remote at remote: with the +encrypted version at eremote: with path remote:crypt. You would then set +up the new remote remote2: and then the encrypted version eremote2: with +path remote2:crypt using the same passwords as eremote:. + +To sync the two remotes you would do + + rclone sync remote:crypt remote2:crypt + +And to check the integrity you would do + + rclone check remote:crypt remote2:crypt + + +File formats + +File encryption + +Files are encrypted 1:1 source file to destination object. The file has +a header and is divided into chunks. + +Header + +- 8 bytes magic string RCLONE\x00\x00 +- 24 bytes Nonce (IV) + +The initial nonce is generated from the operating systems crypto strong +random number generator. The nonce is incremented for each chunk read +making sure each nonce is unique for each block written. The chance of a +nonce being re-used is minuscule. If you wrote an exabyte of data (10¹⁸ +bytes) you would have a probability of approximately 2×10⁻³² of re-using +a nonce. + +Chunk + +Each chunk will contain 64kB of data, except for the last one which may +have less data. The data chunk is in standard NACL secretbox format. +Secretbox uses XSalsa20 and Poly1305 to encrypt and authenticate +messages. + +Each chunk contains: + +- 16 Bytes of Poly1305 authenticator +- 1 - 65536 bytes XSalsa20 encrypted data + +64k chunk size was chosen as the best performing chunk size (the +authenticator takes too much time below this and the performance drops +off due to cache effects above this). Note that these chunks are +buffered in memory so they can’t be too big. + +This uses a 32 byte (256 bit key) key derived from the user password. + +Examples + +1 byte file will encrypt to + +- 32 bytes header +- 17 bytes data chunk + +49 bytes total + +1MB (1048576 bytes) file will encrypt to + +- 32 bytes header +- 16 chunks of 65568 bytes + +1049120 bytes total (a 0.05% overhead). This is the overhead for big +files. + +Name encryption + +File names are encrypted segment by segment - the path is broken up into +/ separated strings and these are encrypted individually. + +File segments are padded using using PKCS#7 to a multiple of 16 bytes +before encryption. + +They are then encrypted with EME using AES with 256 bit key. EME +(ECB-Mix-ECB) is a wide-block encryption mode presented in the 2003 +paper “A Parallelizable Enciphering Mode” by Halevi and Rogaway. + +This makes for deterministic encryption which is what we want - the same +filename must encrypt to the same thing otherwise we can’t find it on +the cloud storage system. + +This means that + +- filenames with the same name will encrypt the same +- filenames which start the same won’t have a common prefix + +This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of +which are derived from the user password. + +After encryption they are written out using a modified version of +standard base32 encoding as described in RFC4648. The standard encoding +is modified in two ways: + +- it becomes lower case (no-one likes upper case filenames!) +- we strip the padding character = + +base32 is used rather than the more efficient base64 so rclone can be +used on case insensitive remotes (eg Windows, Amazon Drive). + +Key derivation + +Rclone uses scrypt with parameters N=16384, r=8, p=1 with an optional +user supplied salt (password2) to derive the 32+32+16 = 80 bytes of key +material required. If the user doesn’t supply a salt then rclone uses an +internal one. + +scrypt makes it impractical to mount a dictionary attack on rclone +encrypted data. For full protection against this you should always use a +salt. + + +Dropbox + +Paths are specified as remote:path + +Dropbox paths may be as deep as required, eg +remote:directory/subdirectory. + +The initial setup for dropbox involves getting a token from Dropbox +which you need to do in your browser. rclone config walks you through +it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Dropbox + \ "dropbox" + [snip] + Storage> dropbox + Dropbox App Key - leave blank normally. + app_key> + Dropbox App Secret - leave blank normally. + app_secret> + Remote config + Please visit: 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 + 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, - You can then use it like this, +List directories in top level of your dropbox - List directories in top level of your dropbox + rclone lsd remote: - rclone lsd remote: +List all the files in your dropbox - List all the files in your dropbox + rclone ls remote: - rclone ls remote: +To copy a local directory to a dropbox directory called backup - To copy a local directory to a dropbox directory called backup + rclone copy /home/source remote:backup - rclone copy /home/source remote:backup +Dropbox for business - ### Dropbox for business ### +Rclone supports Dropbox for business and Team Folders. - Rclone supports Dropbox for business and Team Folders. +When using Dropbox for business remote: and remote:path/to/file will +refer to your personal folder. - When using Dropbox for business `remote:` and `remote:path/to/file` - will refer to your personal folder. +If you wish to see Team Folders you must use a leading / in the path, so +rclone lsd remote:/ will refer to the root and show you all Team Folders +and your User Folder. - If you wish to see Team Folders you must use a leading `/` in the - path, so `rclone lsd remote:/` will refer to the root and show you all - Team Folders and your User Folder. +You can then use team folders like this remote:/TeamFolder and +remote:/TeamFolder/path/to/file. - You can then use team folders like this `remote:/TeamFolder` and - `remote:/TeamFolder/path/to/file`. +A leading / for a Dropbox personal account will do nothing, but it will +take an extra HTTP transaction so it should be avoided. - A leading `/` for a Dropbox personal account will do nothing, but it - will take an extra HTTP transaction so it should be avoided. +Modified time and Hashes - ### Modified time and Hashes ### +Dropbox supports modified times, but the only way to set a modification +time is to re-upload the file. - Dropbox supports modified times, but the only way to set a - modification time is to re-upload the file. +This means that if you uploaded your data with an older version of +rclone which didn’t support the v2 API and modified times, rclone will +decide to upload all your old data to fix the modification times. If you +don’t want this to happen use --size-only or --checksum flag to stop it. - This means that if you uploaded your data with an older version of - rclone which didn't support the v2 API and modified times, rclone will - decide to upload all your old data to fix the modification times. If - you don't want this to happen use `--size-only` or `--checksum` flag - to stop it. +Dropbox supports its own hash type which is checked for all transfers. - Dropbox supports [its own hash - type](https://www.dropbox.com/developers/reference/content-hash) which - is checked for all transfers. +Restricted filename characters - #### Restricted filename characters + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + / 0x2F ／ + DEL 0x7F ␡ + \ 0x5C ＼ - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | / | 0x2F | ／ | - | DEL | 0x7F | ␡ | - | \ | 0x5C | ＼ | +File names can also not end with the following characters. These only +get replaced if they are last character in the name: - File names can also not end with the following characters. - These only get replaced if they are last character in the name: + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | +Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON +strings. - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. +Standard Options - - ### Standard Options +Here are the standard options specific to dropbox (Dropbox). - Here are the standard options specific to dropbox (Dropbox). +–dropbox-client-id - #### --dropbox-client-id +Dropbox App Client Id Leave blank normally. - Dropbox App Client Id - Leave blank normally. +- Config: client_id +- Env Var: RCLONE_DROPBOX_CLIENT_ID +- Type: string +- Default: "" - - Config: client_id - - Env Var: RCLONE_DROPBOX_CLIENT_ID - - Type: string - - Default: "" +–dropbox-client-secret - #### --dropbox-client-secret +Dropbox App Client Secret Leave blank normally. - Dropbox App Client Secret - Leave blank normally. +- Config: client_secret +- Env Var: RCLONE_DROPBOX_CLIENT_SECRET +- Type: string +- Default: "" - - Config: client_secret - - Env Var: RCLONE_DROPBOX_CLIENT_SECRET - - Type: string - - Default: "" +Advanced Options - ### Advanced Options +Here are the advanced options specific to dropbox (Dropbox). - Here are the advanced options specific to dropbox (Dropbox). +–dropbox-chunk-size - #### --dropbox-chunk-size +Upload chunk size. (< 150M). - Upload chunk size. (< 150M). +Any files larger than this will be uploaded in chunks of this size. - 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. - 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 - - Config: chunk_size - - Env Var: RCLONE_DROPBOX_CHUNK_SIZE - - Type: SizeSuffix - - Default: 48M +–dropbox-impersonate - #### --dropbox-impersonate +Impersonate this user when using a business account. - Impersonate this user when using a business account. +- Config: impersonate +- Env Var: RCLONE_DROPBOX_IMPERSONATE +- Type: string +- Default: "" - - Config: impersonate - - Env Var: RCLONE_DROPBOX_IMPERSONATE - - Type: string - - Default: "" +–dropbox-encoding - +This sets the encoding for the backend. - ### Limitations ### +See: the encoding section in the overview for more info. - Note that Dropbox is case insensitive so you can't have a file called - "Hello.doc" and one called "hello.doc". +- Config: encoding +- Env Var: RCLONE_DROPBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot - 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. +Limitations - If you have more than 10,000 files in a directory then `rclone purge - dropbox:dir` will return the error `Failed to purge: There are too - many files involved in this operation`. As a work-around do an - `rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir`. +Note that Dropbox is case insensitive so you can’t have a file called +“Hello.doc” and one called “hello.doc”. - FTP - ------------------------------ +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. - FTP is the File Transfer Protocol. FTP support is provided using the - [github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) - package. +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. - Here is an example of making an FTP configuration. First run +Get your own Dropbox App ID - rclone config +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. - This will guide you through an interactive setup process. An FTP remote only - needs a host together with and a username and a password. With anonymous FTP - server, you will need to use `anonymous` as username and your email address as - the password. +Here is how to create your own Dropbox App ID for rclone: -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/ ** +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) -FTP host to connect to Enter a string value. Press Enter for the default -("“). Choose a number from below, or type in your own value 1 / Connect -to ftp.example.com  ”ftp.example.com" host> ftp.example.com FTP -username, leave blank for current username, ncw Enter a string value. -Press Enter for the default ("“). user> FTP port, leave blank to use -default (21) Enter a string value. Press Enter for the default (”“). -port> FTP password y) Yes type in my own password g) Generate random -password y/g> y Enter the password: password: Confirm the password: -password: Use FTP over TLS (Implicit) Enter a boolean value (true or -false). Press Enter for the default (”false"). tls> Remote config -——————– [remote] type = ftp host = ftp.example.com pass = *** ENCRYPTED -*** ——————– y) Yes this is OK e) Edit this remote d) Delete this remote -y/e/d> y +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 - This remote is called `remote` and can now be used like this +4. Name your App - See all directories in the home directory +5. Click the button Create App - rclone lsd remote: +6. Find the App key and App secret Use these values in rclone config to + add a new remote or edit an existing remote. - Make a new directory - rclone mkdir remote:path/to/directory +FTP - List the contents of a directory +FTP is the File Transfer Protocol. FTP support is provided using the +github.com/jlaffaye/ftp package. - rclone ls remote:path/to/directory +Here is an example of making an FTP configuration. First run - Sync `/home/local/directory` to the remote directory, deleting any - excess files in the directory. + rclone config - rclone sync /home/local/directory remote:directory +This will guide you through an interactive setup process. 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. - ### Modified time ### - - FTP does not support modified times. Any times you see on the server - will be time of upload. - - ### Checksums ### - - FTP does not support any checksums. - - #### Restricted filename characters - - In addition to the [default restricted characters set](/overview/#restricted-characters) - the following characters are also replaced: - - File names can also not end with the following characters. - These only get replaced if they are last character in the name: - - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | SP | 0x20 | ␠ | - - Note that not all FTP servers can have all characters in file names, for example: - - | FTP Server| Forbidden characters | - | --------- |:--------------------:| - | proftpd | `*` | - | pureftpd | `\ [ ]` | - - ### Implicit TLS ### - - FTP supports implicit FTP over TLS servers (FTPS). This has to be enabled - in the config for the remote. The default FTPS port is `990` so the - port will likely have to be explictly set in the config for the remote. - - - ### Standard Options - - Here are the standard options specific to ftp (FTP Connection). - - #### --ftp-host + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + [snip] + XX / FTP Connection + \ "ftp" + [snip] + Storage> ftp + ** See help for ftp backend at: https://rclone.org/ftp/ ** FTP host to connect to - - - Config: host - - Env Var: RCLONE_FTP_HOST - - Type: string - - Default: "" - - Examples: - - "ftp.example.com" - - Connect to ftp.example.com - - #### --ftp-user - - FTP username, leave blank for current username, $USER - - - Config: user - - Env Var: RCLONE_FTP_USER - - Type: string - - Default: "" - - #### --ftp-port - + Enter a string value. Press Enter for the default (""). + Choose a number from below, or type in your own value + 1 / Connect to ftp.example.com + \ "ftp.example.com" + host> ftp.example.com + FTP username, leave blank for current username, ncw + Enter a string value. Press Enter for the default (""). + user> FTP port, leave blank to use default (21) - - - Config: port - - Env Var: RCLONE_FTP_PORT - - Type: string - - Default: "" - - #### --ftp-pass - + Enter a string value. Press Enter for the default (""). + port> FTP password - - - Config: pass - - Env Var: RCLONE_FTP_PASS - - Type: string - - Default: "" - - #### --ftp-tls - + y) Yes type in my own password + g) Generate random password + y/g> y + Enter the password: + password: + Confirm the password: + password: Use FTP over TLS (Implicit) + Enter a boolean value (true or false). Press Enter for the default ("false"). + tls> + 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 - - Config: tls - - Env Var: RCLONE_FTP_TLS - - Type: bool - - Default: false +This remote is called remote and can now be used like this - ### Advanced Options +See all directories in the home directory - Here are the advanced options specific to ftp (FTP Connection). + rclone lsd remote: - #### --ftp-concurrency - - Maximum number of FTP simultaneous connections, 0 for unlimited - - - Config: concurrency - - Env Var: RCLONE_FTP_CONCURRENCY - - Type: int - - Default: 0 - - #### --ftp-no-check-certificate - - Do not verify the TLS certificate of the server - - - Config: no_check_certificate - - Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE - - Type: bool - - Default: false - - #### --ftp-disable-epsv - - Disable using EPSV even if server advertises support - - - Config: disable_epsv - - Env Var: RCLONE_FTP_DISABLE_EPSV - - Type: bool - - Default: false - - - - ### Limitations ### - - Note that since FTP isn't HTTP based the following flags don't work - with it: `--dump-headers`, `--dump-bodies`, `--dump-auth` - - Note that `--timeout` isn't supported (but `--contimeout` is). - - Note that `--bind` isn't supported. - - FTP could support server side move but doesn't yet. - - Note that the ftp backend does not support the `ftp_proxy` environment - variable yet. - - Note that while implicit FTP over TLS is supported, - explicit FTP over TLS is not. - - Google Cloud Storage - ------------------------------------------------- +Make a new directory - Paths are specified as `remote:bucket` (or `remote:` for the `lsd` - command.) You may put subdirectories in too, eg `remote:bucket/path/to/dir`. + rclone mkdir remote:path/to/directory - The initial setup for google cloud storage involves getting a token from Google Cloud Storage - which you need to do in your browser. `rclone config` walks you - through it. +List the contents of a directory - Here is an example of how to make a remote called `remote`. First run: + rclone ls remote:path/to/directory - rclone config +Sync /home/local/directory to the remote directory, deleting any excess +files in the directory. - This will guide you through an interactive setup process: + rclone sync /home/local/directory remote:directory -n) New remote -o) Delete remote -p) Quit config e/n/d/q> n name> remote Type of storage to configure. - Choose a number from below, or type in your own value [snip] XX / - Google Cloud Storage (this is not Google Drive)  “google cloud - storage” [snip] Storage> google cloud storage Google Application - Client Id - leave blank normally. client_id> Google Application - Client Secret - leave blank normally. client_secret> Project number - optional - needed only for list/create/delete buckets - see your - developer console. project_number> 12345678 Service Account - Credentials JSON file path - needed only if you want use SA instead - of interactive login. service_account_file> Access Control List for - new objects. Choose a number from below, or type in your own value 1 - / Object owner gets OWNER access, and all Authenticated Users get - READER access.  “authenticatedRead” 2 / Object owner gets OWNER - access, and project team owners get OWNER access. -  “bucketOwnerFullControl” 3 / Object owner gets OWNER access, and - project team owners get READER access.  “bucketOwnerRead” 4 / Object - owner gets OWNER access [default if left blank].  “private” 5 / - Object owner gets OWNER access, and project team members get access - according to their roles.  “projectPrivate” 6 / Object owner gets - OWNER access, and all Users get READER access.  “publicRead” - object_acl> 4 Access Control List for new buckets. Choose a number - from below, or type in your own value 1 / Project team owners get - OWNER access, and all Authenticated Users get READER access. -  “authenticatedRead” 2 / Project team owners get OWNER access - [default if left blank].  “private” 3 / Project team members get - access according to their roles.  “projectPrivate” 4 / Project team - owners get OWNER access, and all Users get READER access. -  “publicRead” 5 / Project team owners get OWNER access, and all - Users get WRITER access.  “publicReadWrite” bucket_acl> 2 Location - for the newly created buckets. Choose a number from below, or type - in your own value 1 / Empty for default location (US).  "" 2 / - Multi-regional location for Asia.  “asia” 3 / Multi-regional - location for Europe.  “eu” 4 / Multi-regional location for United - States.  “us” 5 / Taiwan.  “asia-east1” 6 / Tokyo. -  “asia-northeast1” 7 / Singapore.  “asia-southeast1” 8 / Sydney. -  “australia-southeast1” 9 / Belgium.  “europe-west1” 10 / London. -  “europe-west2” 11 / Iowa.  “us-central1” 12 / South Carolina. -  “us-east1” 13 / Northern Virginia.  “us-east4” 14 / Oregon. -  “us-west1” location> 12 The storage class to use when storing - objects in Google Cloud Storage. Choose a number from below, or type - in your own value 1 / Default  "" 2 / Multi-regional storage class -  “MULTI_REGIONAL” 3 / Regional storage class  “REGIONAL” 4 / - Nearline storage class  “NEARLINE” 5 / Coldline storage class -  “COLDLINE” 6 / Durable reduced availability storage class -  “DURABLE_REDUCED_AVAILABILITY” storage_class> 5 Remote config Use - auto config? - -- Say Y if not sure -- Say N if you are working on a remote or headless machine or Y didn’t - work - -y) Yes -z) No y/n> y If your browser doesn’t open automatically go to the - following link: http://127.0.0.1:53682/auth Log in and authorize - rclone for access Waiting for code… Got code ——————– [remote] type = - google cloud storage client_id = client_secret = token = - {“AccessToken”:“xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”,“RefreshToken”:“x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx”,“Expiry”:“2014-07-17T20:49:14.929208288+01:00”,“Extra”:null} - project_number = 12345678 object_acl = private bucket_acl = private - ——————– -a) Yes this is OK -b) Edit this remote -c) Delete this remote y/e/d> y - - - Note that rclone runs a webserver on your local machine to collect the - token as returned from Google if you use auto config mode. This only - runs from the moment it opens your browser to the moment you get back - the verification code. This is on `http://127.0.0.1:53682/` and this - it may require you to unblock it temporarily if you are running a host - firewall, or use manual mode. - - This remote is called `remote` and can now be used like this - - See all the buckets in your project - - rclone lsd remote: - - Make a new bucket - - rclone mkdir remote:bucket - - List the contents of a bucket - - rclone ls remote:bucket - - Sync `/home/local/directory` to the remote bucket, deleting any excess - files in the bucket. - - rclone sync /home/local/directory remote:bucket - - ### Service Account support ### - - You can set up rclone with Google Cloud Storage in an unattended mode, - i.e. not tied to a specific end-user Google account. This is useful - when you want to synchronise files onto machines that don't have - actively logged-in users, for example build machines. - - To get credentials for Google Cloud Platform - [IAM Service Accounts](https://cloud.google.com/iam/docs/service-accounts), - please head to the - [Service Account](https://console.cloud.google.com/permissions/serviceaccounts) - section of the Google Developer Console. Service Accounts behave just - like normal `User` permissions in - [Google Cloud Storage ACLs](https://cloud.google.com/storage/docs/access-control), - so you can limit their access (e.g. make them read only). After - creating an account, a JSON file containing the Service Account's - credentials will be downloaded onto your machines. These credentials - are what rclone will use for authentication. - - To use a Service Account instead of OAuth2 token flow, enter the path - to your Service Account credentials at the `service_account_file` - prompt and rclone won't use the browser based authentication - flow. If you'd rather stuff the contents of the credentials file into - the rclone config file, you can set `service_account_credentials` with - the actual contents of the file instead, or set the equivalent - environment variable. - - ### Application Default Credentials ### - - If no other source of credentials is provided, rclone will fall back - to - [Application Default Credentials](https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) - this is useful both when you already have configured authentication - for your developer account, or in production when running on a google - compute host. Note that if running in docker, you may need to run - additional commands on your google compute machine - - [see this page](https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). +Modified time - Note that in the case application default credentials are used, there - is no need to explicitly configure a project number. +FTP does not support modified times. Any times you see on the server +will be time of upload. - ### --fast-list ### +Checksums - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](/docs/#fast-list) for more details. +FTP does not support any checksums. - ### Modified time ### +Restricted filename characters - 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. +In addition to the default restricted characters set the following +characters are also replaced: - #### Restricted filename characters +File names can also not end with the following characters. These only +get replaced if they are last character in the name: - | Character | Value | Replacement | - | --------- |:-----:|:-----------:| - | NUL | 0x00 | ␀ | - | LF | 0x0A | ␊ | - | CR | 0x0D | ␍ | - | / | 0x2F | ／ | + Character Value Replacement + ----------- ------- ------------- + SP 0x20 ␠ - Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. +Note that not all FTP servers can have all characters in file names, for +example: - - ### Standard Options + FTP Server Forbidden characters + ------------ ---------------------- + proftpd * + pureftpd \ [ ] - Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)). +Implicit TLS - #### --gcs-client-id +FTP supports implicit FTP over TLS servers (FTPS). This has to be +enabled in the config for the remote. The default FTPS port is 990 so +the port will likely have to be explictly set in the config for the +remote. - Google Application Client Id - Leave blank normally. +Standard Options - - Config: client_id - - Env Var: RCLONE_GCS_CLIENT_ID - - Type: string - - Default: "" +Here are the standard options specific to ftp (FTP Connection). - #### --gcs-client-secret +–ftp-host - Google Application Client Secret - Leave blank normally. +FTP host to connect to - - Config: client_secret - - Env Var: RCLONE_GCS_CLIENT_SECRET - - Type: string - - Default: "" +- Config: host +- Env Var: RCLONE_FTP_HOST +- Type: string +- Default: "" +- Examples: + - “ftp.example.com” + - Connect to ftp.example.com - #### --gcs-project-number +–ftp-user - Project number. - Optional - needed only for list/create/delete buckets - see your developer console. +FTP username, leave blank for current username, $USER - - Config: project_number - - Env Var: RCLONE_GCS_PROJECT_NUMBER - - Type: string - - Default: "" +- Config: user +- Env Var: RCLONE_FTP_USER +- Type: string +- Default: "" - #### --gcs-service-account-file +–ftp-port - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. +FTP port, leave blank to use default (21) - - Config: service_account_file - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" +- Config: port +- Env Var: RCLONE_FTP_PORT +- Type: string +- Default: "" - #### --gcs-service-account-credentials +–ftp-pass - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. +FTP password - - Config: service_account_credentials - - Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" +- Config: pass +- Env Var: RCLONE_FTP_PASS +- Type: string +- Default: "" - #### --gcs-object-acl +–ftp-tls +Use FTP over TLS (Implicit) + +- Config: tls +- Env Var: RCLONE_FTP_TLS +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to ftp (FTP Connection). + +–ftp-concurrency + +Maximum number of FTP simultaneous connections, 0 for unlimited + +- Config: concurrency +- Env Var: RCLONE_FTP_CONCURRENCY +- Type: int +- Default: 0 + +–ftp-no-check-certificate + +Do not verify the TLS certificate of the server + +- Config: no_check_certificate +- Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +- Type: bool +- Default: false + +–ftp-disable-epsv + +Disable using EPSV even if server advertises support + +- Config: disable_epsv +- Env Var: RCLONE_FTP_DISABLE_EPSV +- Type: bool +- Default: false + +–ftp-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_FTP_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,RightSpace,Dot + +Limitations + +Note that since FTP isn’t HTTP based the following flags don’t work with +it: --dump-headers, --dump-bodies, --dump-auth + +Note that --timeout isn’t supported (but --contimeout is). + +Note that --bind isn’t supported. + +FTP could support server side move but doesn’t yet. + +Note that the ftp backend does not support the ftp_proxy environment +variable yet. + +Note that while implicit FTP over TLS is supported, explicit FTP over +TLS is not. + + +Google Cloud Storage + +Paths are specified as remote:bucket (or remote: for the lsd command.) +You may put subdirectories in too, eg remote:bucket/path/to/dir. + +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. rclone config +walks you through it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + n) New remote + d) Delete remote + q) Quit config + e/n/d/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + [snip] + Storage> google cloud storage + Google Application Client Id - leave blank normally. + client_id> + Google Application Client Secret - leave blank normally. + client_secret> + Project number optional - needed only for list/create/delete buckets - see your developer console. + project_number> 12345678 + Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. + service_account_file> Access Control List for new objects. - - - Config: object_acl - - Env Var: RCLONE_GCS_OBJECT_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Object owner gets OWNER access, and all Authenticated Users get READER access. - - "bucketOwnerFullControl" - - Object owner gets OWNER access, and project team owners get OWNER access. - - "bucketOwnerRead" - - Object owner gets OWNER access, and project team owners get READER access. - - "private" - - Object owner gets OWNER access [default if left blank]. - - "projectPrivate" - - Object owner gets OWNER access, and project team members get access according to their roles. - - "publicRead" - - Object owner gets OWNER access, and all Users get READER access. - - #### --gcs-bucket-acl - + Choose a number from below, or type in your own value + 1 / Object owner gets OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Object owner gets OWNER access, and project team owners get OWNER access. + \ "bucketOwnerFullControl" + 3 / Object owner gets OWNER access, and project team owners get READER access. + \ "bucketOwnerRead" + 4 / Object owner gets OWNER access [default if left blank]. + \ "private" + 5 / Object owner gets OWNER access, and project team members get access according to their roles. + \ "projectPrivate" + 6 / Object owner gets OWNER access, and all Users get READER access. + \ "publicRead" + object_acl> 4 Access Control List for new buckets. - - - Config: bucket_acl - - Env Var: RCLONE_GCS_BUCKET_ACL - - Type: string - - Default: "" - - Examples: - - "authenticatedRead" - - Project team owners get OWNER access, and all Authenticated Users get READER access. - - "private" - - Project team owners get OWNER access [default if left blank]. - - "projectPrivate" - - Project team members get access according to their roles. - - "publicRead" - - Project team owners get OWNER access, and all Users get READER access. - - "publicReadWrite" - - Project team owners get OWNER access, and all Users get WRITER access. - - #### --gcs-bucket-policy-only - - Access checks should use bucket-level IAM policies. - - If you want to upload objects to a bucket with Bucket Policy Only set - then you will need to set this. - - When it is set, rclone: - - - ignores ACLs set on buckets - - ignores ACLs set on objects - - creates buckets with Bucket Policy Only set - - Docs: https://cloud.google.com/storage/docs/bucket-policy-only - - - - Config: bucket_policy_only - - Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY - - Type: bool - - Default: false - - #### --gcs-location - + Choose a number from below, or type in your own value + 1 / Project team owners get OWNER access, and all Authenticated Users get READER access. + \ "authenticatedRead" + 2 / Project team owners get OWNER access [default if left blank]. + \ "private" + 3 / Project team members get access according to their roles. + \ "projectPrivate" + 4 / Project team owners get OWNER access, and all Users get READER access. + \ "publicRead" + 5 / Project team owners get OWNER access, and all Users get WRITER access. + \ "publicReadWrite" + bucket_acl> 2 Location for the newly created buckets. - - - Config: location - - Env Var: RCLONE_GCS_LOCATION - - Type: string - - Default: "" - - Examples: - - "" - - Empty for default location (US). - - "asia" - - Multi-regional location for Asia. - - "eu" - - Multi-regional location for Europe. - - "us" - - Multi-regional location for United States. - - "asia-east1" - - Taiwan. - - "asia-east2" - - Hong Kong. - - "asia-northeast1" - - Tokyo. - - "asia-south1" - - Mumbai. - - "asia-southeast1" - - Singapore. - - "australia-southeast1" - - Sydney. - - "europe-north1" - - Finland. - - "europe-west1" - - Belgium. - - "europe-west2" - - London. - - "europe-west3" - - Frankfurt. - - "europe-west4" - - Netherlands. - - "us-central1" - - Iowa. - - "us-east1" - - South Carolina. - - "us-east4" - - Northern Virginia. - - "us-west1" - - Oregon. - - "us-west2" - - California. - - #### --gcs-storage-class - + Choose a number from below, or type in your own value + 1 / Empty for default location (US). + \ "" + 2 / Multi-regional location for Asia. + \ "asia" + 3 / Multi-regional location for Europe. + \ "eu" + 4 / Multi-regional location for United States. + \ "us" + 5 / Taiwan. + \ "asia-east1" + 6 / Tokyo. + \ "asia-northeast1" + 7 / Singapore. + \ "asia-southeast1" + 8 / Sydney. + \ "australia-southeast1" + 9 / Belgium. + \ "europe-west1" + 10 / London. + \ "europe-west2" + 11 / Iowa. + \ "us-central1" + 12 / South Carolina. + \ "us-east1" + 13 / Northern Virginia. + \ "us-east4" + 14 / Oregon. + \ "us-west1" + location> 12 The storage class to use when storing objects in Google Cloud Storage. + Choose a number from below, or type in your own value + 1 / Default + \ "" + 2 / Multi-regional storage class + \ "MULTI_REGIONAL" + 3 / Regional storage class + \ "REGIONAL" + 4 / Nearline storage class + \ "NEARLINE" + 5 / Coldline storage class + \ "COLDLINE" + 6 / Durable reduced availability storage class + \ "DURABLE_REDUCED_AVAILABILITY" + storage_class> 5 + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn't work + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + -------------------- + [remote] + type = google cloud storage + client_id = + client_secret = + token = {"AccessToken":"xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","RefreshToken":"x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx","Expiry":"2014-07-17T20:49:14.929208288+01:00","Extra":null} + project_number = 12345678 + object_acl = private + bucket_acl = private + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this it +may require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +This remote is called remote and can now be used like this + +See all the buckets in your project + + rclone lsd remote: + +Make a new bucket + + rclone mkdir remote:bucket + +List the contents of a bucket + + rclone ls remote:bucket + +Sync /home/local/directory to the remote bucket, deleting any excess +files in the bucket. + + rclone sync /home/local/directory remote:bucket + +Service Account support + +You can set up rclone with Google Cloud Storage in an unattended mode, +i.e. not tied to a specific end-user Google account. This is useful when +you want to synchronise files onto machines that don’t have actively +logged-in users, for example build machines. + +To get credentials for Google Cloud Platform IAM Service Accounts, +please head to the Service Account section of the Google Developer +Console. Service Accounts behave just like normal User permissions in +Google Cloud Storage ACLs, so you can limit their access (e.g. make them +read only). After creating an account, a JSON file containing the +Service Account’s credentials will be downloaded onto your machines. +These credentials are what rclone will use for authentication. + +To use a Service Account instead of OAuth2 token flow, enter the path to +your Service Account credentials at the service_account_file prompt and +rclone won’t use the browser based authentication flow. If you’d rather +stuff the contents of the credentials file into the rclone config file, +you can set service_account_credentials with the actual contents of the +file instead, or set the equivalent environment variable. + +Application Default Credentials + +If no other source of credentials is provided, rclone will fall back to +Application Default Credentials this is useful both when you already +have configured authentication for your developer account, or in +production when running on a google compute host. Note that if running +in docker, you may need to run additional commands on your google +compute machine - see this page. + +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. + +–fast-list + +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. + +Modified time + +Google google cloud storage stores md5sums natively and rclone stores +modification times as metadata on the object, under the “mtime” key in +RFC3339 format accurate to 1ns. + +Restricted filename characters + + Character Value Replacement + ----------- ------- ------------- + NUL 0x00 ␀ + LF 0x0A ␊ + CR 0x0D ␍ + / 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 + +Google Application Client Id Leave blank normally. - - Config: storage_class - - Env Var: RCLONE_GCS_STORAGE_CLASS - - Type: string - - Default: "" - - Examples: - - "" - - Default - - "MULTI_REGIONAL" - - Multi-regional storage class - - "REGIONAL" - - Regional storage class - - "NEARLINE" - - Nearline storage class - - "COLDLINE" - - Coldline storage class - - "DURABLE_REDUCED_AVAILABILITY" - - Durable reduced availability storage class +- Config: client_id +- Env Var: RCLONE_GCS_CLIENT_ID +- Type: string +- Default: "" - +–gcs-client-secret - Google Drive - ----------------------------------------- +Google Application Client Secret Leave blank normally. - Paths are specified as `drive:path` +- Config: client_secret +- Env Var: RCLONE_GCS_CLIENT_SECRET +- Type: string +- Default: "" - Drive paths may be as deep as required, eg `drive:directory/subdirectory`. +–gcs-project-number - 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. +Project number. Optional - needed only for list/create/delete buckets - +see your developer console. - Here is an example of how to make a remote called `remote`. First run: +- Config: project_number +- Env Var: RCLONE_GCS_PROJECT_NUMBER +- Type: string +- Default: "" - rclone config - - This will guide you through an interactive setup process: - -No remotes found - make a new one n) New remote r) Rename remote c) Copy -remote s) Set configuration password q) Quit config n/r/c/s/q> n name> -remote Type of storage to configure. Choose a number from below, or type -in your own value [snip] XX / Google Drive  “drive” [snip] Storage> -drive Google Application Client Id - leave blank normally. client_id> -Google Application Client Secret - leave blank normally. client_secret> -Scope that rclone should use when requesting access from drive. Choose a -number from below, or type in your own value 1 / Full access all files, -excluding Application Data Folder.  “drive” 2 / Read-only access to file -metadata and file contents.  “drive.readonly” / Access to files created -by rclone only. 3 | These are visible in the drive website. | File -authorization is revoked when the user deauthorizes the app. - “drive.file” / Allows read and write access to the Application Data -folder. 4 | This is not visible in the drive website.  “drive.appfolder” -/ Allows read-only access to file metadata but 5 | does not allow any -access to read or download file content.  “drive.metadata.readonly” -scope> 1 ID of the root folder - leave blank normally. Fill in to access -“Computers” folders. (see docs). root_folder_id> Service Account -Credentials JSON file path - needed only if you want use SA instead of -interactive login. service_account_file> Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine or Y didn’t work y) Yes n) No y/n> y If your browser doesn’t -open automatically go to the following link: http://127.0.0.1:53682/auth -Log in and authorize rclone for access Waiting for code… Got code -Configure this as a team drive? y) Yes n) No y/n> n ——————– [remote] -client_id = client_secret = scope = drive root_folder_id = -service_account_file = token = -{“access_token”:“XXX”,“token_type”:“Bearer”,“refresh_token”:“XXX”,“expiry”:“2014-03-16T13:57:58.955387075Z”} -——————– y) Yes this is OK e) Edit this remote d) Delete this remote -y/e/d> y - - - Note that rclone runs a webserver on your local machine to collect the - token as returned from Google if you use auto config mode. This only - runs from the moment it opens your browser to the moment you get back - the verification code. This is on `http://127.0.0.1:53682/` and this - it may require you to unblock it temporarily if you are running a host - firewall, or use manual mode. - - You can then use it like this, - - List directories in top level of your drive - - rclone lsd remote: - - List all the files in your drive - - rclone ls remote: - - To copy a local directory to a drive directory called backup - - rclone copy /home/source remote:backup - - ### Scopes ### - - Rclone allows you to select which scope you would like for rclone to - use. This changes what type of token is granted to rclone. [The - scopes are defined - here.](https://developers.google.com/drive/v3/web/about-auth). - - The scope are - - #### drive #### - - This is the default scope and allows full access to all files, except - for the Application Data Folder (see below). - - Choose this one if you aren't sure. - - #### drive.readonly #### - - This allows read only access to all files. Files may be listed and - downloaded but not uploaded, renamed or deleted. - - #### drive.file #### - - With this scope rclone can read/view/modify only those files and - folders it creates. - - So if you uploaded files to drive via the web interface (or any other - means) they will not be visible to rclone. - - This can be useful if you are using rclone to backup data and you want - to be sure confidential data on your drive is not visible to rclone. - - Files created with this scope are visible in the web interface. - - #### drive.appfolder #### - - This gives rclone its own private area to store files. Rclone will - not be able to see any other files on your drive and you won't be able - to see rclone's files from the web interface either. - - #### drive.metadata.readonly #### - - This allows read only access to file names only. It does not allow - rclone to download or upload data, or rename or delete files or - directories. - - ### Root folder ID ### - - You can set the `root_folder_id` for rclone. This is the directory - (identified by its `Folder ID`) that rclone considers to be the root - of your drive. - - Normally you will leave this blank and rclone will determine the - correct root to use itself. - - However you can set this to restrict rclone to a specific folder - hierarchy or to access data within the "Computers" tab on the drive - web interface (where files from Google's Backup and Sync desktop - program go). - - In order to do this you will have to find the `Folder ID` of the - directory you wish rclone to display. This will be the last segment - of the URL when you open the relevant folder in the drive web - interface. - - So if the folder you want rclone to use has a URL which looks like - `https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` - in the browser, then you use `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` as - the `root_folder_id` in the config. - - **NB** folders under the "Computers" tab seem to be read only (drive - gives a 500 error) when using rclone. - - There doesn't appear to be an API to discover the folder IDs of the - "Computers" tab - please contact us if you know otherwise! - - Note also that rclone can't access any data under the "Backups" tab on - the google drive web interface yet. - - ### Service Account support ### - - You can set up rclone with Google Drive in an unattended mode, - i.e. not tied to a specific end-user Google account. This is useful - when you want to synchronise files onto machines that don't have - actively logged-in users, for example build machines. - - To use a Service Account instead of OAuth2 token flow, enter the path - to your Service Account credentials at the `service_account_file` - prompt during `rclone config` and rclone won't use the browser based - authentication flow. If you'd rather stuff the contents of the - credentials file into the rclone config file, you can set - `service_account_credentials` with the actual contents of the file - instead, or set the equivalent environment variable. - - #### Use case - Google Apps/G-suite account and individual Drive #### - - Let's say that you are the administrator of a Google Apps (old) or - G-suite account. - The goal is to store data on an individual's Drive account, who IS - a member of the domain. - We'll call the domain **example.com**, and the user - **foo@example.com**. - - There's a few steps we need to go through to accomplish this: - - ##### 1. Create a service account for example.com ##### - - To create a service account and obtain its credentials, go to the - [Google Developer Console](https://console.developers.google.com). - - You must have a project - create one if you don't. - - Then go to "IAM & admin" -> "Service Accounts". - - Use the "Create Credentials" button. Fill in "Service account name" - with something that identifies your client. "Role" can be empty. - - Tick "Furnish a new private key" - select "Key type JSON". - - Tick "Enable G Suite Domain-wide Delegation". This option makes - "impersonation" possible, as documented here: - [Delegating domain-wide authority to the service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) - - These credentials are what rclone will use for authentication. - If you ever need to remove access, press the "Delete service - account key" button. - - ##### 2. Allowing API access to example.com Google Drive ##### - - Go to example.com's admin console - - Go into "Security" (or use the search bar) - - Select "Show more" and then "Advanced settings" - - Select "Manage API client access" in the "Authentication" section - - In the "Client Name" field enter the service account's - "Client ID" - this can be found in the Developer Console under - "IAM & Admin" -> "Service Accounts", then "View Client ID" for - the newly created service account. - It is a ~21 character numerical string. - - In the next field, "One or More API Scopes", enter - `https://www.googleapis.com/auth/drive` - to grant access to Google Drive specifically. - - ##### 3. Configure rclone, assuming a new install ##### - -rclone config - -n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select -the number shown for Google Drive client_id> # Can be left blank -client_secret> # Can be left blank scope> # Select your scope, 1 for -example root_folder_id> # Can be left blank service_account_file> -/home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # -Auto config, y - - - ##### 4. Verify that it's working ##### - - `rclone -v --drive-impersonate foo@example.com lsf gdrive:backup` - - The arguments do: - - `-v` - verbose logging - - `--drive-impersonate foo@example.com` - this is what does - the magic, pretending to be user foo. - - `lsf` - list files in a parsing friendly way - - `gdrive:backup` - use the remote called gdrive, work in - the folder named backup. - - ### Team drives ### - - If you want to configure the remote to point to a Google Team Drive - then answer `y` to the question `Configure this as a team drive?`. - - This will fetch the list of Team Drives from google and allow you to - configure which one you want to use. You can also type in a team - drive ID if you prefer. - - For example: - -Configure this as a team drive? y) Yes n) No y/n> y Fetching team drive -list… Choose a number from below, or type in your own value 1 / Rclone -Test  “xxxxxxxxxxxxxxxxxxxx” 2 / Rclone Test 2  “yyyyyyyyyyyyyyyyyyyy” 3 -/ Rclone Test 3  “zzzzzzzzzzzzzzzzzzzz” Enter a Team Drive ID> 1 ——————– -[remote] client_id = client_secret = token = -{“AccessToken”:“xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”,“RefreshToken”:“1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx”,“Expiry”:“2014-03-16T13:57:58.955387075Z”,“Extra”:null} -team_drive = xxxxxxxxxxxxxxxxxxxx ——————– y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y - - - ### --fast-list ### - - This remote supports `--fast-list` which allows you to use fewer - transactions in exchange for more memory. See the [rclone - docs](/docs/#fast-list) for more details. - - It does this by combining multiple `list` calls into a single API request. - - This works by combining many `'%s' in parents` filters into one expression. - To list the contents of directories a, b and c, the following requests will be send by the regular `List` function: - -trashed=false and ‘a’ in parents trashed=false and ‘b’ in parents -trashed=false and ‘c’ in parents - - These can now be combined into a single request: - -trashed=false and (‘a’ in parents or ‘b’ in parents or ‘c’ in parents) - - - The implementation of `ListR` will put up to 50 `parents` filters into one request. - It will use the `--checkers` value to specify the number of requests to run in parallel. - - In tests, these batch requests were up to 20x faster than the regular method. - Running the following command against different sized folders gives: - -rclone lsjson -vv -R –checkers=6 gdrive:folder - - - small folder (220 directories, 700 files): - - - without `--fast-list`: 38s - - with `--fast-list`: 10s - - large folder (10600 directories, 39000 files): - - - without `--fast-list`: 22:05 min - - with `--fast-list`: 58s - - ### Modified time ### - - Google drive stores modification times accurate to 1 ms. - - #### Restricted filename characters - - Only Invalid UTF-8 bytes will be [replaced](/overview/#invalid-utf8), - as they can't be used in JSON strings. - - In contrast to other backends, `/` can also be used in names and `.` - or `..` are valid names. - - ### Revisions ### - - Google drive stores revisions of files. When you upload a change to - an existing file to google drive using rclone it will create a new - revision of that file. - - Revisions follow the standard google policy which at time of writing - was - - * They are deleted after 30 days or 100 revisions (whatever comes first). - * They do not count towards a user storage quota. - - ### Deleting files ### - - By default rclone will send all files to the trash when deleting - files. If deleting them permanently is required then use the - `--drive-use-trash=false` flag, or set the equivalent environment - variable. - - ### Emptying trash ### - - If you wish to empty your trash you can use the `rclone cleanup remote:` - command which will permanently delete all your trashed files. This command - does not take any path arguments. - - Note that Google Drive takes some time (minutes to days) to empty the - trash even though the command returns within a few seconds. No output - is echoed, so there will be no confirmation even using -v or -vv. - - ### Quota information ### - - To view your current quota you can use the `rclone about remote:` - command which will display your usage limit (quota), the usage in Google - Drive, the size of all files in the Trash and the space used by other - Google services such as Gmail. This command does not take any path - arguments. - - #### Import/Export of google documents #### - - Google documents can be exported from and uploaded to Google Drive. - - When rclone downloads a Google doc it chooses a format to download - depending upon the `--drive-export-formats` setting. - By default the export formats are `docx,xlsx,pptx,svg` which are a - sensible default for an editable document. - - When choosing a format, rclone runs down the list provided in order - and chooses the first file format the doc can be exported as from the - list. If the file can't be exported to a format on the formats list, - then rclone will choose a format from the default list. - - If you prefer an archive copy then you might use `--drive-export-formats - pdf`, or if you prefer openoffice/libreoffice formats you might use - `--drive-export-formats ods,odt,odp`. - - Note that rclone adds the extension to the google doc, so if it is - called `My Spreadsheet` on google docs, it will be exported as `My - Spreadsheet.xlsx` or `My Spreadsheet.pdf` etc. - - When importing files into Google Drive, rclone will convert all - files with an extension in `--drive-import-formats` to their - associated document type. - rclone will not convert any files by default, since the conversion - is lossy process. - - The conversion must result in a file with the same extension when - the `--drive-export-formats` rules are applied to the uploaded document. - - Here are some examples for allowed and prohibited conversions. - - | export-formats | import-formats | Upload Ext | Document Ext | Allowed | - | -------------- | -------------- | ---------- | ------------ | ------- | - | odt | odt | odt | odt | Yes | - | odt | docx,odt | odt | odt | Yes | - | | docx | docx | docx | Yes | - | | odt | odt | docx | No | - | odt,docx | docx,odt | docx | odt | No | - | docx,odt | docx,odt | docx | docx | Yes | - | docx,odt | docx,odt | odt | docx | No | - - This limitation can be disabled by specifying `--drive-allow-import-name-change`. - When using this flag, rclone can convert multiple files types resulting - in the same document type at once, eg with `--drive-import-formats docx,odt,txt`, - all files having these extension would result in a document represented as a docx file. - This brings the additional risk of overwriting a document, if multiple files - have the same stem. Many rclone operations will not handle this name change - in any way. They assume an equal name when copying files and might copy the - file again or delete them when the name changes. - - Here are the possible export extensions with their corresponding mime types. - Most of these can also be used for importing, but there more that are not - listed here. Some of these additional ones might only be available when - the operating system provides the correct MIME type entries. - - This list can be changed by Google Drive at any time and might not - represent the currently available conversions. - - | Extension | Mime Type | Description | - | --------- |-----------| ------------| - | csv | text/csv | Standard CSV format for Spreadsheets | - | docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Office Document | - | epub | application/epub+zip | E-book format | - | html | text/html | An HTML Document | - | jpg | image/jpeg | A JPEG Image File | - | json | application/vnd.google-apps.script+json | JSON Text Format | - | odp | application/vnd.oasis.opendocument.presentation | Openoffice Presentation | - | ods | application/vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | ods | application/x-vnd.oasis.opendocument.spreadsheet | Openoffice Spreadsheet | - | odt | application/vnd.oasis.opendocument.text | Openoffice Document | - | pdf | application/pdf | Adobe PDF Format | - | png | image/png | PNG Image Format| - | pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation | Microsoft Office Powerpoint | - | rtf | application/rtf | Rich Text Format | - | svg | image/svg+xml | Scalable Vector Graphics Format | - | tsv | text/tab-separated-values | Standard TSV format for spreadsheets | - | txt | text/plain | Plain Text | - | xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Microsoft Office Spreadsheet | - | zip | application/zip | A ZIP file of HTML, Images CSS | - - Google documents can also be exported as link files. These files will - open a browser window for the Google Docs website of that document - when opened. The link file extension has to be specified as a - `--drive-export-formats` parameter. They will match all available - Google Documents. - - | Extension | Description | OS Support | - | --------- | ----------- | ---------- | - | desktop | freedesktop.org specified desktop entry | Linux | - | link.html | An HTML Document with a redirect | All | - | url | INI style link file | macOS, Windows | - | webloc | macOS specific XML format | macOS | - - - ### Standard Options - - Here are the standard options specific to drive (Google Drive). - - #### --drive-client-id - - Google Application Client Id - Setting your own is recommended. - See https://rclone.org/drive/#making-your-own-client-id for how to create your own. - If you leave this blank, it will use an internal key which is low performance. - - - Config: client_id - - Env Var: RCLONE_DRIVE_CLIENT_ID - - Type: string - - Default: "" - - #### --drive-client-secret - - Google Application Client Secret - Setting your own is recommended. - - - Config: client_secret - - Env Var: RCLONE_DRIVE_CLIENT_SECRET - - Type: string - - Default: "" - - #### --drive-scope +–gcs-service-account-file +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. + +- Config: service_account_file +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" + +–gcs-service-account-credentials + +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. + +- Config: service_account_credentials +- Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" + +–gcs-object-acl + +Access Control List for new objects. + +- Config: object_acl +- Env Var: RCLONE_GCS_OBJECT_ACL +- Type: string +- Default: "" +- Examples: + - “authenticatedRead” + - Object owner gets OWNER access, and all Authenticated Users + get READER access. + - “bucketOwnerFullControl” + - Object owner gets OWNER access, and project team owners get + OWNER access. + - “bucketOwnerRead” + - Object owner gets OWNER access, and project team owners get + READER access. + - “private” + - Object owner gets OWNER access [default if left blank]. + - “projectPrivate” + - Object owner gets OWNER access, and project team members get + access according to their roles. + - “publicRead” + - Object owner gets OWNER access, and all Users get READER + access. + +–gcs-bucket-acl + +Access Control List for new buckets. + +- Config: bucket_acl +- Env Var: RCLONE_GCS_BUCKET_ACL +- Type: string +- Default: "" +- Examples: + - “authenticatedRead” + - Project team owners get OWNER access, and all Authenticated + Users get READER access. + - “private” + - Project team owners get OWNER access [default if left + blank]. + - “projectPrivate” + - Project team members get access according to their roles. + - “publicRead” + - Project team owners get OWNER access, and all Users get + READER access. + - “publicReadWrite” + - Project team owners get OWNER access, and all Users get + WRITER access. + +–gcs-bucket-policy-only + +Access checks should use bucket-level IAM policies. + +If you want to upload objects to a bucket with Bucket Policy Only set +then you will need to set this. + +When it is set, rclone: + +- ignores ACLs set on buckets +- ignores ACLs set on objects +- creates buckets with Bucket Policy Only set + +Docs: https://cloud.google.com/storage/docs/bucket-policy-only + +- Config: bucket_policy_only +- Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY +- Type: bool +- Default: false + +–gcs-location + +Location for the newly created buckets. + +- Config: location +- Env Var: RCLONE_GCS_LOCATION +- Type: string +- Default: "" +- Examples: + - "" + - Empty for default location (US). + - “asia” + - Multi-regional location for Asia. + - “eu” + - Multi-regional location for Europe. + - “us” + - Multi-regional location for United States. + - “asia-east1” + - Taiwan. + - “asia-east2” + - Hong Kong. + - “asia-northeast1” + - Tokyo. + - “asia-south1” + - Mumbai. + - “asia-southeast1” + - Singapore. + - “australia-southeast1” + - Sydney. + - “europe-north1” + - Finland. + - “europe-west1” + - Belgium. + - “europe-west2” + - London. + - “europe-west3” + - Frankfurt. + - “europe-west4” + - Netherlands. + - “us-central1” + - Iowa. + - “us-east1” + - South Carolina. + - “us-east4” + - Northern Virginia. + - “us-west1” + - Oregon. + - “us-west2” + - California. + +–gcs-storage-class + +The storage class to use when storing objects in Google Cloud Storage. + +- Config: storage_class +- Env Var: RCLONE_GCS_STORAGE_CLASS +- Type: string +- Default: "" +- Examples: + - "" + - Default + - “MULTI_REGIONAL” + - Multi-regional storage class + - “REGIONAL” + - Regional storage class + - “NEARLINE” + - Nearline storage class + - “COLDLINE” + - Coldline storage class + - “DURABLE_REDUCED_AVAILABILITY” + - Durable reduced availability storage class + +Advanced Options + +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). + +–gcs-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_GCS_ENCODING +- Type: MultiEncoder +- Default: Slash,CrLf,InvalidUtf8,Dot + + +Google Drive + +Paths are specified as drive:path + +Drive paths may be as deep as required, eg drive:directory/subdirectory. + +The initial setup for drive involves getting a token from Google drive +which you need to do in your browser. rclone config walks you through +it. + +Here is an example of how to make a remote called remote. First run: + + rclone config + +This will guide you through an interactive setup process: + + No remotes found - make a new one + n) New remote + r) Rename remote + c) Copy remote + s) Set configuration password + q) Quit config + n/r/c/s/q> n + name> remote + Type of storage to configure. + Choose a number from below, or type in your own value + [snip] + XX / Google Drive + \ "drive" + [snip] + Storage> drive + Google Application Client Id - leave blank normally. + client_id> + Google Application Client Secret - leave blank normally. + client_secret> Scope that rclone should use when requesting access from drive. + Choose a number from below, or type in your own value + 1 / Full access all files, excluding Application Data Folder. + \ "drive" + 2 / Read-only access to file metadata and file contents. + \ "drive.readonly" + / Access to files created by rclone only. + 3 | These are visible in the drive website. + | File authorization is revoked when the user deauthorizes the app. + \ "drive.file" + / Allows read and write access to the Application Data folder. + 4 | This is not visible in the drive website. + \ "drive.appfolder" + / Allows read-only access to file metadata but + 5 | does not allow any access to read or download file content. + \ "drive.metadata.readonly" + scope> 1 + ID of the root folder - leave blank normally. Fill in to access "Computers" folders. (see docs). + root_folder_id> + Service Account Credentials JSON file path - needed only if you want use SA instead of interactive login. + service_account_file> + Remote config + Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn't work + y) Yes + n) No + y/n> y + If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth + Log in and authorize rclone for access + Waiting for code... + Got code + Configure this as a team drive? + y) Yes + n) No + y/n> n + -------------------- + [remote] + client_id = + client_secret = + scope = drive + root_folder_id = + service_account_file = + token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"} + -------------------- + y) Yes this is OK + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. This only +runs from the moment it opens your browser to the moment you get back +the verification code. This is on http://127.0.0.1:53682/ and this it +may require you to unblock it temporarily if you are running a host +firewall, or use manual mode. + +You can then use it like this, + +List directories in top level of your drive + + rclone lsd remote: + +List all the files in your drive + + rclone ls remote: + +To copy a local directory to a drive directory called backup + + rclone copy /home/source remote:backup + +Scopes + +Rclone allows you to select which scope you would like for rclone to +use. This changes what type of token is granted to rclone. The scopes +are defined here.. + +The scope are + +drive + +This is the default scope and allows full access to all files, except +for the Application Data Folder (see below). + +Choose this one if you aren’t sure. + +drive.readonly + +This allows read only access to all files. Files may be listed and +downloaded but not uploaded, renamed or deleted. + +drive.file + +With this scope rclone can read/view/modify only those files and folders +it creates. + +So if you uploaded files to drive via the web interface (or any other +means) they will not be visible to rclone. + +This can be useful if you are using rclone to backup data and you want +to be sure confidential data on your drive is not visible to rclone. + +Files created with this scope are visible in the web interface. + +drive.appfolder + +This gives rclone its own private area to store files. Rclone will not +be able to see any other files on your drive and you won’t be able to +see rclone’s files from the web interface either. + +drive.metadata.readonly + +This allows read only access to file names only. It does not allow +rclone to download or upload data, or rename or delete files or +directories. + +Root folder ID + +You can set the root_folder_id for rclone. This is the directory +(identified by its Folder ID) that rclone considers to be the root of +your drive. + +Normally you will leave this blank and rclone will determine the correct +root to use itself. + +However you can set this to restrict rclone to a specific folder +hierarchy or to access data within the “Computers” tab on the drive web +interface (where files from Google’s Backup and Sync desktop program +go). - - Config: scope - - Env Var: RCLONE_DRIVE_SCOPE - - Type: string - - Default: "" - - Examples: - - "drive" - - Full access all files, excluding Application Data Folder. - - "drive.readonly" - - Read-only access to file metadata and file contents. - - "drive.file" - - Access to files created by rclone only. - - These are visible in the drive website. - - File authorization is revoked when the user deauthorizes the app. - - "drive.appfolder" - - Allows read and write access to the Application Data folder. - - This is not visible in the drive website. - - "drive.metadata.readonly" - - Allows read-only access to file metadata but - - does not allow any access to read or download file content. +In order to do this you will have to find the Folder ID of the directory +you wish rclone to display. This will be the last segment of the URL +when you open the relevant folder in the drive web interface. - #### --drive-root-folder-id +So if the folder you want rclone to use has a URL which looks like +https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh +in the browser, then you use 1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh as the +root_folder_id in the config. - ID of the root folder - Leave blank normally. +NB folders under the “Computers” tab seem to be read only (drive gives a +500 error) when using rclone. - Fill in to access "Computers" folders (see docs), or for rclone to use - a non root folder as its starting point. +There doesn’t appear to be an API to discover the folder IDs of the +“Computers” tab - please contact us if you know otherwise! - Note that if this is blank, the first time rclone runs it will fill it - in with the ID of the root folder. +Note also that rclone can’t access any data under the “Backups” tab on +the google drive web interface yet. +Service Account support - - Config: root_folder_id - - Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID - - Type: string - - Default: "" +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. - #### --drive-service-account-file +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. - Service Account Credentials JSON file path - Leave blank normally. - Needed only if you want use SA instead of interactive login. +Use case - Google Apps/G-suite account and individual Drive - - Config: service_account_file - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE - - Type: string - - Default: "" +Let’s say that you are the administrator of a Google Apps (old) or +G-suite account. The goal is to store data on an individual’s Drive +account, who IS a member of the domain. We’ll call the domain +EXAMPLE.COM, and the user FOO@EXAMPLE.COM. + +There’s a few steps we need to go through to accomplish this: + +1. Create a service account for example.com + +- To create a service account and obtain its credentials, go to the + Google Developer Console. +- You must have a project - create one if you don’t. +- Then go to “IAM & admin” -> “Service Accounts”. +- Use the “Create Credentials” button. Fill in “Service account name” + with something that identifies your client. “Role” can be empty. +- Tick “Furnish a new private key” - select “Key type JSON”. +- Tick “Enable G Suite Domain-wide Delegation”. This option makes + “impersonation” possible, as documented here: Delegating domain-wide + authority to the service account +- These credentials are what rclone will use for authentication. If + you ever need to remove access, press the “Delete service account + key” button. + +2. Allowing API access to example.com Google Drive + +- Go to example.com’s admin console +- Go into “Security” (or use the search bar) +- Select “Show more” and then “Advanced settings” +- Select “Manage API client access” in the “Authentication” section +- In the “Client Name” field enter the service account’s “Client ID” - + this can be found in the Developer Console under “IAM & Admin” -> + “Service Accounts”, then “View Client ID” for the newly created + service account. It is a ~21 character numerical string. +- In the next field, “One or More API Scopes”, enter + https://www.googleapis.com/auth/drive to grant access to Google + Drive specifically. + +3. Configure rclone, assuming a new install + + rclone config + + n/s/q> n # New + name>gdrive # Gdrive is an example name + Storage> # Select the number shown for Google Drive + client_id> # Can be left blank + client_secret> # Can be left blank + scope> # Select your scope, 1 for example + root_folder_id> # Can be left blank + service_account_file> /home/foo/myJSONfile.json # This is where the JSON file goes! + y/n> # Auto config, y + +4. Verify that it’s working + +- rclone -v --drive-impersonate foo@example.com lsf gdrive:backup +- The arguments do: + - -v - verbose logging + - --drive-impersonate foo@example.com - this is what does the + magic, pretending to be user foo. + - lsf - list files in a parsing friendly way + - gdrive:backup - use the remote called gdrive, work in the folder + named backup. + +Team drives - ### Advanced Options +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. - Here are the advanced options specific to drive (Google Drive). +For example: - #### --drive-service-account-credentials + 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 - Service Account Credentials JSON blob - Leave blank normally. - Needed only if you want use SA instead of interactive login. +–fast-list - - Config: service_account_credentials - - Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS - - Type: string - - Default: "" +This remote supports --fast-list which allows you to use fewer +transactions in exchange for more memory. See the rclone docs for more +details. - #### --drive-team-drive +It does this by combining multiple list calls into a single API request. - ID of the Team Drive +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 - - Config: team_drive - - Env Var: RCLONE_DRIVE_TEAM_DRIVE - - Type: string - - Default: "" +These can now be combined into a single request: - #### --drive-auth-owner-only + trashed=false and ('a' in parents or 'b' in parents or 'c' in parents) - Only consider files owned by the authenticated user. +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. - - Config: auth_owner_only - - Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY - - Type: bool - - Default: false +In tests, these batch requests were up to 20x faster than the regular +method. Running the following command against different sized folders +gives: - #### --drive-use-trash + rclone lsjson -vv -R --checkers=6 gdrive:folder - 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. +small folder (220 directories, 700 files): - - Config: use_trash - - Env Var: RCLONE_DRIVE_USE_TRASH - - Type: bool - - Default: true +- without --fast-list: 38s +- with --fast-list: 10s - #### --drive-skip-gdocs +large folder (10600 directories, 39000 files): - Skip google documents in all listings. - If given, gdocs practically become invisible to rclone. +- without --fast-list: 22:05 min +- with --fast-list: 58s - - Config: skip_gdocs - - Env Var: RCLONE_DRIVE_SKIP_GDOCS - - Type: bool - - Default: false +Modified time - #### --drive-skip-checksum-gphotos +Google drive stores modification times accurate to 1 ms. + +Restricted filename characters - Skip MD5 checksum on Google photos and videos only. +Only Invalid UTF-8 bytes will be replaced, as they can’t be used in JSON +strings. - Use this if you get checksum errors when transferring Google photos or - videos. +In contrast to other backends, / can also be used in names and . or .. +are valid names. - Setting this flag will cause Google photos and videos to return a - blank MD5 checksum. +Revisions - Google photos are identifed by being in the "photos" space. +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. - Corrupted checksums are caused by Google modifying the image/video but - not updating the checksum. +Revisions follow the standard google policy which at time of writing was - - Config: skip_checksum_gphotos - - Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS - - Type: bool - - Default: false +- They are deleted after 30 days or 100 revisions (whatever comes + first). +- They do not count towards a user storage quota. - #### --drive-shared-with-me +Deleting files - Only show files that are shared with me. +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. - 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). +Emptying trash - This works both with the "list" (lsd, lsl, etc) and the "copy" - commands (copy, sync, etc), and with all other commands too. +If you wish to empty your trash you can use the rclone cleanup remote: +command which will permanently delete all your trashed files. This +command does not take any path arguments. - - Config: shared_with_me - - Env Var: RCLONE_DRIVE_SHARED_WITH_ME - - Type: bool - - Default: false +Note that Google Drive takes some time (minutes to days) to empty the +trash even though the command returns within a few seconds. No output is +echoed, so there will be no confirmation even using -v or -vv. - #### --drive-trashed-only +Quota information - Only show files that are in the trash. - This will show trashed files in their original directory structure. +To view your current quota you can use the rclone about remote: command +which will display your usage limit (quota), the usage in Google Drive, +the size of all files in the Trash and the space used by other Google +services such as Gmail. This command does not take any path arguments. - - Config: trashed_only - - Env Var: RCLONE_DRIVE_TRASHED_ONLY - - Type: bool - - Default: false +Import/Export of google documents - #### --drive-formats +Google documents can be exported from and uploaded to Google Drive. - Deprecated: see export_formats +When rclone downloads a Google doc it chooses a format to download +depending upon the --drive-export-formats setting. By default the export +formats are docx,xlsx,pptx,svg which are a sensible default for an +editable document. - - Config: formats - - Env Var: RCLONE_DRIVE_FORMATS - - Type: string - - Default: "" +When choosing a format, rclone runs down the list provided in order and +chooses the first file format the doc can be exported as from the list. +If the file can’t be exported to a format on the formats list, then +rclone will choose a format from the default list. - #### --drive-export-formats +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. - Comma separated list of preferred formats for downloading Google docs. +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. - - Config: export_formats - - Env Var: RCLONE_DRIVE_EXPORT_FORMATS - - Type: string - - Default: "docx,xlsx,pptx,svg" +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. - #### --drive-import-formats +The conversion must result in a file with the same extension when the +--drive-export-formats rules are applied to the uploaded document. - Comma separated list of preferred formats for uploading Google docs. +Here are some examples for allowed and prohibited conversions. - - Config: import_formats - - Env Var: RCLONE_DRIVE_IMPORT_FORMATS - - Type: string - - Default: "" + 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 - #### --drive-allow-import-name-change +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. - Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. +Here are the 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. - - Config: allow_import_name_change - - Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE - - Type: bool - - Default: false +This list can be changed by Google Drive at any time and might not +represent the currently available conversions. - #### --drive-use-created-date + -------------------------------------------------------------------------------------------------------------------------- + Extension Mime Type Description + ------------------- --------------------------------------------------------------------------- -------------------------- + csv text/csv Standard CSV format for + Spreadsheets - Use file created date instead of modified date., + docx application/vnd.openxmlformats-officedocument.wordprocessingml.document Microsoft Office Document - Useful when downloading data and you want the creation date used in - place of the last modified date. + epub application/epub+zip E-book format - **WARNING**: This flag may have some unexpected consequences. + html text/html An HTML Document - 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. + jpg image/jpeg A JPEG Image File - 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. + json application/vnd.google-apps.script+json JSON Text Format - - Config: use_created_date - - Env Var: RCLONE_DRIVE_USE_CREATED_DATE - - Type: bool - - Default: false + odp application/vnd.oasis.opendocument.presentation Openoffice Presentation - #### --drive-list-chunk + ods application/vnd.oasis.opendocument.spreadsheet Openoffice Spreadsheet - Size of listing chunk 100-1000. 0 to disable. + ods application/x-vnd.oasis.opendocument.spreadsheet Openoffice Spreadsheet - - Config: list_chunk - - Env Var: RCLONE_DRIVE_LIST_CHUNK - - Type: int - - Default: 1000 + odt application/vnd.oasis.opendocument.text Openoffice Document - #### --drive-impersonate + pdf application/pdf Adobe PDF Format - Impersonate this user when using a service account. + png image/png PNG Image Format - - Config: impersonate - - Env Var: RCLONE_DRIVE_IMPERSONATE - - Type: string - - Default: "" + pptx application/vnd.openxmlformats-officedocument.presentationml.presentation Microsoft Office + Powerpoint - #### --drive-alternate-export + rtf application/rtf Rich Text Format - Use alternate export URLs for google documents export., + svg image/svg+xml Scalable Vector Graphics + Format - If this option is set this instructs rclone to use an alternate set of - export URLs for drive documents. Users have reported that the - official export URLs can't export large documents, whereas these - unofficial ones can. + tsv text/tab-separated-values Standard TSV format for + spreadsheets - See rclone issue [#2243](https://github.com/rclone/rclone/issues/2243) for background, - [this google drive issue](https://issuetracker.google.com/issues/36761333) and - [this helpful post](https://www.labnol.org/internet/direct-links-for-google-drive/28356/). + txt text/plain Plain Text - - Config: alternate_export - - Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT - - Type: bool - - Default: false + xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Microsoft Office + Spreadsheet - #### --drive-upload-cutoff + zip application/zip A ZIP file of HTML, Images + CSS + -------------------------------------------------------------------------------------------------------------------------- - Cutoff for switching to chunked upload +Google documents can also be exported as link files. These files will +open a browser window for the Google Docs website of that document when +opened. The link file extension has to be specified as a +--drive-export-formats parameter. They will match all available Google +Documents. - - Config: upload_cutoff - - Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF - - Type: SizeSuffix - - Default: 8M + Extension Description OS Support + ----------- ----------------------------------------- ---------------- + desktop freedesktop.org specified desktop entry Linux + link.html An HTML Document with a redirect All + url INI style link file macOS, Windows + webloc macOS specific XML format macOS - #### --drive-chunk-size +Standard Options - Upload chunk size. Must a power of 2 >= 256k. +Here are the standard options specific to drive (Google Drive). - Making this larger will improve performance, but note that each chunk - is buffered in memory one per transfer. +–drive-client-id - Reducing this will reduce memory usage but decrease performance. +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: chunk_size - - Env Var: RCLONE_DRIVE_CHUNK_SIZE - - Type: SizeSuffix - - Default: 8M +- Config: client_id +- Env Var: RCLONE_DRIVE_CLIENT_ID +- Type: string +- Default: "" - #### --drive-acknowledge-abuse +–drive-client-secret - Set to allow files which return cannotDownloadAbusiveFile to be downloaded. +Google Application Client Secret Setting your own is recommended. - 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: client_secret +- Env Var: RCLONE_DRIVE_CLIENT_SECRET +- Type: string +- Default: "" - - Config: acknowledge_abuse - - Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE - - Type: bool - - Default: false +–drive-scope - #### --drive-keep-revision-forever +Scope that rclone should use when requesting access from drive. - Keep new head revision of each file forever. +- Config: scope +- Env Var: RCLONE_DRIVE_SCOPE +- Type: string +- Default: "" +- Examples: + - “drive” + - Full access all files, excluding Application Data Folder. + - “drive.readonly” + - Read-only access to file metadata and file contents. + - “drive.file” + - Access to files created by rclone only. + - These are visible in the drive website. + - File authorization is revoked when the user deauthorizes the + app. + - “drive.appfolder” + - Allows read and write access to the Application Data folder. + - This is not visible in the drive website. + - “drive.metadata.readonly” + - Allows read-only access to file metadata but + - does not allow any access to read or download file content. - - Config: keep_revision_forever - - Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER - - Type: bool - - Default: false +–drive-root-folder-id - #### --drive-size-as-quota +ID of the root folder Leave blank normally. - Show storage quota usage for file size. +Fill in to access “Computers” folders (see docs), or for rclone to use a +non root folder as its starting point. - The storage used by a file is the size of the current version plus any - older versions that have been set to keep forever. +Note that if this is blank, the first time rclone runs it will fill it +in with the ID of the root folder. - - Config: size_as_quota - - Env Var: RCLONE_DRIVE_SIZE_AS_QUOTA - - Type: bool - - Default: false +- Config: root_folder_id +- Env Var: RCLONE_DRIVE_ROOT_FOLDER_ID +- Type: string +- Default: "" - #### --drive-v2-download-min-size +–drive-service-account-file - If Object's are greater, use drive v2 API to download. +Service Account Credentials JSON file path Leave blank normally. Needed +only if you want use SA instead of interactive login. - - Config: v2_download_min_size - - Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE - - Type: SizeSuffix - - Default: off +- Config: service_account_file +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +- Type: string +- Default: "" - #### --drive-pacer-min-sleep +Advanced Options - Minimum time to sleep between API calls. +Here are the advanced options specific to drive (Google Drive). - - Config: pacer_min_sleep - - Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP - - Type: Duration - - Default: 100ms +–drive-service-account-credentials - #### --drive-pacer-burst +Service Account Credentials JSON blob Leave blank normally. Needed only +if you want use SA instead of interactive login. - Number of API calls to allow without sleeping. +- Config: service_account_credentials +- Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +- Type: string +- Default: "" - - Config: pacer_burst - - Env Var: RCLONE_DRIVE_PACER_BURST - - Type: int - - Default: 100 +–drive-team-drive - #### --drive-server-side-across-configs +ID of the Team Drive - Allow server side operations (eg copy) to work across different drive configs. +- Config: team_drive +- Env Var: RCLONE_DRIVE_TEAM_DRIVE +- Type: string +- Default: "" - 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. +–drive-auth-owner-only - - Config: server_side_across_configs - - Env Var: RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS - - Type: bool - - Default: false +Only consider files owned by the authenticated user. - #### --drive-disable-http2 +- Config: auth_owner_only +- Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +- Type: bool +- Default: false - Disable drive using http2 +–drive-use-trash - 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. +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. - See: https://github.com/rclone/rclone/issues/3631 +- 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: disable_http2 - - Env Var: RCLONE_DRIVE_DISABLE_HTTP2 - - Type: bool - - Default: true +- Config: skip_gdocs +- Env Var: RCLONE_DRIVE_SKIP_GDOCS +- Type: bool +- Default: false - +–drive-skip-checksum-gphotos - ### Limitations ### +Skip MD5 checksum on Google photos and videos only. - 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. +Use this if you get checksum errors when transferring Google photos or +videos. - 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. +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. - #### Limitations of Google Docs #### +Google photos are identifed by being in the “photos” space. - 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`. +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. - This is because rclone can't find out the size of the Google docs - without downloading them. +- Config: skip_checksum_gphotos +- Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +- Type: bool +- Default: false - Google docs will transfer correctly with `rclone sync`, `rclone copy` - etc as rclone knows to ignore the size when doing the transfer. +–drive-shared-with-me - However an unfortunate consequence of this is that you may not be able - to download Google docs using `rclone mount`. If it doesn't work you - will get a 0 sized file. If you try again the doc may gain its - correct size and be downloadable. Whther it will work on not depends - on the application accessing the mount and the OS you are running - - experiment to find out if it does work for you! +Only show files that are shared with me. - ### Duplicated files ### +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). - 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. +This works both with the “list” (lsd, lsl, etc) and the “copy” commands +(copy, sync, etc), and with all other commands too. - Duplicated files cause problems with the syncing and you will see - messages in the log about duplicates. +- Config: shared_with_me +- Env Var: RCLONE_DRIVE_SHARED_WITH_ME +- Type: bool +- Default: false - Use `rclone dedupe` to fix duplicated files. +–drive-trashed-only - Note that this isn't just a problem with rclone, even Google Photos on - Android duplicates files on drive sometimes. +Only show files that are in the trash. This will show trashed files in +their original directory structure. - ### Rclone appears to be re-copying files it shouldn't ### +- Config: trashed_only +- Env Var: RCLONE_DRIVE_TRASHED_ONLY +- Type: bool +- Default: false - 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. +–drive-formats - 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. +Deprecated: see export_formats - 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. +- Config: formats +- Env Var: RCLONE_DRIVE_FORMATS +- Type: string +- Default: "" - ### Making your own client_id ### +–drive-export-formats - 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. +Comma separated list of preferred formats for downloading Google docs. - 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. +- Config: export_formats +- Env Var: RCLONE_DRIVE_EXPORT_FORMATS +- Type: string +- Default: “docx,xlsx,pptx,svg” - Here is how to create your own Google Drive client ID for rclone: +–drive-import-formats - 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) +Comma separated list of preferred formats for uploading Google docs. - 2. Select a project or create a new project. +- Config: import_formats +- Env Var: RCLONE_DRIVE_IMPORT_FORMATS +- Type: string +- Default: "" - 3. Under "ENABLE APIS AND SERVICES" search for "Drive", and enable the - "Google Drive API". +–drive-allow-import-name-change - 4. Click "Credentials" in the left-side panel (not "Create - credentials", which opens the wizard), then "Create credentials", then - "OAuth client ID". It will prompt you to set the OAuth consent screen - product name, if you haven't set one already. +Allow the filetype to change when uploading Google docs (e.g. file.doc +to file.docx). This will confuse sync and reupload every time. - 5. Choose an application type of "other", and click "Create". (the +- 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-alternate-export + +Use alternate export URLs for google documents export., + +If this option is set this instructs rclone to use an alternate set of +export URLs for drive documents. Users have reported that the official +export URLs can’t export large documents, whereas these unofficial ones +can. + +See rclone issue #2243 for background, this google drive issue and this +helpful post. + +- Config: alternate_export +- Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +- Type: bool +- Default: false + +–drive-upload-cutoff + +Cutoff for switching to chunked upload + +- Config: upload_cutoff +- Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +- Type: SizeSuffix +- Default: 8M + +–drive-chunk-size + +Upload chunk size. Must a power of 2 >= 256k. + +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. + +Reducing this will reduce memory usage but decrease performance. + +- Config: chunk_size +- Env Var: RCLONE_DRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 8M + +–drive-acknowledge-abuse + +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. + +If downloading a file returns the error “This file has been identified +as malware or spam and cannot be downloaded” with the error code +“cannotDownloadAbusiveFile” then supply this flag to rclone to indicate +you acknowledge the risks of downloading the file and rclone will +download it anyway. + +- Config: acknowledge_abuse +- Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +- Type: bool +- Default: false + +–drive-keep-revision-forever + +Keep new head revision of each file forever. + +- Config: keep_revision_forever +- Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +- Type: bool +- Default: false + +–drive-size-as-quota + +Show sizes as storage quota usage, not actual size. + +Show the size of a file as the 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-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 + +Limitations + +Drive has quite a lot of rate limiting. This causes rclone to be limited +to transferring about 2 files per second only. Individual files may be +transferred much faster at 100s of MBytes/s but lots of small files can +take a long time. + +Server side copies are also subject to a separate rate limit. If you see +User rate limit exceeded errors, wait at least 24 hours and retry. You +can disable server side copies with --disable copy to download and +upload the files if you prefer. + +Limitations of Google Docs + +Google docs will appear as size -1 in rclone ls and as size 0 in +anything which uses the VFS layer, eg rclone mount, rclone serve. + +This is because rclone can’t find out the size of the Google docs +without downloading them. + +Google docs will transfer correctly with rclone sync, rclone copy etc as +rclone knows to ignore the size when doing the transfer. + +However an unfortunate consequence of this is that you may not be able +to download Google docs using rclone mount. If it doesn’t work you will +get a 0 sized file. If you try again the doc may gain its correct size +and be downloadable. Whther it will work on not depends on the +application accessing the mount and the OS you are running - experiment +to find out if it does work for you! + +Duplicated files + +Sometimes, for no reason I’ve been able to track down, drive will +duplicate a file that rclone uploads. Drive unlike all the other remotes +can have duplicated files. + +Duplicated files cause problems with the syncing and you will see +messages in the log about duplicates. + +Use rclone dedupe to fix duplicated files. + +Note that this isn’t just a problem with rclone, even Google Photos on +Android duplicates files on drive sometimes. + +Rclone appears to be re-copying files it shouldn’t + +The most likely cause of this is the duplicated file issue above - run +rclone dedupe and check your logs for duplicate object or directory +messages. + +This can also be caused by a delay/caching on google drive’s end when +comparing directory listings. Specifically with team drives used in +combination with –fast-list. Files that were uploaded recently may not +appear on the directory list sent to rclone when using –fast-list. + +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using –fast-list both seem to be +effective in preventing the problem. + +Making your own client_id + +When you use rclone with Google drive in its default configuration you +are using rclone’s client_id. This is shared between all the rclone +users. There is a global rate limit on the number of queries per second +that each client_id can do set by Google. rclone already has a high +quota and I will continue to make sure it is high enough by contacting +Google. + +It is strongly recommended to use your own client ID as the default +rclone ID is heavily used. If you have multiple services running, it is +recommended to use an API key for each service. The default Google quota +is 10 transactions per second so it is recommended to stay under that +number as if you use more than that, it will cause rclone to rate limit +and make things slower. + +Here is how to create your own Google Drive client ID for rclone: + +1. Log into the Google API Console with your Google account. It doesn’t + matter what Google account you use. (It need not be the same account + as the Google Drive you want to access) + +2. Select a project or create a new project. + +3. Under “ENABLE APIS AND SERVICES” search for “Drive”, and enable the + “Google Drive API”. + +4. Click “Credentials” in the left-side panel (not “Create + credentials”, which opens the wizard), then “Create credentials”, + then “OAuth client ID”. It will prompt you to set the OAuth consent + screen product name, if you haven’t set one already. + +5. Choose an application type of “other”, and click “Create”. (the default name is fine) - 6. It will show you a client ID and client secret. Use these values - in rclone config to add a new remote or edit an existing remote. +6. It will show you a client ID and client secret. Use these values in + rclone config to add a new remote or edit an existing remote. - (Thanks to @balazer on github for these instructions.) +(Thanks to @balazer on github for these instructions.) - Google Photos - ------------------------------------------------- - The rclone backend for [Google Photos](https://www.google.com/photos/about/) is - a specialized backend for transferring photos and videos to and from - Google Photos. +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 /home/local/image remote:album/newAlbum + + +Layout + +As Google Photos is not a general purpose cloud storage system the +backend is laid out to help you navigate it. + +The directories under media show different ways of categorizing the +media. Each file will appear multiple times. So if you want to make a +backup of your google photos you might choose to backup +remote:media/by-month. (NB remote:media/by-day is rather slow at the +moment so avoid for syncing.) + +Note that all your photos and videos will appear somewhere under media, +but they may not appear under album unless you’ve put them into albums. + + / + - upload + - file1.jpg + - file2.jpg + - ... + - media + - all + - file1.jpg + - file2.jpg + - ... + - by-year + - 2000 + - file1.jpg + - ... + - 2001 + - file2.jpg + - ... + - ... + - by-month + - 2000 + - 2000-01 + - file1.jpg + - ... + - 2000-02 + - file2.jpg + - ... + - ... + - by-day + - 2000 + - 2000-01-01 + - file1.jpg + - ... + - 2000-01-02 + - file2.jpg + - ... + - ... + - album + - album name + - album name/sub + - shared-album + - album name + - album name/sub + +There are two writable parts of the tree, the upload directory and sub +directories of the the album directory. + +The upload directory is for uploading files you don’t want to put into +albums. This will be empty to start with and will contain the files +you’ve uploaded for one rclone session only, becoming empty again when +you restart rclone. The use case for this would be if you have a load of +files you just want to once off dump into Google Photos. For repeated +syncing, uploading to album will work better. + +Directories within the album directory are also writeable and you may +create new directories (albums) under album. If you copy files with a +directory hierarchy in there then rclone will create albums with the / +character in them. For example if you do + + rclone copy /path/to/images remote:album/images + +and the images directory contains + + images + - file1.jpg + dir + file2.jpg + dir2 + dir3 + file3.jpg + +Then rclone will create the following albums with the following files in + +- images + - file1.jpg +- images/dir + - file2.jpg +- images/dir2/dir3 + - file3.jpg + +This means that you can use the album path pretty much like a normal +filesystem and it is a good target for repeated syncing. + +The shared-album directory shows albums shared with you or by you. This +is similar to the Sharing tab in the Google Photos web interface. + + +Limitations + +Only images and videos can be uploaded. If you attempt to upload non +videos or images or formats that Google Photos doesn’t understand, +rclone will upload the file, then Google Photos will give an error when +it is put turned into a media item. + +Note that all media items uploaded to Google Photos through the API are +stored in full resolution at “original quality” and WILL count towards +your storage quota in your Google Account. The API does NOT offer a way +to upload in “high quality” mode.. + +Downloading Images + +When Images are downloaded this strips EXIF location (according to the +docs and my tests). This is a limitation of the Google Photos API and is +covered by bug #112096115. + +THE CURRENT GOOGLE API DOES NOT ALLOW PHOTOS TO BE DOWNLOADED AT +ORIGINAL RESOLUTION. THIS IS VERY IMPORTANT IF YOU ARE, FOR EXAMPLE, +RELYING ON “GOOGLE PHOTOS” AS A BACKUP OF YOUR PHOTOS. YOU WILL NOT BE +ABLE TO USE RCLONE TO REDOWNLOAD ORIGINAL IMAGES. YOU COULD USE ‘GOOGLE +TAKEOUT’ TO RECOVER THE ORIGINAL PHOTOS AS A LAST RESORT + +Downloading Videos + +When videos are downloaded they are downloaded in a really compressed +version of the video compared to downloading it via the Google Photos +web interface. This is covered by bug #113672044. + +Duplicates + +If a file name is duplicated in a directory then rclone will add the +file ID into its name. So two files called file.jpg would then appear as +file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer +alas!). + +If you upload the same image (with the same binary data) twice then +Google Photos will deduplicate it. However it will retain the filename +from the first upload which may confuse rclone. For example if you +uploaded an image to upload then uploaded the same image to +album/my_album the filename of the image in album/my_album will be what +it was uploaded with initially, not what you uploaded it with to album. +In practise this shouldn’t cause too many problems. + +Modified time + +The date shown of media in Google Photos is the creation date as +determined by the EXIF information, or the upload date if that is not +known. + +This is not changeable by rclone and is not the modification date of the +media on local disk. This means that rclone cannot use the dates from +Google Photos for syncing purposes. + +Size + +The Google Photos API does not return the size of media. This means that +when syncing to Google Photos, rclone can only do a file existence +check. + +It is possible to read the size of the media, but this needs an extra +HTTP HEAD request per media item so is VERY SLOW and uses up a lot of +transactions. This can be enabled with the --gphotos-read-size option or +the read_size = true config parameter. + +If you want to use the backend with rclone mount you may need to enable +this flag (depending on your OS and application using the photos) +otherwise you may not be able to read media off the mount. You’ll need +to experiment to see if it works for you without the flag. + +Albums + +Rclone can only upload files to albums it created. This is a limitation +of the Google Photos API. + +Rclone can remove files it uploaded from albums it created only. + +Deleting files + +Rclone can remove files from albums it created, but note that the Google +Photos API does not allow media to be deleted permanently so this media +will still remain. See bug #109759781. + +Rclone cannot delete files anywhere except under album. + +Deleting albums + +The Google Photos API does not support deleting albums - see bug +#135714733. + +Standard Options + +Here are the standard options specific to google photos (Google Photos). + +–gphotos-client-id + +Google Application Client Id Leave blank normally. + +- Config: client_id +- Env Var: RCLONE_GPHOTOS_CLIENT_ID +- Type: string +- Default: "" + +–gphotos-client-secret + +Google Application Client Secret Leave blank normally. + +- Config: client_secret +- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +- Type: string +- Default: "" + +–gphotos-read-only + +Set to make the Google Photos backend read only. If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. 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-read-size - See all the albums in your photos +Set to read the size of media items. - rclone lsd remote:album +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. - Make a new album +- Config: read_size +- Env Var: RCLONE_GPHOTOS_READ_SIZE +- Type: bool +- Default: false - rclone mkdir remote:album/newAlbum - List the contents of an album - - rclone ls remote:album/newAlbum - - Sync /home/local/images to the Google Photos, removing any excess files in the album. - - rclone sync /home/local/image remote:album/newAlbum - - ## Layout - - As Google Photos is not a general purpose cloud storage system the backend is laid out to help you navigate it. - - The directories under media show different ways of categorizing the media. Each file will appear multiple times. So if you want to make a backup of your google photos you might choose to backup remote:media/by-month. (NB remote:media/by-day is rather slow at the moment so avoid for syncing.) - - Note that all your photos and videos will appear somewhere under media, but they may not appear under album unless you’ve put them into albums. - - / - upload - file1.jpg - file2.jpg - ... - media - all - file1.jpg - file2.jpg - ... - by-year - 2000 - file1.jpg - ... - 2001 - file2.jpg - ... - ... - by-month - 2000 - 2000-01 - file1.jpg - ... - 2000-02 - file2.jpg - ... - ... - by-day - 2000 - 2000-01-01 - file1.jpg - ... - 2000-01-02 - file2.jpg - ... - ... - album - album name - album name/sub - shared-album - album name - album name/sub - - There are two writable parts of the tree, the upload directory and sub directories of the the album directory. - - The upload directory is for uploading files you don’t want to put into albums. This will be empty to start with and will contain the files you’ve uploaded for one rclone session only, becoming empty again when you restart rclone. The use case for this would be if you have a load of files you just want to once off dump into Google Photos. For repeated syncing, uploading to album will work better. - - Directories within the album directory are also writeable and you may create new directories (albums) under album. If you copy files with a directory hierarchy in there then rclone will create albums with the / character in them. For example if you do - - rclone copy /path/to/images remote:album/images - - and the images directory contains - - images - file1.jpg dir file2.jpg dir2 dir3 file3.jpg - - Then rclone will create the following albums with the following files in - - - images - file1.jpg - images/dir - file2.jpg - images/dir2/dir3 - file3.jpg - - This means that you can use the album path pretty much like a normal filesystem and it is a good target for repeated syncing. - - The shared-album directory shows albums shared with you or by you. This is similar to the Sharing tab in the Google Photos web interface. - - ## Limitations - - Only images and videos can be uploaded. If you attempt to upload non videos or images or formats that Google Photos doesn’t understand, rclone will upload the file, then Google Photos will give an error when it is put turned into a media item. - - Note that all media items uploaded to Google Photos through the API are stored in full resolution at “original quality” and WILL count towards your storage quota in your Google Account. The API does NOT offer a way to upload in “high quality” mode.. - - ### Downloading Images - - When Images are downloaded this strips EXIF location (according to the docs and my tests). This is a limitation of the Google Photos API and is covered by bug #112096115. - - THE CURRENT GOOGLE API DOES NOT ALLOW PHOTOS TO BE DOWNLOADED AT ORIGINAL RESOLUTION. THIS IS VERY IMPORTANT IF YOU ARE, FOR EXAMPLE, RELYING ON “GOOGLE PHOTOS” AS A BACKUP OF YOUR PHOTOS. YOU WILL NOT BE ABLE TO USE RCLONE TO REDOWNLOAD ORIGINAL IMAGES. YOU COULD USE ‘GOOGLE TAKEOUT’ TO RECOVER THE ORIGINAL PHOTOS AS A LAST RESORT - - ### Downloading Videos - - When videos are downloaded they are downloaded in a really compressed version of the video compared to downloading it via the Google Photos web interface. This is covered by bug #113672044. - - ### Duplicates - - If a file name is duplicated in a directory then rclone will add the file ID into its name. So two files called file.jpg would then appear as file {123456}.jpg and file {ABCDEF}.jpg (the actual IDs are a lot longer alas!). - - If you upload the same image (with the same binary data) twice then Google Photos will deduplicate it. However it will retain the filename from the first upload which may confuse rclone. For example if you uploaded an image to upload then uploaded the same image to album/my_album the filename of the image in album/my_album will be what it was uploaded with initially, not what you uploaded it with - to album. In practise this shouldn’t cause too many problems. - - ### Modified time - - The date shown of media in Google Photos is the creation date as determined by the EXIF information, or the upload date if that is not known. - - This is not changeable by rclone and is not the modification date of the media on local disk. This means that rclone cannot use the dates from Google Photos for syncing purposes. - - ### Size - - The Google Photos API does not return the size of media. This means that when syncing to Google Photos, rclone can only do a file existence check. - - It is possible to read the size of the media, but this needs an extra HTTP HEAD request per media item so is VERY SLOW and uses up a lot of transactions. This can be enabled with the --gphotos-read-size option or the read_size = true config parameter. - - If you want to use the backend with rclone mount you may need to enable this flag (depending on your OS and application using the photos) otherwise you may not be able to read media off the mount. You’ll need to experiment to see if it works for you without the flag. - - ### Albums - - Rclone can only upload files to albums it created. This is a limitation of the Google Photos API. - - Rclone can remove files it uploaded from albums it created only. - - ### Deleting files - - Rclone can remove files from albums it created, but note that the Google Photos API does not allow media to be deleted permanently so this media will still remain. See bug #109759781. - - Rclone cannot delete files anywhere except under album. - - ### Deleting albums - - The Google Photos API does not support deleting albums - see bug #135714733. - - ### Standard Options - - Here are the standard options specific to google photos (Google Photos). - - #### –gphotos-client-id - - Google Application Client Id Leave blank normally. - - - Config: client_id - Env Var: RCLONE_GPHOTOS_CLIENT_ID - Type: string - Default: "" - - #### –gphotos-client-secret - - Google Application Client Secret Leave blank normally. - - - Config: client_secret - Env Var: RCLONE_GPHOTOS_CLIENT_SECRET - Type: string - Default: "" - - #### –gphotos-read-only - - Set to make the Google Photos backend read only. - - If you choose read only then rclone will only request read only access to your photos, otherwise rclone will request full access. - - - Config: read_only - Env Var: RCLONE_GPHOTOS_READ_ONLY - Type: bool - Default: false - - ### Advanced Options - - Here are the advanced options specific to google photos (Google Photos). - - #### –gphotos-read-size - - Set to read the size of media items. - - Normally rclone does not read the size of media items since this takes another transaction. This isn’t necessary for syncing. However rclone mount needs to know the size of files in advance of reading them, so setting this flag when using rclone mount is recommended if you want to read the media. - - - Config: read_size - Env Var: RCLONE_GPHOTOS_READ_SIZE - Type: bool - Default: false - - HTTP - --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +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 @@ -14544,6 +16148,17 @@ copy operations. - Type: bool - Default: false +–hubic-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_HUBIC_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + Limitations This uses the normal OpenStack Swift mechanism to refresh the Swift API @@ -14560,8 +16175,10 @@ Paths are specified as remote:path Paths may be as deep as required, eg remote:directory/subdirectory. -To configure Jottacloud you will need to enter your username and -password and select a mountpoint. +To configure Jottacloud you will need to generate a personal security +token in the Jottacloud web inteface. You will the option to do in your +account security settings. Note that the web inteface may refer to this +token as a JottaCli token. Here is an example of how to make a remote called remote. First run: @@ -14591,16 +16208,8 @@ This will guide you through an interactive setup process: y/n> n Remote config - Do you want to create a machine specific API key? - - Rclone has it's own Jottacloud API KEY which works fine as long as one only uses rclone on a single machine. When you want to use rclone with this account on more than one machine it's recommended to create a machine specific API key. These keys can NOT be shared between machines. - - y) Yes - n) No - y/n> y - Username> 0xC4KE@gmail.com - Your Jottacloud password is only required during setup and will not be stored. - password: + Generate a personal login token here: https://www.jottacloud.com/web/secure + Login Token> Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? @@ -14623,11 +16232,10 @@ This will guide you through an interactive setup process: [jotta] type = jottacloud user = 0xC4KE@gmail.com - client_id = ..... - client_secret = ........ token = {........} device = Jotta mountpoint = Archive + configVersion = 1 -------------------- y) Yes this is OK e) Edit this remote @@ -14655,8 +16263,8 @@ install it on and then creates a mountpoint for each folder you select for Backup. The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. In most cases you’ll want to use the Jotta/Archive device/mounpoint however if you want to access files -uploaded by the official rclone provides the option to select other -devices and mountpoints during config. +uploaded by any of the official clients rclone provides the option to +select other devices and mountpoints during config. –fast-list @@ -14774,6 +16382,18 @@ Files bigger than this can be resumed if the upload fail’s. - Type: SizeSuffix - Default: 10M +–jottacloud-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_JOTTACLOUD_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot + Limitations Note that Jottacloud is case insensitive so you can’t have a file called @@ -14939,6 +16559,17 @@ you use a mount ID that points to a Dropbox or Amazon Drive backend. - Type: bool - Default: true +–koofr-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_KOOFR_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + Limitations Note that Koofr is case insensitive so you can’t have a file called @@ -15247,6 +16878,18 @@ binlist gzip insecure retry400 - Type: string - Default: "" +–mailru-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_MAILRU_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot + Mega @@ -15443,6 +17086,17 @@ permanently delete objects instead. - Type: bool - Default: false +–mega-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_MEGA_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + Limitations This backend uses the go-mega go library which is an opensource go @@ -15453,6 +17107,62 @@ 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. + +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 + 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 / Memory + \ "memory" + [snip] + Storage> memory + ** See help for memory backend at: https://rclone.org/memory/ ** + + Remote config + + -------------------- + [remote] + type = memory + -------------------- + 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 + + rclone mount :memory: /mnt/tmp + rclone serve webdav :memory: + rclone serve sftp :memory: + +Modified time and hashes + +The memory backend supports MD5 hashes and modification times accurate +to 1 nS. + +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 @@ -15722,6 +17432,17 @@ first restore by tiering blob to “Hot” or “Cool”. - Type: string - Default: "" +–azureblob-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_AZUREBLOB_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 + Limitations MD5 sums are only uploaded with chunked files if the source has an MD5 @@ -15849,18 +17570,20 @@ To copy a local directory to an OneDrive directory called backup Getting your own Client ID and Key -rclone uses a pair of Client ID and Key shared by all rclone users when -performing requests by default. If you are having problems with them -(E.g., seeing a lot of throttling), you can get your own Client ID and -Key by following the steps below: +You can use your own Client ID if the default (client_id left blank) one +doesn’t work for you or you see lots of throttling. The default Client +ID and Key is shared by all rclone users when performing requests. + +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, then click New registration. -2. Enter a name for your app, choose your account type, select Web in - Redirect URI Enter http://localhost:53682/ and click Register. Copy - and keep the Application (client) ID under the app name for later - use. +2. Enter a name for your app, choose account type + Any Azure AD directory - Multitenant, select Web in Redirect URI + Enter http://localhost:53682/ and click Register. Copy and keep the + Application (client) ID under the app name for later use. 3. Under manage select Certificates & secrets, click New client secret. Copy and keep that secret for later use. 4. Under manage select API permissions, click Add a permission and @@ -16001,6 +17724,18 @@ set this option. - Type: bool - Default: false +–onedrive-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview 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 + Limitations Naming @@ -16251,6 +17986,34 @@ Password. - Type: string - Default: "" +Advanced Options + +Here are the advanced options specific to opendrive (OpenDrive). + +–opendrive-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_OPENDRIVE_ENCODING +- Type: MultiEncoder +- Default: + Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot + +–opendrive-chunk-size + +Files will be uploaded in chunks this size. + +Note that these chunks are buffered in memory so increasing them will +increase memory use. + +- Config: chunk_size +- Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 10M + Limitations Note that OpenDrive is case insensitive so you can’t have a file called @@ -16524,6 +18287,17 @@ this may help to speed up the transfers. - Type: int - Default: 1 +–qingstor-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_QINGSTOR_ENCODING +- Type: MultiEncoder +- Default: Slash,Ctl,InvalidUtf8 + Swift @@ -16583,7 +18357,7 @@ This will guide you through an interactive setup process. 5 / Memset Memstore UK v2 \ "https://auth.storage.memset.com/v2.0" 6 / OVH - \ "https://auth.cloud.ovh.net/v2.0" + \ "https://auth.cloud.ovh.net/v3" auth> User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). user_id> @@ -16794,7 +18568,7 @@ Authentication URL for server (OS_AUTH_URL). - Memset Memstore UK - “https://auth.storage.memset.com/v2.0” - Memset Memstore UK v2 - - “https://auth.cloud.ovh.net/v2.0” + - “https://auth.cloud.ovh.net/v3” - OVH –swift-user-id @@ -16980,6 +18754,17 @@ copy operations. - Type: bool - Default: false +–swift-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_SWIFT_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + Modified time The modified time is stored as metadata on the object as @@ -17151,6 +18936,21 @@ Pcloud App Client Secret Leave blank normally. - Type: string - Default: "" +Advanced Options + +Here are the advanced options specific to pcloud (Pcloud). + +–pcloud-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_PCLOUD_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + premiumize.me @@ -17262,6 +19062,21 @@ This is not normally used - use oauth instead. - Type: string - Default: "" +Advanced Options + +Here are the advanced options specific to premiumizeme (premiumize.me). + +–premiumizeme-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_PREMIUMIZEME_ENCODING +- Type: MultiEncoder +- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot + Limitations Note that premiumize.me is case insensitive so you can’t have a file @@ -17374,6 +19189,21 @@ characters are also replaced: Invalid UTF-8 bytes will also be replaced, as they can’t be used in JSON strings. +Advanced Options + +Here are the advanced options specific to putio (Put.io). + +–putio-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_PUTIO_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + SFTP @@ -17696,6 +19526,15 @@ The command used to read sha1 hashes. Leave blank for autodetect. - Type: string - Default: "" +–sftp-skip-links + +Set to skip any symlinks and any other non regular files. + +- Config: skip_links +- Env Var: RCLONE_SFTP_SKIP_LINKS +- Type: bool +- Default: false + Limitations SFTP supports checksums if the same login has shell access and md5sum or @@ -17747,6 +19586,245 @@ rsync.net is supported through the SFTP backend. See rsync.net’s documentation of rclone examples. +SugarSync + +SugarSync is a cloud service that enables active synchronization of +files across computers and other devices for file backup, access, +syncing, and sharing. + +The initial setup for SugarSync involves getting a token from SugarSync +which you can do with rclone. 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 / Sugarsync + \ "sugarsync" + [snip] + Storage> sugarsync + ** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** + + Sugarsync App ID. + Leave blank to use rclone's. + Enter a string value. Press Enter for the default (""). + app_id> + Sugarsync Access Key ID. + Leave blank to use rclone's. + Enter a string value. Press Enter for the default (""). + access_key_id> + Sugarsync Private Access Key + Leave blank to use rclone's. + Enter a string value. Press Enter for the default (""). + private_access_key> + Permanently delete files if true + otherwise put them in the deleted files. + Enter a boolean value (true or false). Press Enter for the default ("false"). + hard_delete> + Edit advanced config? (y/n) + y) Yes + n) No (default) + y/n> n + Remote config + Username (email address)> nick@craig-wood.com + Your Sugarsync password is only required during setup and will not be stored. + password: + -------------------- + [remote] + type = sugarsync + refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX + -------------------- + y) Yes this is OK (default) + e) Edit this remote + d) Delete this remote + y/e/d> y + +Note that the config asks for your email and password but doesn’t store +them, it only uses them to get the initial token. + +Once configured you can then use rclone like this, + +List directories (sync folders) in top level of your SugarSync + + rclone lsd remote: + +List all the files in your SugarSync folder “Test” + + rclone ls remote:Test + +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. + +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 + +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 + +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 + +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 + +Here are the standard options specific to sugarsync (Sugarsync). + +–sugarsync-app-id + +Sugarsync App ID. + +Leave blank to use rclone’s. + +- Config: app_id +- Env Var: RCLONE_SUGARSYNC_APP_ID +- Type: string +- Default: "" + +–sugarsync-access-key-id + +Sugarsync Access Key ID. + +Leave blank to use rclone’s. + +- Config: access_key_id +- Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID +- Type: string +- Default: "" + +–sugarsync-private-access-key + +Sugarsync Private Access Key + +Leave blank to use rclone’s. + +- Config: private_access_key +- Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY +- Type: string +- Default: "" + +–sugarsync-hard-delete + +Permanently delete files if true otherwise put them in the deleted +files. + +- Config: hard_delete +- Env Var: RCLONE_SUGARSYNC_HARD_DELETE +- Type: bool +- Default: false + +Advanced Options + +Here are the advanced options specific to sugarsync (Sugarsync). + +–sugarsync-refresh-token + +Sugarsync refresh token + +Leave blank normally, will be auto configured by rclone. + +- Config: refresh_token +- Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN +- Type: string +- Default: "" + +–sugarsync-authorization + +Sugarsync authorization + +Leave blank normally, will be auto configured by rclone. + +- Config: authorization +- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION +- Type: string +- Default: "" + +–sugarsync-authorization-expiry + +Sugarsync authorization expiry + +Leave blank normally, will be auto configured by rclone. + +- Config: authorization_expiry +- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY +- Type: string +- Default: "" + +–sugarsync-user + +Sugarsync user + +Leave blank normally, will be auto configured by rclone. + +- Config: user +- Env Var: RCLONE_SUGARSYNC_USER +- Type: string +- Default: "" + +–sugarsync-root-id + +Sugarsync root id + +Leave blank normally, will be auto configured by rclone. + +- Config: root_id +- Env Var: RCLONE_SUGARSYNC_ROOT_ID +- Type: string +- Default: "" + +–sugarsync-deleted-id + +Sugarsync deleted folder id + +Leave blank normally, will be auto configured by rclone. + +- Config: deleted_id +- Env Var: RCLONE_SUGARSYNC_DELETED_ID +- Type: string +- Default: "" + +–sugarsync-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_SUGARSYNC_ENCODING +- Type: MultiEncoder +- Default: Slash,Ctl,InvalidUtf8,Dot + + Union The union remote provides a unification similar to UnionFS using other @@ -18321,6 +20399,17 @@ public link. - Type: bool - Default: false +–yandex-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_YANDEX_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,InvalidUtf8,Dot + Local Filesystem @@ -18702,11 +20791,242 @@ override the default choice. - Type: bool - Default: false +–local-encoding + +This sets the encoding for the backend. + +See: the encoding section in the overview for more info. + +- Config: encoding +- Env Var: RCLONE_LOCAL_ENCODING +- Type: MultiEncoder +- Default: Slash,Dot + CHANGELOG +v1.51.0 - 2020-02-01 + +- New backends + - Memory (Nick Craig-Wood) + - Sugarsync (Nick Craig-Wood) +- New Features + - Adjust all backends to have --backend-encoding parameter (Nick + Craig-Wood) + - this enables the encoding for special characters to be + adjusted or disabled + - Add --max-duration flag to control the maximum duration of a + transfer session (boosh) + - Add --expect-continue-timeout flag, default 1s (Nick Craig-Wood) + - Add --no-check-dest flag for copying without testing the + destination (Nick Craig-Wood) + - Implement --order-by flag to order transfers (Nick Craig-Wood) + - accounting + - Don’t show entries in both transferring and checking (Nick + Craig-Wood) + - Add option to delete stats (Aleksandar Jankovic) + - build + - Compress the test builds with gzip (Nick Craig-Wood) + - Implement a framework for starting test servers during tests + (Nick Craig-Wood) + - cmd: Always print elapsed time to tenth place seconds in + progress (Gary Kim) + - config + - Add --password-command to allow dynamic config password + (Damon Permezel) + - Give config questions default values (Nick Craig-Wood) + - Check a remote exists when creating a new one (Nick + Craig-Wood) + - copyurl: Add --stdout flag to write to stdout (Nick Craig-Wood) + - dedupe: Implement keep smallest too (Nick Craig-Wood) + - hashsum: Add flag --base64 flag (landall) + - lsf: Speed up on s3/swift/etc by not reading mimetype by default + (Nick Craig-Wood) + - lsjson: Add --no-mimetype flag (Nick Craig-Wood) + - rc: Add methods to turn on blocking and mutex profiling (Nick + Craig-Wood) + - rcd + - Adding group parameter to stats (Chaitanya) + - Move webgui apart; option to disable browser (Xiaoxing Ye) + - serve sftp: Add support for public key with auth proxy (Paul + Tinsley) + - stats: Show deletes in stats and hide zero stats (anuar45) +- Bug Fixes + - accounting + - Fix error counter counting multiple times (Ankur Gupta) + - Fix error count shown as checks (Cnly) + - Clear finished transfer in stats-reset (Maciej Zimnoch) + - Added StatsInfo locking in statsGroups sum function (Michał + Matczuk) + - asyncreader: Fix EOF error (buengese) + - check: Fix --one-way recursing more directories than it needs to + (Nick Craig-Wood) + - chunkedreader: Disable hash calculation for first segment (Nick + Craig-Wood) + - config + - Do not open browser on headless on drive/gcs/google photos + (Xiaoxing Ye) + - SetValueAndSave ignore error if config section does not + exist yet (buengese) + - cmd: Fix completion with an encrypted config (Danil Semelenov) + - 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) + - 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) + - Make NewOverrideObjectInfo public and factor uses (Nick + Craig-Wood) + - proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood) + - vendor + - Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood) + - Update github.com/t3rm1n4l/go-mega to fix mega “illegal + base64 data at input byte 22” (Nick Craig-Wood) + - Update termbox-go to fix ncdu command on FreeBSD (Kuang-che + Wu) + - Update t3rm1n4l/go-mega - fixes mega: couldn’t login: + crypto/aes: invalid key size 0 (Nick Craig-Wood) +- Mount + - Enable async reads for a 20% speedup (Nick Craig-Wood) + - Replace use of WriteAt with Write for cache mode >= writes and + O_APPEND (Brett Dutro) + - Make sure we call unmount when exiting (Nick Craig-Wood) + - Don’t build on go1.10 as bazil/fuse no longer supports it (Nick + Craig-Wood) + - When setting dates discard out of range dates (Nick Craig-Wood) +- VFS + - Add a newly created file straight into the directory (Nick + Craig-Wood) + - Only calculate one hash for reads for a speedup (Nick + Craig-Wood) + - Make ReadAt for non cached files work better with non-sequential + reads (Nick Craig-Wood) + - Fix edge cases when reading ModTime from file (Nick Craig-Wood) + - Make sure existing files opened for write show correct size + (Nick Craig-Wood) + - Don’t cache the path in RW file objects to fix renaming (Nick + Craig-Wood) + - Fix rename of open files when using the VFS cache (Nick + Craig-Wood) + - When renaming files in the cache, rename the cache item in + memory too (Nick Craig-Wood) + - Fix open file renaming on drive when using + --vfs-cache-mode writes (Nick Craig-Wood) + - Fix incorrect modtime for mv into mount with + --vfs-cache-modes writes (Nick Craig-Wood) + - On rename, rename in cache too if the file exists (Anagh Kumar + Baranwal) +- Local + - Make source file being updated errors be NoLowLevelRetry errors + (Nick Craig-Wood) + - Fix update of hidden files on Windows (Nick Craig-Wood) +- Cache + - Follow move of upstream library github.com/coreos/bbolt + github.com/etcd-io/bbolt (Nick Craig-Wood) + - Fix fatal error: concurrent map writes (Nick Craig-Wood) +- Crypt + - Reorder the filename encryption options (Thomas Eales) + - Correctly handle trailing dot (buengese) +- Chunker + - Reduce length of temporary suffix (Ivan Andreev) +- Drive + - Add --drive-stop-on-upload-limit flag to stop syncs when upload + limit reached (Nick Craig-Wood) + - Add --drive-use-shared-date to use date file was shared instead + of modified date (Garry McNulty) + - Make sure invalid auth for teamdrives always reports an error + (Nick Craig-Wood) + - Fix --fast-list when using appDataFolder (Nick Craig-Wood) + - Use multipart resumable uploads for streaming and uploads in + mount (Nick Craig-Wood) + - Log an ERROR if an incomplete search is returned (Nick + Craig-Wood) + - Hide dangerous config from the configurator (Nick Craig-Wood) +- Dropbox + - Treat insufficient_space errors as non retriable errors (Nick + Craig-Wood) +- Jottacloud + - Use new auth method used by official client (buengese) + - Add URL to generate Login Token to config wizard (Nick + Craig-Wood) + - Add support whitelabel versions (buengese) +- Koofr + - Use rclone HTTP client. (jaKa) +- Onedrive + - Add Sites.Read.All permission (Benjamin Richter) + - Add support “Retry-After” header (Motonori IWAMURO) +- Opendrive + - Implement --opendrive-chunk-size (Nick Craig-Wood) +- 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) + - 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) + - Use AWS web identity role provider if available (Tennix) + - Fix ExpiryWindow value (Aleksandar Jankovic) + - Fix DisableChecksum condition (Aleksandar Janković) + - Fix URL decoding of NextMarker (Nick Craig-Wood) +- SFTP + - Add --sftp-skip-links to skip symlinks and non regular files + (Nick Craig-Wood) + - Retry Creation of Connection (Sebastian Brandt) + - Fix “failed to parse private key file: ssh: not an encrypted + key” error (Nick Craig-Wood) + - Open files for update write only to fix AWS SFTP interop (Nick + Craig-Wood) +- Swift + - Reserve segments of dynamic large object when delete objects in + container what was enabled versioning. (Nguyễn Hữu Luân) + - Fix parsing of X-Object-Manifest (Nick Craig-Wood) + - Update OVH API endpoint (unbelauscht) +- WebDAV + - Make nextcloud only upload SHA1 checksums (Nick Craig-Wood) + - Fix case of “Bearer” in Authorization: header to agree with RFC + (Nick Craig-Wood) + - Add Referer header to fix problems with WAFs (Nick Craig-Wood) + + +v1.50.2 - 2019-11-19 + +- Bug Fixes + - accounting: Fix memory leak on retries operations (Nick + Craig-Wood) +- Drive + - Fix listing of the root directory with drive.files scope (Nick + Craig-Wood) + - Fix –drive-root-folder-id with team/shared drives (Nick + Craig-Wood) + + +v1.50.1 - 2019-11-02 + +- Bug Fixes + - hash: Fix accidentally changed hash names for DropboxHash and + CRC-32 (Nick Craig-Wood) + - fshttp: Fix error reporting on tpslimit token bucket errors + (Nick Craig-Wood) + - fshttp: Don’t print token bucket errors on context cancelled + (Nick Craig-Wood) +- Local + - Fix listings of . on Windows (Nick Craig-Wood) +- Onedrive + - Fix DirMove/Move after Onedrive change (Xiaoxing Ye) + + v1.50.0 - 2019-10-26 - New backends @@ -21858,6 +24178,7 @@ Contributors - albertony 12441419+albertony@users.noreply.github.com - cron410 cron410@gmail.com - Anagh Kumar Baranwal anaghk.dos@gmail.com + 6824881+darthShadow@users.noreply.github.com - Felix Brucker felix@felixbrucker.com - Santiago Rodríguez scollazo@users.noreply.github.com - Craig Miskell craig.miskell@fluxfederation.com @@ -21928,7 +24249,8 @@ Contributors - garry415 garry.415@gmail.com - forgems forgems@gmail.com - Florian Apolloner florian@apolloner.eu -- Aleksandar Jankovic office@ajankovic.com +- Aleksandar Janković office@ajankovic.com + ajankovic@users.noreply.github.com - Maran maran@protonmail.com - nguyenhuuluan434 nguyenhuuluan434@gmail.com - Laura Hausmann zotan@zotan.pw laura@hausmann.dev @@ -21971,6 +24293,34 @@ Contributors - Carlos Ferreyra crypticmind@gmail.com - Saksham Khanna sakshamkhanna@outlook.com - dausruddin 5763466+dausruddin@users.noreply.github.com +- zero-24 zero-24@users.noreply.github.com +- Xiaoxing Ye ye@xiaoxing.us +- Barry Muldrey barry@muldrey.net +- Sebastian Brandt sebastian.brandt@friday.de +- Marco Molteni marco.molteni@mailbox.org +- Ankur Gupta ankur0493@gmail.com +- Maciej Zimnoch maciej@scylladb.com +- anuar45 serdaliyev.anuar@gmail.com +- Fernando ferferga@users.noreply.github.com +- David Cole david.cole@sohonet.com +- Wei He git@weispot.com +- Outvi V 19144373+outloudvi@users.noreply.github.com +- Thomas Kriechbaumer thomas@kriechbaumer.name +- Tennix tennix@users.noreply.github.com +- Ole Schütt ole@schuett.name +- Kuang-che Wu kcwu@csie.org +- Thomas Eales wingsuit@users.noreply.github.com +- Paul Tinsley paul.tinsley@vitalsource.com +- Felix Hungenberg git@shiftgeist.com +- Benjamin Richter github@dev.telepath.de +- landall cst_zf@qq.com +- thestigma thestigma@gmail.com +- jtagcat 38327267+jtagcat@users.noreply.github.com +- Damon Permezel permezel@me.com +- boosh boosh@users.noreply.github.com +- unbelauscht 58393353+unbelauscht@users.noreply.github.com +- Motonori IWAMURO vmi@nifty.com +- Benjapol Worakan benwrk@live.com diff --git a/RELEASE.md b/RELEASE.md index 3f5e4c5db..13847ab11 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -9,12 +9,13 @@ This file describes how to make the various kinds of releases ## Making a release + * git checkout master + * git pull * git status - make sure everything is checked in - * Check travis & appveyor builds are green - * make check + * Check GitHub actions build for master is Green * make test # see integration test server or run locally * make tag - * edit docs/content/changelog.md + * edit docs/content/changelog.md # make sure to remove duplicate logs from point releases * make tidy * make doc * git status - to check for new man pages - git add them diff --git a/VERSION b/VERSION index fe006243c..367a88407 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v1.50.2 +v1.51.0 diff --git a/docs/content/amazonclouddrive.md b/docs/content/amazonclouddrive.md index ecf8af28a..77fbb1fc4 100644 --- a/docs/content/amazonclouddrive.md +++ b/docs/content/amazonclouddrive.md @@ -262,6 +262,17 @@ underlying S3 storage. - Type: SizeSuffix - Default: 9G +#### --acd-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_ACD_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/azureblob.md b/docs/content/azureblob.md index ba0be75fb..9b5863f4b 100644 --- a/docs/content/azureblob.md +++ b/docs/content/azureblob.md @@ -272,6 +272,17 @@ tiering blob to "Hot" or "Cool". - Type: string - Default: "" +#### --azureblob-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_AZUREBLOB_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 + ### Limitations ### diff --git a/docs/content/b2.md b/docs/content/b2.md index d9607e695..93f4ba90c 100644 --- a/docs/content/b2.md +++ b/docs/content/b2.md @@ -457,5 +457,16 @@ The minimum value is 1 second. The maximum value is one week. - Type: Duration - Default: 1w +#### --b2-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_B2_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + diff --git a/docs/content/box.md b/docs/content/box.md index 25a25a097..dcdcf0968 100644 --- a/docs/content/box.md +++ b/docs/content/box.md @@ -298,6 +298,17 @@ Max number of times to try committing a multipart file. - Type: int - Default: 100 +#### --box-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_BOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/changelog.md b/docs/content/changelog.md index bace6c6be..23f64599f 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -1,11 +1,148 @@ --- title: "Documentation" description: "Rclone Changelog" -date: "2019-11-19" +date: "2020-02-01" --- # Changelog +## v1.51.0 - 2020-02-01 + +* New backends + * [Memory](/memory) (Nick Craig-Wood) + * [Sugarsync](/sugarsync) (Nick Craig-Wood) +* New Features + * Adjust all backends to have `--backend-encoding` parameter (Nick Craig-Wood) + * this enables the encoding for special characters to be adjusted or disabled + * Add `--max-duration` flag to control the maximum duration of a transfer session (boosh) + * Add `--expect-continue-timeout` flag, default 1s (Nick Craig-Wood) + * Add `--no-check-dest` flag for copying without testing the destination (Nick Craig-Wood) + * Implement `--order-by` flag to order transfers (Nick Craig-Wood) + * accounting + * Don't show entries in both transferring and checking (Nick Craig-Wood) + * Add option to delete stats (Aleksandar Jankovic) + * build + * Compress the test builds with gzip (Nick Craig-Wood) + * Implement a framework for starting test servers during tests (Nick Craig-Wood) + * cmd: Always print elapsed time to tenth place seconds in progress (Gary Kim) + * config + * Add `--password-command` to allow dynamic config password (Damon Permezel) + * Give config questions default values (Nick Craig-Wood) + * Check a remote exists when creating a new one (Nick Craig-Wood) + * copyurl: Add `--stdout` flag to write to stdout (Nick Craig-Wood) + * dedupe: Implement keep smallest too (Nick Craig-Wood) + * hashsum: Add flag `--base64` flag (landall) + * lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick Craig-Wood) + * lsjson: Add `--no-mimetype` flag (Nick Craig-Wood) + * rc: Add methods to turn on blocking and mutex profiling (Nick Craig-Wood) + * rcd + * Adding group parameter to stats (Chaitanya) + * Move webgui apart; option to disable browser (Xiaoxing Ye) + * serve sftp: Add support for public key with auth proxy (Paul Tinsley) + * stats: Show deletes in stats and hide zero stats (anuar45) +* Bug Fixes + * accounting + * Fix error counter counting multiple times (Ankur Gupta) + * Fix error count shown as checks (Cnly) + * Clear finished transfer in stats-reset (Maciej Zimnoch) + * Added StatsInfo locking in statsGroups sum function (Michał Matczuk) + * asyncreader: Fix EOF error (buengese) + * check: Fix `--one-way` recursing more directories than it needs to (Nick Craig-Wood) + * chunkedreader: Disable hash calculation for first segment (Nick Craig-Wood) + * config + * Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye) + * SetValueAndSave ignore error if config section does not exist yet (buengese) + * cmd: Fix completion with an encrypted config (Danil Semelenov) + * 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) + * 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) + * Make NewOverrideObjectInfo public and factor uses (Nick Craig-Wood) + * proxy: Replace use of bcrypt with sha256 (Nick Craig-Wood) + * vendor + * Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig-Wood) + * Update github.com/t3rm1n4l/go-mega to fix mega "illegal base64 data at input byte 22" (Nick Craig-Wood) + * Update termbox-go to fix ncdu command on FreeBSD (Kuang-che Wu) + * Update t3rm1n4l/go-mega - fixes mega: couldn't login: crypto/aes: invalid key size 0 (Nick Craig-Wood) +* Mount + * Enable async reads for a 20% speedup (Nick Craig-Wood) + * Replace use of WriteAt with Write for cache mode >= writes and O_APPEND (Brett Dutro) + * Make sure we call unmount when exiting (Nick Craig-Wood) + * Don't build on go1.10 as bazil/fuse no longer supports it (Nick Craig-Wood) + * When setting dates discard out of range dates (Nick Craig-Wood) +* VFS + * Add a newly created file straight into the directory (Nick Craig-Wood) + * Only calculate one hash for reads for a speedup (Nick Craig-Wood) + * Make ReadAt for non cached files work better with non-sequential reads (Nick Craig-Wood) + * Fix edge cases when reading ModTime from file (Nick Craig-Wood) + * Make sure existing files opened for write show correct size (Nick Craig-Wood) + * Don't cache the path in RW file objects to fix renaming (Nick Craig-Wood) + * Fix rename of open files when using the VFS cache (Nick Craig-Wood) + * When renaming files in the cache, rename the cache item in memory too (Nick Craig-Wood) + * Fix open file renaming on drive when using `--vfs-cache-mode writes` (Nick Craig-Wood) + * Fix incorrect modtime for mv into mount with `--vfs-cache-modes writes` (Nick Craig-Wood) + * On rename, rename in cache too if the file exists (Anagh Kumar Baranwal) +* Local + * Make source file being updated errors be NoLowLevelRetry errors (Nick Craig-Wood) + * Fix update of hidden files on Windows (Nick Craig-Wood) +* Cache + * Follow move of upstream library github.com/coreos/bbolt github.com/etcd-io/bbolt (Nick Craig-Wood) + * Fix `fatal error: concurrent map writes` (Nick Craig-Wood) +* Crypt + * Reorder the filename encryption options (Thomas Eales) + * Correctly handle trailing dot (buengese) +* Chunker + * Reduce length of temporary suffix (Ivan Andreev) +* Drive + * Add `--drive-stop-on-upload-limit` flag to stop syncs when upload limit reached (Nick Craig-Wood) + * Add `--drive-use-shared-date` to use date file was shared instead of modified date (Garry McNulty) + * Make sure invalid auth for teamdrives always reports an error (Nick Craig-Wood) + * Fix `--fast-list` when using appDataFolder (Nick Craig-Wood) + * Use multipart resumable uploads for streaming and uploads in mount (Nick Craig-Wood) + * Log an ERROR if an incomplete search is returned (Nick Craig-Wood) + * Hide dangerous config from the configurator (Nick Craig-Wood) +* Dropbox + * Treat `insufficient_space` errors as non retriable errors (Nick Craig-Wood) +* Jottacloud + * Use new auth method used by official client (buengese) + * Add URL to generate Login Token to config wizard (Nick Craig-Wood) + * Add support whitelabel versions (buengese) +* Koofr + * Use rclone HTTP client. (jaKa) +* Onedrive + * Add Sites.Read.All permission (Benjamin Richter) + * Add support "Retry-After" header (Motonori IWAMURO) +* Opendrive + * Implement `--opendrive-chunk-size` (Nick Craig-Wood) +* 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) + * 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) + * Use AWS web identity role provider if available (Tennix) + * Add StackPath Object Storage Support (Dave Koston) + * Fix ExpiryWindow value (Aleksandar Jankovic) + * Fix DisableChecksum condition (Aleksandar Janković) + * Fix URL decoding of NextMarker (Nick Craig-Wood) +* SFTP + * Add `--sftp-skip-links` to skip symlinks and non regular files (Nick Craig-Wood) + * Retry Creation of Connection (Sebastian Brandt) + * Fix "failed to parse private key file: ssh: not an encrypted key" error (Nick Craig-Wood) + * Open files for update write only to fix AWS SFTP interop (Nick Craig-Wood) +* Swift + * Reserve segments of dynamic large object when delete objects in container what was enabled versioning. (Nguyễn Hữu Luân) + * Fix parsing of X-Object-Manifest (Nick Craig-Wood) + * Update OVH API endpoint (unbelauscht) +* WebDAV + * Make nextcloud only upload SHA1 checksums (Nick Craig-Wood) + * Fix case of "Bearer" in Authorization: header to agree with RFC (Nick Craig-Wood) + * Add Referer header to fix problems with WAFs (Nick Craig-Wood) + ## v1.50.2 - 2019-11-19 * Bug Fixes diff --git a/docs/content/commands/rclone.md b/docs/content/commands/rclone.md index 570568657..1c90ea73a 100644 --- a/docs/content/commands/rclone.md +++ b/docs/content/commands/rclone.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone" slug: rclone url: /commands/rclone/ diff --git a/docs/content/commands/rclone_about.md b/docs/content/commands/rclone_about.md index 3cd97b9a4..a761adf80 100644 --- a/docs/content/commands/rclone_about.md +++ b/docs/content/commands/rclone_about.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone about" slug: rclone_about url: /commands/rclone_about/ diff --git a/docs/content/commands/rclone_authorize.md b/docs/content/commands/rclone_authorize.md index b3176f4b7..4fba97e5a 100644 --- a/docs/content/commands/rclone_authorize.md +++ b/docs/content/commands/rclone_authorize.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone authorize" slug: rclone_authorize url: /commands/rclone_authorize/ @@ -15,6 +15,9 @@ 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] ``` @@ -22,8 +25,8 @@ rclone authorize [flags] ### Options ``` - --auth-no-open-browser Do not automatically open auth link in default browser - -h, --help help for authorize + --auth-no-open-browser Do not automatically open auth link in default browser + -h, --help help for authorize ``` See the [global flags page](/flags/) for global options not listed here. diff --git a/docs/content/commands/rclone_cachestats.md b/docs/content/commands/rclone_cachestats.md index 381191804..8009a4ec9 100644 --- a/docs/content/commands/rclone_cachestats.md +++ b/docs/content/commands/rclone_cachestats.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone cachestats" slug: rclone_cachestats url: /commands/rclone_cachestats/ diff --git a/docs/content/commands/rclone_cat.md b/docs/content/commands/rclone_cat.md index 1e769f732..0c57efac0 100644 --- a/docs/content/commands/rclone_cat.md +++ b/docs/content/commands/rclone_cat.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone cat" slug: rclone_cat url: /commands/rclone_cat/ diff --git a/docs/content/commands/rclone_check.md b/docs/content/commands/rclone_check.md index 23f04825e..bcdd976ae 100644 --- a/docs/content/commands/rclone_check.md +++ b/docs/content/commands/rclone_check.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone check" slug: rclone_check url: /commands/rclone_check/ diff --git a/docs/content/commands/rclone_cleanup.md b/docs/content/commands/rclone_cleanup.md index 023ef8809..efb458228 100644 --- a/docs/content/commands/rclone_cleanup.md +++ b/docs/content/commands/rclone_cleanup.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone cleanup" slug: rclone_cleanup url: /commands/rclone_cleanup/ diff --git a/docs/content/commands/rclone_config.md b/docs/content/commands/rclone_config.md index 1f752474f..59e7e1881 100644 --- a/docs/content/commands/rclone_config.md +++ b/docs/content/commands/rclone_config.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config" slug: rclone_config url: /commands/rclone_config/ diff --git a/docs/content/commands/rclone_config_create.md b/docs/content/commands/rclone_config_create.md index f28498473..4585d368d 100644 --- a/docs/content/commands/rclone_config_create.md +++ b/docs/content/commands/rclone_config_create.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config create" slug: rclone_config_create url: /commands/rclone_config_create/ diff --git a/docs/content/commands/rclone_config_delete.md b/docs/content/commands/rclone_config_delete.md index 677d8c463..c035f7dab 100644 --- a/docs/content/commands/rclone_config_delete.md +++ b/docs/content/commands/rclone_config_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config delete" slug: rclone_config_delete url: /commands/rclone_config_delete/ diff --git a/docs/content/commands/rclone_config_disconnect.md b/docs/content/commands/rclone_config_disconnect.md index 47a699d8d..43547e740 100644 --- a/docs/content/commands/rclone_config_disconnect.md +++ b/docs/content/commands/rclone_config_disconnect.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config disconnect" slug: rclone_config_disconnect url: /commands/rclone_config_disconnect/ diff --git a/docs/content/commands/rclone_config_dump.md b/docs/content/commands/rclone_config_dump.md index cec291bd6..22511784d 100644 --- a/docs/content/commands/rclone_config_dump.md +++ b/docs/content/commands/rclone_config_dump.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config dump" slug: rclone_config_dump url: /commands/rclone_config_dump/ diff --git a/docs/content/commands/rclone_config_edit.md b/docs/content/commands/rclone_config_edit.md index 7477be12c..18082df54 100644 --- a/docs/content/commands/rclone_config_edit.md +++ b/docs/content/commands/rclone_config_edit.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config edit" slug: rclone_config_edit url: /commands/rclone_config_edit/ diff --git a/docs/content/commands/rclone_config_file.md b/docs/content/commands/rclone_config_file.md index 238da3f6a..0d2cbeb2e 100644 --- a/docs/content/commands/rclone_config_file.md +++ b/docs/content/commands/rclone_config_file.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config file" slug: rclone_config_file url: /commands/rclone_config_file/ diff --git a/docs/content/commands/rclone_config_password.md b/docs/content/commands/rclone_config_password.md index 1a9f92c3a..c1f29adb9 100644 --- a/docs/content/commands/rclone_config_password.md +++ b/docs/content/commands/rclone_config_password.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config password" slug: rclone_config_password url: /commands/rclone_config_password/ diff --git a/docs/content/commands/rclone_config_providers.md b/docs/content/commands/rclone_config_providers.md index 01629fbb3..99037fe05 100644 --- a/docs/content/commands/rclone_config_providers.md +++ b/docs/content/commands/rclone_config_providers.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config providers" slug: rclone_config_providers url: /commands/rclone_config_providers/ diff --git a/docs/content/commands/rclone_config_reconnect.md b/docs/content/commands/rclone_config_reconnect.md index ee14fbe72..877304ff4 100644 --- a/docs/content/commands/rclone_config_reconnect.md +++ b/docs/content/commands/rclone_config_reconnect.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config reconnect" slug: rclone_config_reconnect url: /commands/rclone_config_reconnect/ diff --git a/docs/content/commands/rclone_config_show.md b/docs/content/commands/rclone_config_show.md index 3f8efbf3a..425a24e02 100644 --- a/docs/content/commands/rclone_config_show.md +++ b/docs/content/commands/rclone_config_show.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config show" slug: rclone_config_show url: /commands/rclone_config_show/ diff --git a/docs/content/commands/rclone_config_update.md b/docs/content/commands/rclone_config_update.md index 798e39d40..0ae9cc550 100644 --- a/docs/content/commands/rclone_config_update.md +++ b/docs/content/commands/rclone_config_update.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config update" slug: rclone_config_update url: /commands/rclone_config_update/ diff --git a/docs/content/commands/rclone_config_userinfo.md b/docs/content/commands/rclone_config_userinfo.md index 44eae7397..62a1e4f2e 100644 --- a/docs/content/commands/rclone_config_userinfo.md +++ b/docs/content/commands/rclone_config_userinfo.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone config userinfo" slug: rclone_config_userinfo url: /commands/rclone_config_userinfo/ diff --git a/docs/content/commands/rclone_copy.md b/docs/content/commands/rclone_copy.md index 62d9a158a..ab98f7ee9 100644 --- a/docs/content/commands/rclone_copy.md +++ b/docs/content/commands/rclone_copy.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone copy" slug: rclone_copy url: /commands/rclone_copy/ diff --git a/docs/content/commands/rclone_copyto.md b/docs/content/commands/rclone_copyto.md index e19b4d892..b3e3542ce 100644 --- a/docs/content/commands/rclone_copyto.md +++ b/docs/content/commands/rclone_copyto.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone copyto" slug: rclone_copyto url: /commands/rclone_copyto/ diff --git a/docs/content/commands/rclone_copyurl.md b/docs/content/commands/rclone_copyurl.md index 05a1833b6..d18942cac 100644 --- a/docs/content/commands/rclone_copyurl.md +++ b/docs/content/commands/rclone_copyurl.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone copyurl" slug: rclone_copyurl url: /commands/rclone_copyurl/ @@ -11,10 +11,15 @@ Copy url content to dest. ### Synopsis -Download urls content and copy it to destination -without saving it in tmp storage. +Download a URL's content and copy it to the destination without saving +it in temporary storage. -Setting --auto-filename flag will cause retrieving file name from url and using it in destination path. +Setting --auto-filename will cause the file name to be retreived from +the from URL (after any redirections) and used in the destination +path. + +Setting --stdout or making the output file name "-" will cause the +output to be written to standard output. ``` @@ -24,8 +29,9 @@ rclone copyurl https://example.com dest:path [flags] ### Options ``` - -a, --auto-filename Get the file name from the url and use it for destination file path + -a, --auto-filename Get the file name from the URL and use it for destination file path -h, --help help for copyurl + --stdout Write the output to stdout rather than a file ``` See the [global flags page](/flags/) for global options not listed here. diff --git a/docs/content/commands/rclone_cryptcheck.md b/docs/content/commands/rclone_cryptcheck.md index c2113c494..da3e72de6 100644 --- a/docs/content/commands/rclone_cryptcheck.md +++ b/docs/content/commands/rclone_cryptcheck.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone cryptcheck" slug: rclone_cryptcheck url: /commands/rclone_cryptcheck/ diff --git a/docs/content/commands/rclone_cryptdecode.md b/docs/content/commands/rclone_cryptdecode.md index 2b63f25f6..05b87e53e 100644 --- a/docs/content/commands/rclone_cryptdecode.md +++ b/docs/content/commands/rclone_cryptdecode.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone cryptdecode" slug: rclone_cryptdecode url: /commands/rclone_cryptdecode/ diff --git a/docs/content/commands/rclone_dbhashsum.md b/docs/content/commands/rclone_dbhashsum.md index 262ae2165..e627fd45e 100644 --- a/docs/content/commands/rclone_dbhashsum.md +++ b/docs/content/commands/rclone_dbhashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone dbhashsum" slug: rclone_dbhashsum url: /commands/rclone_dbhashsum/ diff --git a/docs/content/commands/rclone_dedupe.md b/docs/content/commands/rclone_dedupe.md index 7e036bac6..8163ac7e1 100644 --- a/docs/content/commands/rclone_dedupe.md +++ b/docs/content/commands/rclone_dedupe.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone dedupe" slug: rclone_dedupe url: /commands/rclone_dedupe/ @@ -81,6 +81,7 @@ Dedupe can be run non interactively using the `--dedupe-mode` flag or by using a * `--dedupe-mode newest` - removes identical files then keeps the newest one. * `--dedupe-mode oldest` - removes identical files then keeps the oldest one. * `--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. For example to rename all the identically named photos in your Google Photos directory, do @@ -99,7 +100,7 @@ rclone dedupe [mode] remote:path [flags] ### Options ``` - --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive") + --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 f94f376d3..972bbd2cb 100644 --- a/docs/content/commands/rclone_delete.md +++ b/docs/content/commands/rclone_delete.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone delete" slug: rclone_delete url: /commands/rclone_delete/ diff --git a/docs/content/commands/rclone_deletefile.md b/docs/content/commands/rclone_deletefile.md index c0851f647..360001baf 100644 --- a/docs/content/commands/rclone_deletefile.md +++ b/docs/content/commands/rclone_deletefile.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone deletefile" slug: rclone_deletefile url: /commands/rclone_deletefile/ diff --git a/docs/content/commands/rclone_genautocomplete.md b/docs/content/commands/rclone_genautocomplete.md index d6d6a4d3b..da18e186b 100644 --- a/docs/content/commands/rclone_genautocomplete.md +++ b/docs/content/commands/rclone_genautocomplete.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone genautocomplete" slug: rclone_genautocomplete url: /commands/rclone_genautocomplete/ diff --git a/docs/content/commands/rclone_genautocomplete_bash.md b/docs/content/commands/rclone_genautocomplete_bash.md index 6d2cb5198..7d83aef6b 100644 --- a/docs/content/commands/rclone_genautocomplete_bash.md +++ b/docs/content/commands/rclone_genautocomplete_bash.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone genautocomplete bash" slug: rclone_genautocomplete_bash url: /commands/rclone_genautocomplete_bash/ diff --git a/docs/content/commands/rclone_genautocomplete_zsh.md b/docs/content/commands/rclone_genautocomplete_zsh.md index 2706343f7..c5ce963ee 100644 --- a/docs/content/commands/rclone_genautocomplete_zsh.md +++ b/docs/content/commands/rclone_genautocomplete_zsh.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone genautocomplete zsh" slug: rclone_genautocomplete_zsh url: /commands/rclone_genautocomplete_zsh/ diff --git a/docs/content/commands/rclone_gendocs.md b/docs/content/commands/rclone_gendocs.md index fdbf565b3..3b38359e4 100644 --- a/docs/content/commands/rclone_gendocs.md +++ b/docs/content/commands/rclone_gendocs.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone gendocs" slug: rclone_gendocs url: /commands/rclone_gendocs/ diff --git a/docs/content/commands/rclone_hashsum.md b/docs/content/commands/rclone_hashsum.md index cb06e1d12..14c50c88d 100644 --- a/docs/content/commands/rclone_hashsum.md +++ b/docs/content/commands/rclone_hashsum.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone hashsum" slug: rclone_hashsum url: /commands/rclone_hashsum/ @@ -36,7 +36,8 @@ rclone hashsum remote:path [flags] ### Options ``` - -h, --help help for hashsum + --base64 Output base64 encoded hashsum + -h, --help help for hashsum ``` See the [global flags page](/flags/) for global options not listed here. diff --git a/docs/content/commands/rclone_link.md b/docs/content/commands/rclone_link.md index 5c2e97bf6..eea55926a 100644 --- a/docs/content/commands/rclone_link.md +++ b/docs/content/commands/rclone_link.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone link" slug: rclone_link url: /commands/rclone_link/ diff --git a/docs/content/commands/rclone_listremotes.md b/docs/content/commands/rclone_listremotes.md index 1407bd593..d6b7186e2 100644 --- a/docs/content/commands/rclone_listremotes.md +++ b/docs/content/commands/rclone_listremotes.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone listremotes" slug: rclone_listremotes url: /commands/rclone_listremotes/ diff --git a/docs/content/commands/rclone_ls.md b/docs/content/commands/rclone_ls.md index ab57f0de3..e31495cf5 100644 --- a/docs/content/commands/rclone_ls.md +++ b/docs/content/commands/rclone_ls.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone ls" slug: rclone_ls url: /commands/rclone_ls/ diff --git a/docs/content/commands/rclone_lsd.md b/docs/content/commands/rclone_lsd.md index 1af49af5c..10fd8db10 100644 --- a/docs/content/commands/rclone_lsd.md +++ b/docs/content/commands/rclone_lsd.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone lsd" slug: rclone_lsd url: /commands/rclone_lsd/ diff --git a/docs/content/commands/rclone_lsf.md b/docs/content/commands/rclone_lsf.md index dd263eda5..eff757c0e 100644 --- a/docs/content/commands/rclone_lsf.md +++ b/docs/content/commands/rclone_lsf.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone lsf" slug: rclone_lsf url: /commands/rclone_lsf/ diff --git a/docs/content/commands/rclone_lsjson.md b/docs/content/commands/rclone_lsjson.md index 33db69ea5..7d024f513 100644 --- a/docs/content/commands/rclone_lsjson.md +++ b/docs/content/commands/rclone_lsjson.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone lsjson" slug: rclone_lsjson url: /commands/rclone_lsjson/ @@ -36,7 +36,9 @@ The output is an array of Items, where each Item looks like this If --hash is not specified the Hashes property won't be emitted. -If --no-modtime is specified then ModTime will be blank. +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 --encrypted is not specified the Encrypted won't be emitted. @@ -94,14 +96,15 @@ rclone lsjson remote:path [flags] ### Options ``` - --dirs-only Show only directories in the listing. - -M, --encrypted Show the encrypted names. - --files-only Show only files in the listing. - --hash Include hashes in the output (may take longer). - -h, --help help for lsjson - --no-modtime Don't read the modification time (can speed things up). - --original Show the ID of the underlying Object. - -R, --recursive Recurse into the listing. + --dirs-only Show only directories in the listing. + -M, --encrypted Show the encrypted names. + --files-only Show only files in the listing. + --hash Include hashes in the output (may take longer). + -h, --help help for lsjson + --no-mimetype Don't read the mime type (can speed things up). + --no-modtime Don't read the modification time (can speed things up). + --original Show the ID of the underlying Object. + -R, --recursive Recurse into the listing. ``` See the [global flags page](/flags/) for global options not listed here. diff --git a/docs/content/commands/rclone_lsl.md b/docs/content/commands/rclone_lsl.md index 6e647d516..ab1e4d324 100644 --- a/docs/content/commands/rclone_lsl.md +++ b/docs/content/commands/rclone_lsl.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone lsl" slug: rclone_lsl url: /commands/rclone_lsl/ diff --git a/docs/content/commands/rclone_md5sum.md b/docs/content/commands/rclone_md5sum.md index daaf6a27a..8c32bc038 100644 --- a/docs/content/commands/rclone_md5sum.md +++ b/docs/content/commands/rclone_md5sum.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone md5sum" slug: rclone_md5sum url: /commands/rclone_md5sum/ diff --git a/docs/content/commands/rclone_mkdir.md b/docs/content/commands/rclone_mkdir.md index aa9cdd091..746c16255 100644 --- a/docs/content/commands/rclone_mkdir.md +++ b/docs/content/commands/rclone_mkdir.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone mkdir" slug: rclone_mkdir url: /commands/rclone_mkdir/ diff --git a/docs/content/commands/rclone_mount.md b/docs/content/commands/rclone_mount.md index f240755f9..daa163fce 100644 --- a/docs/content/commands/rclone_mount.md +++ b/docs/content/commands/rclone_mount.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone mount" slug: rclone_mount url: /commands/rclone_mount/ @@ -65,28 +65,6 @@ 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 diff --git a/docs/content/commands/rclone_move.md b/docs/content/commands/rclone_move.md index 5426d3968..2a5d26abf 100644 --- a/docs/content/commands/rclone_move.md +++ b/docs/content/commands/rclone_move.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone move" slug: rclone_move url: /commands/rclone_move/ diff --git a/docs/content/commands/rclone_moveto.md b/docs/content/commands/rclone_moveto.md index d6c262c63..ffe9e51f6 100644 --- a/docs/content/commands/rclone_moveto.md +++ b/docs/content/commands/rclone_moveto.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone moveto" slug: rclone_moveto url: /commands/rclone_moveto/ diff --git a/docs/content/commands/rclone_ncdu.md b/docs/content/commands/rclone_ncdu.md index f96d84d0c..581030d75 100644 --- a/docs/content/commands/rclone_ncdu.md +++ b/docs/content/commands/rclone_ncdu.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone ncdu" slug: rclone_ncdu url: /commands/rclone_ncdu/ @@ -31,6 +31,7 @@ Here are the keys - press '?' to toggle the help on and off g toggle graph n,s,C sort by name,size,count d delete file/directory + y copy current path to clipbard 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 ab570feee..f270a05e6 100644 --- a/docs/content/commands/rclone_obscure.md +++ b/docs/content/commands/rclone_obscure.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone obscure" slug: rclone_obscure url: /commands/rclone_obscure/ diff --git a/docs/content/commands/rclone_purge.md b/docs/content/commands/rclone_purge.md index a0b381eaf..70f797521 100644 --- a/docs/content/commands/rclone_purge.md +++ b/docs/content/commands/rclone_purge.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone purge" slug: rclone_purge url: /commands/rclone_purge/ diff --git a/docs/content/commands/rclone_rc.md b/docs/content/commands/rclone_rc.md index 7f4bcc3f2..ba0da07a3 100644 --- a/docs/content/commands/rclone_rc.md +++ b/docs/content/commands/rclone_rc.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone rc" slug: rclone_rc url: /commands/rclone_rc/ diff --git a/docs/content/commands/rclone_rcat.md b/docs/content/commands/rclone_rcat.md index b580c60a2..4ed4e92f6 100644 --- a/docs/content/commands/rclone_rcat.md +++ b/docs/content/commands/rclone_rcat.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone rcat" slug: rclone_rcat url: /commands/rclone_rcat/ diff --git a/docs/content/commands/rclone_rcd.md b/docs/content/commands/rclone_rcd.md index b8b971ce5..39100ed93 100644 --- a/docs/content/commands/rclone_rcd.md +++ b/docs/content/commands/rclone_rcd.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone rcd" slug: rclone_rcd url: /commands/rclone_rcd/ diff --git a/docs/content/commands/rclone_rmdir.md b/docs/content/commands/rclone_rmdir.md index 7550a4199..a3dc9f1ac 100644 --- a/docs/content/commands/rclone_rmdir.md +++ b/docs/content/commands/rclone_rmdir.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone rmdir" slug: rclone_rmdir url: /commands/rclone_rmdir/ diff --git a/docs/content/commands/rclone_rmdirs.md b/docs/content/commands/rclone_rmdirs.md index 21dba3ecd..f12c4f532 100644 --- a/docs/content/commands/rclone_rmdirs.md +++ b/docs/content/commands/rclone_rmdirs.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone rmdirs" slug: rclone_rmdirs url: /commands/rclone_rmdirs/ diff --git a/docs/content/commands/rclone_serve.md b/docs/content/commands/rclone_serve.md index e7b59ac58..b015f4815 100644 --- a/docs/content/commands/rclone_serve.md +++ b/docs/content/commands/rclone_serve.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve" slug: rclone_serve url: /commands/rclone_serve/ diff --git a/docs/content/commands/rclone_serve_dlna.md b/docs/content/commands/rclone_serve_dlna.md index 9b18b3578..c3811e8a1 100644 --- a/docs/content/commands/rclone_serve_dlna.md +++ b/docs/content/commands/rclone_serve_dlna.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve dlna" slug: rclone_serve_dlna url: /commands/rclone_serve_dlna/ diff --git a/docs/content/commands/rclone_serve_ftp.md b/docs/content/commands/rclone_serve_ftp.md index ba87a8f07..cc47b3b04 100644 --- a/docs/content/commands/rclone_serve_ftp.md +++ b/docs/content/commands/rclone_serve_ftp.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve ftp" slug: rclone_serve_ftp url: /commands/rclone_serve_ftp/ diff --git a/docs/content/commands/rclone_serve_http.md b/docs/content/commands/rclone_serve_http.md index 6d5413a65..7eb973683 100644 --- a/docs/content/commands/rclone_serve_http.md +++ b/docs/content/commands/rclone_serve_http.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve http" slug: rclone_serve_http url: /commands/rclone_serve_http/ diff --git a/docs/content/commands/rclone_serve_restic.md b/docs/content/commands/rclone_serve_restic.md index 9097fa251..6721dd94a 100644 --- a/docs/content/commands/rclone_serve_restic.md +++ b/docs/content/commands/rclone_serve_restic.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve restic" slug: rclone_serve_restic url: /commands/rclone_serve_restic/ diff --git a/docs/content/commands/rclone_serve_sftp.md b/docs/content/commands/rclone_serve_sftp.md index 845a64418..213fba514 100644 --- a/docs/content/commands/rclone_serve_sftp.md +++ b/docs/content/commands/rclone_serve_sftp.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve sftp" slug: rclone_serve_sftp url: /commands/rclone_serve_sftp/ @@ -22,9 +22,9 @@ 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 +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) or set the --no-auth flag for no authentication when logging in. Note that this also implements a small number of shell commands so @@ -183,13 +183,11 @@ 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. -> **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/test_proxy.py) in the rclone source code. -The program's job is to take a `user` and `pass` or `public_key` on the input and turn +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 @@ -202,7 +200,7 @@ This config generated must have this extra parameter And it may have this parameter - `_obscure` - comma separated strings for parameters to obscure -If password authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: +For example the program might take this on STDIN ``` { @@ -211,16 +209,7 @@ If password authentication was used by the client, input to the proxy process (o } ``` -If public-key authentication was used by the client, input to the proxy process (on STDIN) would look similar to this: - -``` -{ - "user": "me", - "public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc+4BlQz1s6tWT5VxBu1YlR9w39BUAom4qDKuH+uqLMDIaS5F7D6lNwOuPylvyV/LgMFsgJV4QZ52Kws7mNgdsCEDTvfLz5Pt9Qtp6Gnah3kA0cmbXcfQFaO50Ojnz/W1ozg2z5evKmGtyYMtywTXvH/KVh5WjhbpQ/ERgu+1pbgwWkpWNBM8TCO8D85PSpxtkdpEdkaiGtKA6U+6ZOtdCqd88EasyMEBWLVSx9bvqMVsD8plYstXOm5CCptGWWqckZBIqp0YBP6atw/ANRESD3cIJ4dOO+qlWkLR5npAZZTx2Qqh+hVw6qqTFB+JQdf" -} -``` - -And as an example return this on STDOUT +And return this on STDOUT ``` { @@ -234,7 +223,7 @@ And as an example return this on STDOUT ``` This would mean that an SFTP backend would be created on the fly for -the `user` and `pass`/`public_key` returned in the output to the host given. Note +the `user` and `pass` returned in the output to the host given. Note that since `_obscure` is set to `pass`, rclone will obscure the `pass` parameter before creating the backend (which is required for sftp backends). @@ -246,8 +235,8 @@ in the output and the user to `user`. For security you'd probably want to restrict the `host` to a limited list. Note that an internal cache is keyed on `user` so only use that for -configuration, don't use `pass` or `public_key`. This also means that if a user's -password or public-key is changed the cache will need to expire (which takes 5 mins) +configuration, don't use `pass`. This also means that if a user's +password is changed the cache will need to expire (which takes 5 mins) before it takes effect. This can be used to build general purpose proxies to any kind of diff --git a/docs/content/commands/rclone_serve_webdav.md b/docs/content/commands/rclone_serve_webdav.md index 468d736c8..fb31b36ac 100644 --- a/docs/content/commands/rclone_serve_webdav.md +++ b/docs/content/commands/rclone_serve_webdav.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone serve webdav" slug: rclone_serve_webdav url: /commands/rclone_serve_webdav/ diff --git a/docs/content/commands/rclone_settier.md b/docs/content/commands/rclone_settier.md index 7aac26674..f059a28bb 100644 --- a/docs/content/commands/rclone_settier.md +++ b/docs/content/commands/rclone_settier.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone settier" slug: rclone_settier url: /commands/rclone_settier/ diff --git a/docs/content/commands/rclone_sha1sum.md b/docs/content/commands/rclone_sha1sum.md index 04db4c119..b60b8b592 100644 --- a/docs/content/commands/rclone_sha1sum.md +++ b/docs/content/commands/rclone_sha1sum.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone sha1sum" slug: rclone_sha1sum url: /commands/rclone_sha1sum/ diff --git a/docs/content/commands/rclone_size.md b/docs/content/commands/rclone_size.md index a2c85e944..69f4fb43e 100644 --- a/docs/content/commands/rclone_size.md +++ b/docs/content/commands/rclone_size.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone size" slug: rclone_size url: /commands/rclone_size/ diff --git a/docs/content/commands/rclone_sync.md b/docs/content/commands/rclone_sync.md index c1088174c..a0d25bb13 100644 --- a/docs/content/commands/rclone_sync.md +++ b/docs/content/commands/rclone_sync.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone sync" slug: rclone_sync url: /commands/rclone_sync/ diff --git a/docs/content/commands/rclone_touch.md b/docs/content/commands/rclone_touch.md index 4f08cad26..ef4320105 100644 --- a/docs/content/commands/rclone_touch.md +++ b/docs/content/commands/rclone_touch.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone touch" slug: rclone_touch url: /commands/rclone_touch/ diff --git a/docs/content/commands/rclone_tree.md b/docs/content/commands/rclone_tree.md index 2305c7404..4f097724f 100644 --- a/docs/content/commands/rclone_tree.md +++ b/docs/content/commands/rclone_tree.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone tree" slug: rclone_tree url: /commands/rclone_tree/ diff --git a/docs/content/commands/rclone_version.md b/docs/content/commands/rclone_version.md index 2537edd8a..e99adeffe 100644 --- a/docs/content/commands/rclone_version.md +++ b/docs/content/commands/rclone_version.md @@ -1,5 +1,5 @@ --- -date: 2019-10-26T11:04:03+01:00 +date: 2020-02-01T10:26:53Z title: "rclone version" slug: rclone_version url: /commands/rclone_version/ diff --git a/docs/content/crypt.md b/docs/content/crypt.md index 2b55aff9f..d583abef2 100644 --- a/docs/content/crypt.md +++ b/docs/content/crypt.md @@ -297,12 +297,12 @@ How to encrypt the filenames. - Type: string - Default: "standard" - Examples: - - "off" - - Don't encrypt the file names. Adds a ".bin" extension only. - "standard" - Encrypt the filenames see the docs for the details. - "obfuscate" - Very simple filename obfuscation. + - "off" + - Don't encrypt the file names. Adds a ".bin" extension only. #### --crypt-directory-name-encryption diff --git a/docs/content/drive.md b/docs/content/drive.md index 2eb64bbbc..73d9635a7 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -735,6 +735,21 @@ or move the photos locally and use the date the image was taken - 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. @@ -820,10 +835,20 @@ Keep new head revision of each file forever. #### --drive-size-as-quota -Show storage quota usage for file size. +Show sizes as storage quota usage, not actual size. -The storage used by a file is the size of the current version plus any -older versions that have been set to keep forever. +Show the size of a file as the 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 @@ -889,6 +914,38 @@ See: https://github.com/rclone/rclone/issues/3631 - 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-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_DRIVE_ENCODING +- Type: MultiEncoder +- Default: InvalidUtf8 + ### Limitations ### diff --git a/docs/content/dropbox.md b/docs/content/dropbox.md index f6360c81a..011a863ac 100644 --- a/docs/content/dropbox.md +++ b/docs/content/dropbox.md @@ -174,6 +174,17 @@ Impersonate this user when using a business account. - Type: string - Default: "" +#### --dropbox-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_DROPBOX_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/fichier.md b/docs/content/fichier.md index 1229a6582..b5272831b 100644 --- a/docs/content/fichier.md +++ b/docs/content/fichier.md @@ -140,4 +140,15 @@ If you want to download a shared folder, add this parameter - Type: string - Default: "" +#### --fichier-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/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 + diff --git a/docs/content/flags.md b/docs/content/flags.md index 8dfccd8c2..85a5b460a 100755 --- a/docs/content/flags.md +++ b/docs/content/flags.md @@ -1,7 +1,7 @@ --- title: "Global Flags" description: "Rclone Global Flags" -date: "2019-10-26T11:04:03+01:00" +date: "2020-02-01T10:26:53Z" --- # Global Flags @@ -26,10 +26,10 @@ These flags are available for every command. -c, --checksum Skip based on checksum (if available) & size, not mod-time & size --client-cert string Client SSL certificate (PEM) for mutual TLS auth --client-key string Client SSL private key (PEM) for mutual TLS auth - --compare-dest string use DIR to server side copy flies from. + --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 Compare dest to DIR also. + --copy-dest string Implies --compare-dest but also copies files from path into destination. --cpuprofile string Write cpu profile to file --delete-after When synchronizing, delete files on destination after transferring (default) --delete-before When synchronizing, delete files on destination before transferring @@ -43,6 +43,7 @@ These flags are available for every command. --exclude stringArray Exclude files matching pattern --exclude-from stringArray Read exclude patterns from file --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 -f, --filter stringArray Add a file-filtering rule @@ -65,6 +66,7 @@ These flags are available for every command. --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) @@ -75,9 +77,12 @@ These flags are available for every command. --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-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. @@ -101,9 +106,9 @@ These flags are available for every command. --rc-user string User name for authentication. --rc-web-fetch-url string URL to fetch the releases for webgui. (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest") --rc-web-gui Launch WebGUI on localhost - --rc-web-gui-update Check and update to latest version of web gui --rc-web-gui-force-update Force update to latest version of web gui - --rc-web-gui-no-open-browser Don't open browser automatically + --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 --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 @@ -129,7 +134,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.50.0") + --user-agent string Set the user-agent to a specified string. The default is rclone/ version (default "rclone/v1.51.0") -v, --verbose count Print lots more stuff (repeat for more) ``` @@ -142,6 +147,7 @@ and may be set in the config file. --acd-auth-url string Auth server URL. --acd-client-id string Amazon Application Client ID. --acd-client-secret string Amazon Application Client Secret. + --acd-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-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) @@ -149,6 +155,7 @@ and may be set in the config file. --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-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) @@ -160,6 +167,7 @@ and may be set in the config file. --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 @@ -171,6 +179,7 @@ and may be set in the config file. --box-client-id string Box App Client Id. --box-client-secret string Box App Client Secret --box-commit-retries int Max number of times to try committing a multipart file. (default 100) + --box-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) --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. @@ -214,6 +223,7 @@ and may be set in the config file. --drive-client-id string Google Application Client Id --drive-client-secret string Google Application Client Secret --drive-disable-http2 Disable drive using http2 (default true) + --drive-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. @@ -228,23 +238,28 @@ and may be set in the config file. --drive-service-account-credentials string Service Account Credentials JSON blob --drive-service-account-file string Service Account Credentials JSON file path --drive-shared-with-me Only show files that are shared with me. - --drive-size-as-quota Show storage quota usage for file size. + --drive-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-stop-on-upload-limit Make upload limit errors be fatal --drive-team-drive string ID of the Team Drive --drive-trashed-only Only show files that are in the trash. --drive-upload-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) --drive-use-created-date Use file created date instead of modified date., + --drive-use-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-chunk-size SizeSuffix Upload chunk size. (< 150M). (default 48M) --dropbox-client-id string Dropbox App Client Id --dropbox-client-secret string Dropbox App Client Secret + --dropbox-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. --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-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 @@ -255,6 +270,7 @@ and may be set in the config file. --gcs-bucket-policy-only Access checks should use bucket-level IAM policies. --gcs-client-id string Google Application Client Id --gcs-client-secret string Google Application Client Secret + --gcs-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. @@ -271,11 +287,14 @@ and may be set in the config file. --hubic-chunk-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) --hubic-client-id string Hubic Client Id --hubic-client-secret string Hubic Client Secret + --hubic-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) --hubic-no-chunk Don't chunk files during streaming upload. + --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-unlink Remove existing public link to file/folder with link command rather than creating. --jottacloud-upload-resume-limit SizeSuffix Files bigger than this can be resumed if the upload fail's. (default 10M) + --koofr-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) @@ -284,10 +303,12 @@ and may be set in the config file. -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-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 --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") @@ -295,6 +316,7 @@ and may be set in the config file. --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. --mega-user string User name @@ -304,14 +326,21 @@ and may be set in the config file. --onedrive-client-secret string Microsoft App Client Secret --onedrive-drive-id string The ID of the drive to use --onedrive-drive-type string The type of the drive ( personal | business | documentLibrary ) + --onedrive-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. + --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. --opendrive-username string Username --pcloud-client-id string Pcloud App Client Id --pcloud-client-secret string Pcloud App Client Secret + --pcloud-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + --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 a endpoint URL to connection QingStor API. --qingstor-env-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. --qingstor-secret-access-key string QingStor Secret Access Key (password) @@ -322,11 +351,14 @@ and may be set in the config file. --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 5G) --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-provider string Choose your S3 provider. --s3-region string Region to connect to. @@ -351,13 +383,26 @@ and may be set in the config file. --sftp-port string SSH port, leave blank to use default (22) --sftp-set-modtime Set the modified time on the remote if set. (default true) --sftp-sha1sum-command string The command used to read sha1 hashes. Leave blank for autodetect. + --sftp-skip-links Set to skip any symlinks and any other non regular files. --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) @@ -366,6 +411,7 @@ and may be set in the config file. --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). @@ -387,5 +433,6 @@ and may be set in the config file. --webdav-vendor string Name of the Webdav site/service/software you are using --yandex-client-id string Yandex Client Id --yandex-client-secret string Yandex Client Secret + --yandex-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) --yandex-unlink Remove existing public link to file/folder with link command rather than creating. ``` diff --git a/docs/content/ftp.md b/docs/content/ftp.md index 80d1a59c4..f0183da9d 100644 --- a/docs/content/ftp.md +++ b/docs/content/ftp.md @@ -212,6 +212,17 @@ Disable using EPSV even if server advertises support - Type: bool - Default: false +#### --ftp-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_FTP_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,RightSpace,Dot + ### Limitations ### diff --git a/docs/content/googlecloudstorage.md b/docs/content/googlecloudstorage.md index fe8977bec..9a763a2b7 100644 --- a/docs/content/googlecloudstorage.md +++ b/docs/content/googlecloudstorage.md @@ -425,4 +425,19 @@ The storage class to use when storing objects in Google Cloud Storage. - "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-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_GCS_ENCODING +- Type: MultiEncoder +- Default: Slash,CrLf,InvalidUtf8,Dot + diff --git a/docs/content/hubic.md b/docs/content/hubic.md index 011ad12c3..67ec609a7 100644 --- a/docs/content/hubic.md +++ b/docs/content/hubic.md @@ -165,6 +165,17 @@ copy operations. - Type: bool - Default: false +#### --hubic-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_HUBIC_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + ### Limitations ### diff --git a/docs/content/jottacloud.md b/docs/content/jottacloud.md index f1c027326..bb9d120d8 100644 --- a/docs/content/jottacloud.md +++ b/docs/content/jottacloud.md @@ -202,6 +202,17 @@ Files bigger than this can be resumed if the upload fail's. - Type: SizeSuffix - Default: 10M +#### --jottacloud-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_JOTTACLOUD_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/koofr.md b/docs/content/koofr.md index 7990745f7..078dae210 100644 --- a/docs/content/koofr.md +++ b/docs/content/koofr.md @@ -152,6 +152,17 @@ Does the backend support setting modification time. Set this to false if you use - Type: bool - Default: true +#### --koofr-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_KOOFR_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/local.md b/docs/content/local.md index 2ba67f627..6d6d806d1 100644 --- a/docs/content/local.md +++ b/docs/content/local.md @@ -413,4 +413,15 @@ to override the default choice. - Type: bool - Default: false +#### --local-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_LOCAL_ENCODING +- Type: MultiEncoder +- Default: Slash,Dot + diff --git a/docs/content/mailru.md b/docs/content/mailru.md index 32fcbcf80..461aa9a90 100644 --- a/docs/content/mailru.md +++ b/docs/content/mailru.md @@ -300,4 +300,15 @@ Supported quirks: atomicmkdir binlist gzip insecure retry400 - Type: string - Default: "" +#### --mailru-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_MAILRU_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot + diff --git a/docs/content/mega.md b/docs/content/mega.md index 707d24b0b..3ddd03aa7 100644 --- a/docs/content/mega.md +++ b/docs/content/mega.md @@ -203,6 +203,17 @@ permanently delete objects instead. - Type: bool - Default: false +#### --mega-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_MEGA_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index f81f9ce9b..dc49e3580 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -267,6 +267,17 @@ listing, set this option. - Type: bool - Default: false +#### --onedrive-encoding + +This sets the encoding for the backend. + +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 + ### Limitations ### diff --git a/docs/content/opendrive.md b/docs/content/opendrive.md index ca1105c05..1739f7cb1 100644 --- a/docs/content/opendrive.md +++ b/docs/content/opendrive.md @@ -122,6 +122,33 @@ Password. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to opendrive (OpenDrive). + +#### --opendrive-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_OPENDRIVE_ENCODING +- Type: MultiEncoder +- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot + +#### --opendrive-chunk-size + +Files will be uploaded in chunks this size. + +Note that these chunks are buffered in memory so increasing them will +increase memory use. + +- Config: chunk_size +- Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE +- Type: SizeSuffix +- Default: 10M + ### Limitations ### diff --git a/docs/content/pcloud.md b/docs/content/pcloud.md index 1af400b38..fbd3e124e 100644 --- a/docs/content/pcloud.md +++ b/docs/content/pcloud.md @@ -137,4 +137,19 @@ Leave blank normally. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to pcloud (Pcloud). + +#### --pcloud-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PCLOUD_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + diff --git a/docs/content/premiumizeme.md b/docs/content/premiumizeme.md index dc3532521..e58d72820 100644 --- a/docs/content/premiumizeme.md +++ b/docs/content/premiumizeme.md @@ -118,6 +118,21 @@ This is not normally used - use oauth instead. - Type: string - Default: "" +### Advanced Options + +Here are the advanced options specific to premiumizeme (premiumize.me). + +#### --premiumizeme-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PREMIUMIZEME_ENCODING +- Type: MultiEncoder +- Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot + ### Limitations ### diff --git a/docs/content/putio.md b/docs/content/putio.md index cc4761189..dfe964d41 100644 --- a/docs/content/putio.md +++ b/docs/content/putio.md @@ -109,4 +109,19 @@ Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), as they can't be used in JSON strings. +### Advanced Options + +Here are the advanced options specific to putio (Put.io). + +#### --putio-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_PUTIO_ENCODING +- Type: MultiEncoder +- Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot + diff --git a/docs/content/qingstor.md b/docs/content/qingstor.md index 8b892fd13..51c2e9d34 100644 --- a/docs/content/qingstor.md +++ b/docs/content/qingstor.md @@ -266,4 +266,15 @@ this may help to speed up the transfers. - Type: int - Default: 1 +#### --qingstor-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_QINGSTOR_ENCODING +- Type: MultiEncoder +- Default: Slash,Ctl,InvalidUtf8 + diff --git a/docs/content/rc.md b/docs/content/rc.md index c7d654bb1..bfae78e53 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -531,9 +531,17 @@ Returns the following values: 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 +This clears counters, errors and finished transfers for all stats or specific stats group if group is provided. Parameters diff --git a/docs/content/s3.md b/docs/content/s3.md index ff011841e..bbd8fe1cf 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -566,7 +566,7 @@ Region to connect to. - Asia Pacific (Mumbai) - Needs location constraint ap-south-1. - "ap-east-1" - - Asia Pacific (Hong Kong) Region + - Asia Patific (Hong Kong) Region - Needs location constraint ap-east-1. - "sa-east-1" - South America (Sao Paulo) Region @@ -1051,8 +1051,10 @@ The minimum is 0 and the maximum is 5GB. Chunk size to use for uploading. -When uploading files larger than upload_cutoff they will be uploaded -as multipart uploads using this chunk size. +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. @@ -1060,11 +1062,34 @@ 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-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: 5G + #### --s3-disable-checksum Don't store MD5 checksum with object metadata @@ -1108,7 +1133,9 @@ if false then rclone will use virtual path style. See [the AWS S3 docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) for more info. -Some providers (eg Aliyun OSS or Netease COS) require this set to false. +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 @@ -1169,6 +1196,17 @@ In Ceph, this can be increased with the "rgw list buckets max chunk" option. - Type: int - Default: 1000 +#### --s3-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_S3_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8,Dot + ### Anonymous access to public buckets ### diff --git a/docs/content/sftp.md b/docs/content/sftp.md index 724ecd3ca..bc8a17253 100644 --- a/docs/content/sftp.md +++ b/docs/content/sftp.md @@ -320,6 +320,15 @@ The command used to read sha1 hashes. Leave blank for autodetect. - Type: string - Default: "" +#### --sftp-skip-links + +Set to skip any symlinks and any other non regular files. + +- Config: skip_links +- Env Var: RCLONE_SFTP_SKIP_LINKS +- Type: bool +- Default: false + ### Limitations ### diff --git a/docs/content/sharefile.md b/docs/content/sharefile.md index 70de59515..ddd8c3372 100644 --- a/docs/content/sharefile.md +++ b/docs/content/sharefile.md @@ -221,4 +221,15 @@ be set manually to something like: https://XXX.sharefile.com - Type: string - Default: "" +#### --sharefile-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/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 + diff --git a/docs/content/swift.md b/docs/content/swift.md index 9df51a178..060afadcb 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -461,6 +461,17 @@ copy operations. - Type: bool - Default: false +#### --swift-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_SWIFT_ENCODING +- Type: MultiEncoder +- Default: Slash,InvalidUtf8 + ### Modified time ### diff --git a/docs/content/yandex.md b/docs/content/yandex.md index bbe57ad9a..9dbc0dd40 100644 --- a/docs/content/yandex.md +++ b/docs/content/yandex.md @@ -165,4 +165,15 @@ Default is false, meaning link command will create or retrieve public link. - Type: bool - Default: false +#### --yandex-encoding + +This sets the encoding for the backend. + +See: the [encoding section in the overview](/overview/#encoding) for more info. + +- Config: encoding +- Env Var: RCLONE_YANDEX_ENCODING +- Type: MultiEncoder +- Default: Slash,Del,Ctl,InvalidUtf8,Dot + diff --git a/docs/layouts/chrome/footer.copyright.html b/docs/layouts/chrome/footer.copyright.html index 2c28d7576..b9a71657d 100644 --- a/docs/layouts/chrome/footer.copyright.html +++ b/docs/layouts/chrome/footer.copyright.html @@ -2,7 +2,7 @@
    -

    © Nick Craig-Wood 2014-2019
    +

    © Nick Craig-Wood 2014-2020
    Website hosted on a MEMSET CLOUD VPS, uploaded with rclone and built with Hugo. diff --git a/docs/layouts/partials/version.html b/docs/layouts/partials/version.html index 60c34d970..e8d94f772 100644 --- a/docs/layouts/partials/version.html +++ b/docs/layouts/partials/version.html @@ -1 +1 @@ -v1.50.0 \ No newline at end of file +v1.51.0 \ No newline at end of file diff --git a/fs/version.go b/fs/version.go index 25298a4ea..78759a45b 100644 --- a/fs/version.go +++ b/fs/version.go @@ -1,4 +1,4 @@ package fs // Version of rclone -var Version = "v1.50.2-DEV" +var Version = "v1.51.0" diff --git a/rclone.1 b/rclone.1 index 6747b4c08..62014dd40 100644 --- a/rclone.1 +++ b/rclone.1 @@ -1,7 +1,7 @@ .\"t -.\" Automatically generated by Pandoc 2.2.1 +.\" Automatically generated by Pandoc 2.5 .\" -.TH "rclone" "1" "Oct 26, 2019" "User Manual" "" +.TH "rclone" "1" "Feb 01, 2020" "User Manual" "" .hy .SH Rclone \- rsync for cloud storage .PP @@ -56,6 +56,8 @@ Memset Memstore .IP \[bu] 2 Mega .IP \[bu] 2 +Memory +.IP \[bu] 2 Microsoft Azure Blob Storage .IP \[bu] 2 Microsoft OneDrive @@ -90,6 +92,8 @@ Scaleway .IP \[bu] 2 SFTP .IP \[bu] 2 +SugarSync +.IP \[bu] 2 Wasabi .IP \[bu] 2 WebDAV @@ -153,92 +157,102 @@ Rclone is a Go program and comes as a single binary file. .IP \[bu] 2 Download (https://rclone.org/downloads/) the relevant binary. .IP \[bu] 2 -Extract the \f[C]rclone\f[] or \f[C]rclone.exe\f[] binary from the +Extract the \f[C]rclone\f[R] or \f[C]rclone.exe\f[R] binary from the archive .IP \[bu] 2 -Run \f[C]rclone\ config\f[] to setup. +Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .PP See below for some expanded Linux / macOS instructions. .PP See the Usage section (https://rclone.org/docs/) of the docs for how to -use rclone, or run \f[C]rclone\ \-h\f[]. +use rclone, or run \f[C]rclone \-h\f[R]. .SS Script installation .PP To install rclone on Linux/macOS/BSD systems, run: .IP .nf \f[C] -curl\ https://rclone.org/install.sh\ |\ sudo\ bash -\f[] +curl https://rclone.org/install.sh | sudo bash +\f[R] .fi .PP For beta installation, run: .IP .nf \f[C] -curl\ https://rclone.org/install.sh\ |\ sudo\ bash\ \-s\ beta -\f[] +curl https://rclone.org/install.sh | sudo bash \-s beta +\f[R] .fi .PP Note that this script checks the version of rclone installed first and -won't re\-download if not needed. +won\[cq]t re\-download if not needed. .SS Linux installation from precompiled binary .PP Fetch and unpack .IP .nf \f[C] -curl\ \-O\ https://downloads.rclone.org/rclone\-current\-linux\-amd64.zip -unzip\ rclone\-current\-linux\-amd64.zip -cd\ rclone\-*\-linux\-amd64 -\f[] +curl \-O https://downloads.rclone.org/rclone\-current\-linux\-amd64.zip +unzip rclone\-current\-linux\-amd64.zip +cd rclone\-*\-linux\-amd64 +\f[R] .fi .PP Copy binary file .IP .nf \f[C] -sudo\ cp\ rclone\ /usr/bin/ -sudo\ chown\ root:root\ /usr/bin/rclone -sudo\ chmod\ 755\ /usr/bin/rclone -\f[] +sudo cp rclone /usr/bin/ +sudo chown root:root /usr/bin/rclone +sudo chmod 755 /usr/bin/rclone +\f[R] .fi .PP Install manpage .IP .nf \f[C] -sudo\ mkdir\ \-p\ /usr/local/share/man/man1 -sudo\ cp\ rclone.1\ /usr/local/share/man/man1/ -sudo\ mandb\ -\f[] +sudo mkdir \-p /usr/local/share/man/man1 +sudo cp rclone.1 /usr/local/share/man/man1/ +sudo mandb +\f[R] .fi .PP -Run \f[C]rclone\ config\f[] to setup. +Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP .nf \f[C] -rclone\ config -\f[] +rclone config +\f[R] .fi -.SS macOS installation from precompiled binary +.SS macOS installation with brew +.IP +.nf +\f[C] +brew install rclone +\f[R] +.fi +.SS macOS installation from precompiled binary, using curl +.PP +To avoid problems with macOS gatekeeper enforcing the binary to be +signed and notarized it is enough to download with \f[C]curl\f[R]. .PP Download the latest version of rclone. .IP .nf \f[C] -cd\ &&\ curl\ \-O\ https://downloads.rclone.org/rclone\-current\-osx\-amd64.zip -\f[] +cd && curl \-O https://downloads.rclone.org/rclone\-current\-osx\-amd64.zip +\f[R] .fi .PP Unzip the download and cd to the extracted folder. .IP .nf \f[C] -unzip\ \-a\ rclone\-current\-osx\-amd64.zip\ &&\ cd\ rclone\-*\-osx\-amd64 -\f[] +unzip \-a rclone\-current\-osx\-amd64.zip && cd rclone\-*\-osx\-amd64 +\f[R] .fi .PP Move rclone to your $PATH. @@ -246,29 +260,50 @@ You will be prompted for your password. .IP .nf \f[C] -sudo\ mkdir\ \-p\ /usr/local/bin -sudo\ mv\ rclone\ /usr/local/bin/ -\f[] +sudo mkdir \-p /usr/local/bin +sudo mv rclone /usr/local/bin/ +\f[R] .fi .PP -(the \f[C]mkdir\f[] command is safe to run, even if the directory +(the \f[C]mkdir\f[R] command is safe to run, even if the directory already exists). .PP Remove the leftover files. .IP .nf \f[C] -cd\ ..\ &&\ rm\ \-rf\ rclone\-*\-osx\-amd64\ rclone\-current\-osx\-amd64.zip -\f[] +cd .. && rm \-rf rclone\-*\-osx\-amd64 rclone\-current\-osx\-amd64.zip +\f[R] .fi .PP -Run \f[C]rclone\ config\f[] to setup. +Run \f[C]rclone config\f[R] to setup. See rclone config docs (https://rclone.org/docs/) for more details. .IP .nf \f[C] -rclone\ config -\f[] +rclone config +\f[R] +.fi +.SS macOS installation from precompiled binary, using a web browser +.PP +When downloading a binary with a web browser, the browser will set the +macOS gatekeeper quarantine attribute. +Starting from Catalina, when attempting to run \f[C]rclone\f[R], a +pop\-up will appear saying: +.IP +.nf +\f[C] +\[lq]rclone\[rq] cannot be opened because the developer cannot be verified. +macOS cannot verify that this app is free from malware. +\f[R] +.fi +.PP +The simplest fix is to run +.IP +.nf +\f[C] +xattr \-d com.apple.quarantine rclone +\f[R] .fi .SS Install with docker .PP @@ -277,35 +312,36 @@ rclone (https://hub.docker.com/r/rclone/rclone). These images are autobuilt by docker hub from the rclone source based on a minimal Alpine linux image. .PP -The \f[C]:latest\f[] tag will always point to the latest stable release. -You can use the \f[C]:beta\f[] tag to get the latest build from master. -You can also use version tags, eg \f[C]:1.49.1\f[], \f[C]:1.49\f[] or -\f[C]:1\f[]. +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]. .IP .nf \f[C] -$\ docker\ pull\ rclone/rclone:latest -latest:\ Pulling\ from\ rclone/rclone -Digest:\ sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 +$ docker pull rclone/rclone:latest +latest: Pulling from rclone/rclone +Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 \&... -$\ docker\ run\ \-\-rm\ rclone/rclone:latest\ version -rclone\ v1.49.1 -\-\ os/arch:\ linux/amd64 -\-\ go\ version:\ go1.12.9 -\f[] +$ docker run \-\-rm rclone/rclone:latest version +rclone v1.49.1 +\- os/arch: linux/amd64 +\- go version: go1.12.9 +\f[R] .fi .PP There are a few command line options to consider when starting an rclone Docker container from the rclone image. .IP \[bu] 2 -You need to mount the host rclone config dir at \f[C]/config/rclone\f[] +You need to mount the host rclone config dir at \f[C]/config/rclone\f[R] into the Docker container. Due to the fact that rclone updates tokens inside its config file, and that the update process involves a file rename, you need to mount the whole host rclone config dir, not just the single host rclone config file. .IP \[bu] 2 -You need to mount a host data dir at \f[C]/data\f[] into the Docker +You need to mount a host data dir at \f[C]/data\f[R] into the Docker container. .IP \[bu] 2 By default, the rclone binary inside a Docker container runs with UID=0 @@ -314,46 +350,46 @@ As a result, all files created in a run will have UID=0. If your config and data files reside on the host with a non\-root UID:GID, you need to pass these on the container start command line. .IP \[bu] 2 -It is possible to use \f[C]rclone\ mount\f[] inside a userspace Docker +It is possible to use \f[C]rclone mount\f[R] inside a userspace Docker container, and expose the resulting fuse mount to the host. -The exact \f[C]docker\ run\f[] options to do that might vary slightly +The exact \f[C]docker run\f[R] options to do that might vary slightly between hosts. See, e.g.\ the discussion in this thread (https://github.com/moby/moby/issues/9448). .RS 2 .PP -You also need to mount the host \f[C]/etc/passwd\f[] and -\f[C]/etc/group\f[] for fuse to work inside the container. +You also need to mount the host \f[C]/etc/passwd\f[R] and +\f[C]/etc/group\f[R] for fuse to work inside the container. .RE .PP Here are some commands tested on an Ubuntu 18.04.3 host: .IP .nf \f[C] -#\ config\ on\ host\ at\ ~/.config/rclone/rclone.conf -#\ data\ on\ host\ at\ ~/data +# config on host at \[ti]/.config/rclone/rclone.conf +# data on host at \[ti]/data -#\ make\ sure\ the\ config\ is\ ok\ by\ listing\ the\ remotes -docker\ run\ \-\-rm\ \\ -\ \ \ \ \-\-volume\ ~/.config/rclone:/config/rclone\ \\ -\ \ \ \ \-\-volume\ ~/data:/data:shared\ \\ -\ \ \ \ \-\-user\ $(id\ \-u):$(id\ \-g)\ \\ -\ \ \ \ rclone/rclone\ \\ -\ \ \ \ listremotes +# make sure the config is ok by listing the remotes +docker run \-\-rm \[rs] + \-\-volume \[ti]/.config/rclone:/config/rclone \[rs] + \-\-volume \[ti]/data:/data:shared \[rs] + \-\-user $(id \-u):$(id \-g) \[rs] + rclone/rclone \[rs] + listremotes -#\ perform\ mount\ inside\ Docker\ container,\ expose\ result\ to\ host -mkdir\ \-p\ ~/data/mount -docker\ run\ \-\-rm\ \\ -\ \ \ \ \-\-volume\ ~/.config/rclone:/config/rclone\ \\ -\ \ \ \ \-\-volume\ ~/data:/data:shared\ \\ -\ \ \ \ \-\-user\ $(id\ \-u):$(id\ \-g)\ \\ -\ \ \ \ \-\-volume\ /etc/passwd:/etc/passwd:ro\ \-\-volume\ /etc/group:/etc/group:ro\ \\ -\ \ \ \ \-\-device\ /dev/fuse\ \-\-cap\-add\ SYS_ADMIN\ \-\-security\-opt\ apparmor:unconfined\ \\ -\ \ \ \ rclone/rclone\ \\ -\ \ \ \ mount\ dropbox:Photos\ /data/mount\ & -ls\ ~/data/mount -kill\ %1 -\f[] +# perform mount inside Docker container, expose result to host +mkdir \-p \[ti]/data/mount +docker run \-\-rm \[rs] + \-\-volume \[ti]/.config/rclone:/config/rclone \[rs] + \-\-volume \[ti]/data:/data:shared \[rs] + \-\-user $(id \-u):$(id \-g) \[rs] + \-\-volume /etc/passwd:/etc/passwd:ro \-\-volume /etc/group:/etc/group:ro \[rs] + \-\-device /dev/fuse \-\-cap\-add SYS_ADMIN \-\-security\-opt apparmor:unconfined \[rs] + rclone/rclone \[rs] + mount dropbox:Photos /data/mount & +ls \[ti]/data/mount +kill %1 +\f[R] .fi .SS Install from source .PP @@ -364,52 +400,52 @@ Then .IP .nf \f[C] -git\ clone\ https://github.com/rclone/rclone.git -cd\ rclone -go\ build -\&./rclone\ version -\f[] +git clone https://github.com/rclone/rclone.git +cd rclone +go build +\&./rclone version +\f[R] .fi .PP You can also build and install rclone in the GOPATH (https://github.com/golang/go/wiki/GOPATH) (which defaults to -\f[C]~/go\f[]) with: +\f[C]\[ti]/go\f[R]) with: .IP .nf \f[C] -go\ get\ \-u\ \-v\ github.com/rclone/rclone -\f[] +go get \-u \-v github.com/rclone/rclone +\f[R] .fi .PP -and this will build the binary in \f[C]$GOPATH/bin\f[] -(\f[C]~/go/bin/rclone\f[] by default) after downloading the source to -\f[C]$GOPATH/src/github.com/rclone/rclone\f[] -(\f[C]~/go/src/github.com/rclone/rclone\f[] by default). +and this will build the binary in \f[C]$GOPATH/bin\f[R] +(\f[C]\[ti]/go/bin/rclone\f[R] by default) after downloading the source +to \f[C]$GOPATH/src/github.com/rclone/rclone\f[R] +(\f[C]\[ti]/go/src/github.com/rclone/rclone\f[R] by default). .SS Installation with Ansible .PP -This can be done with Stefan Weichinger's ansible +This can be done with Stefan Weichinger\[cq]s ansible role (https://github.com/stefangweichinger/ansible-rclone). .PP Instructions .IP "1." 3 -\f[C]git\ clone\ https://github.com/stefangweichinger/ansible\-rclone.git\f[] +\f[C]git clone https://github.com/stefangweichinger/ansible\-rclone.git\f[R] into your local roles\-directory .IP "2." 3 add the role to the hosts you want rclone installed to: .IP .nf \f[C] -\ \ \ \ \-\ hosts:\ rclone\-hosts -\ \ \ \ \ \ roles: -\ \ \ \ \ \ \ \ \ \ \-\ rclone -\f[] + \- hosts: rclone\-hosts + roles: + \- rclone +\f[R] .fi .SS Configure .PP -First, you'll need to configure rclone. +First, you\[cq]ll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. -(See the \f[C]\-\-config\f[] entry for how to find the config file and +(See the \f[C]\-\-config\f[R] entry for how to find the config file and choose its location.) .PP The easiest way to make the config is to run rclone with the config @@ -417,8 +453,8 @@ option: .IP .nf \f[C] -rclone\ config -\f[] +rclone config +\f[R] .fi .PP See the following for detailed instructions for @@ -460,7 +496,7 @@ HTTP (https://rclone.org/http/) .IP \[bu] 2 Hubic (https://rclone.org/hubic/) .IP \[bu] 2 -Jottacloud (https://rclone.org/jottacloud/) +Jottacloud / GetSky.no (https://rclone.org/jottacloud/) .IP \[bu] 2 Koofr (https://rclone.org/koofr/) .IP \[bu] 2 @@ -468,6 +504,8 @@ Mail.ru Cloud (https://rclone.org/mailru/) .IP \[bu] 2 Mega (https://rclone.org/mega/) .IP \[bu] 2 +Memory (https://rclone.org/memory/) +.IP \[bu] 2 Microsoft Azure Blob Storage (https://rclone.org/azureblob/) .IP \[bu] 2 Microsoft OneDrive (https://rclone.org/onedrive/) @@ -487,6 +525,8 @@ QingStor (https://rclone.org/qingstor/) .IP \[bu] 2 SFTP (https://rclone.org/sftp/) .IP \[bu] 2 +SugarSync (https://rclone.org/sugarsync/) +.IP \[bu] 2 Union (https://rclone.org/union/) .IP \[bu] 2 WebDAV (https://rclone.org/webdav/) @@ -502,8 +542,8 @@ Its syntax is like this .IP .nf \f[C] -Syntax:\ [options]\ subcommand\ \ -\f[] +Syntax: [options] subcommand +\f[R] .fi .PP Source and destination paths are specified by the name you gave the @@ -518,10 +558,10 @@ For example .IP .nf \f[C] -rclone\ ls\ remote:path\ #\ lists\ a\ remote -rclone\ copy\ /local/path\ remote:path\ #\ copies\ /local/path\ to\ the\ remote -rclone\ sync\ /local/path\ remote:path\ #\ syncs\ /local/path\ to\ the\ remote -\f[] +rclone ls remote:path # lists a remote +rclone copy /local/path remote:path # copies /local/path to the remote +rclone sync /local/path remote:path # syncs /local/path to the remote +\f[R] .fi .SS rclone config .PP @@ -534,15 +574,15 @@ You may also set or remove a password to protect your configuration. .IP .nf \f[C] -rclone\ config\ [flags] -\f[] +rclone config [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ config -\f[] + \-h, \-\-help help for config +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -598,32 +638,32 @@ Copy files from source to dest, skipping already copied .SS Synopsis .PP 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. +Doesn\[cq]t transfer unchanged files, testing by size and modification +time or MD5SUM. +Doesn\[cq]t delete files from the destination. .PP 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. +the directory so when source:path is a directory, it\[cq]s the contents +of source:path that are copied, not the directory name and contents. .PP -If dest:path doesn't exist, it is created and the source:path contents -go there. +If dest:path doesn\[cq]t exist, it is created and the source:path +contents go there. .PP For example .IP .nf \f[C] -rclone\ copy\ source:sourcepath\ dest:destpath -\f[] +rclone copy source:sourcepath dest:destpath +\f[R] .fi .PP -Let's say there are two files in sourcepath +Let\[cq]s say there are two files in sourcepath .IP .nf \f[C] sourcepath/one.txt sourcepath/two.txt -\f[] +\f[R] .fi .PP This copies them to @@ -632,7 +672,7 @@ This copies them to \f[C] destpath/one.txt destpath/two.txt -\f[] +\f[R] .fi .PP Not to @@ -641,10 +681,10 @@ Not to \f[C] destpath/sourcepath/one.txt destpath/sourcepath/two.txt -\f[] +\f[R] .fi .PP -If you are familiar with \f[C]rsync\f[], rclone always works as if you +If you are familiar with \f[C]rsync\f[R], rclone always works as if you had written a trailing / \- meaning \[lq]copy the contents of this directory\[rq]. This applies to all commands and whether you are talking about the @@ -661,25 +701,25 @@ recently very efficiently like this: .IP .nf \f[C] -rclone\ copy\ \-\-max\-age\ 24h\ \-\-no\-traverse\ /path/to/src\ remote: -\f[] +rclone copy \-\-max\-age 24h \-\-no\-traverse /path/to/src remote: +\f[R] .fi .PP -\f[B]Note\f[]: Use the \f[C]\-P\f[]/\f[C]\-\-progress\f[] flag to view -real\-time transfer statistics +\f[B]Note\f[R]: Use the \f[C]\-P\f[R]/\f[C]\-\-progress\f[R] flag to +view real\-time transfer statistics .IP .nf \f[C] -rclone\ copy\ source:path\ dest:path\ [flags] -\f[] +rclone copy source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-create\-empty\-src\-dirs\ \ \ Create\ empty\ source\ dirs\ on\ destination\ after\ copy -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ copy -\f[] + \-\-create\-empty\-src\-dirs Create empty source dirs on destination after copy + \-h, \-\-help help for copy +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -694,41 +734,41 @@ Make source and dest identical, modifying destination only. .SS Synopsis .PP Sync the source to the destination, changing the destination only. -Doesn't transfer unchanged files, testing by size and modification time -or MD5SUM. +Doesn\[cq]t transfer unchanged files, testing by size and modification +time or MD5SUM. Destination is updated to match source, including deleting files if necessary. .PP -\f[B]Important\f[]: Since this can cause data loss, test first with the -\f[C]\-\-dry\-run\f[] flag to see exactly what would be copied and +\f[B]Important\f[R]: Since this can cause data loss, test first with the +\f[C]\-\-dry\-run\f[R] flag to see exactly what would be copied and deleted. .PP -Note that files in the destination won't be deleted if there were any -errors at any point. +Note that files in the destination won\[cq]t be deleted if there were +any errors at any point. .PP 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 +directory so when source:path is a directory, it\[cq]s the contents of source:path that are copied, not the directory name and contents. -See extended explanation in the \f[C]copy\f[] command above if unsure. +See extended explanation in the \f[C]copy\f[R] command above if unsure. .PP -If dest:path doesn't exist, it is created and the source:path contents -go there. +If dest:path doesn\[cq]t exist, it is created and the source:path +contents go there. .PP -\f[B]Note\f[]: Use the \f[C]\-P\f[]/\f[C]\-\-progress\f[] flag to view -real\-time transfer statistics +\f[B]Note\f[R]: Use the \f[C]\-P\f[R]/\f[C]\-\-progress\f[R] flag to +view real\-time transfer statistics .IP .nf \f[C] -rclone\ sync\ source:path\ dest:path\ [flags] -\f[] +rclone sync source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-create\-empty\-src\-dirs\ \ \ Create\ empty\ source\ dirs\ on\ destination\ after\ sync -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ sync -\f[] + \-\-create\-empty\-src\-dirs Create empty source dirs on destination after sync + \-h, \-\-help help for sync +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -747,14 +787,14 @@ Rclone will error if the source and destination overlap and the remote does not support a server side directory move operation. .PP If no filters are in use and if possible this will server side move -\f[C]source:path\f[] into \f[C]dest:path\f[]. -After this \f[C]source:path\f[] will no longer longer exist. +\f[C]source:path\f[R] into \f[C]dest:path\f[R]. +After this \f[C]source:path\f[R] will no longer longer exist. .PP -Otherwise for each file in \f[C]source:path\f[] selected by the filters -(if any) this will move it into \f[C]dest:path\f[]. +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[] then delete the -original (if no errors on copy) in \f[C]source:path\f[]. +(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 \[en]delete\-empty\-src\-dirs flag. @@ -764,25 +804,25 @@ 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. .PP -\f[B]Important\f[]: Since this can cause data loss, test first with the +\f[B]Important\f[R]: Since this can cause data loss, test first with the \[en]dry\-run flag. .PP -\f[B]Note\f[]: Use the \f[C]\-P\f[]/\f[C]\-\-progress\f[] flag to view -real\-time transfer statistics. +\f[B]Note\f[R]: Use the \f[C]\-P\f[R]/\f[C]\-\-progress\f[R] flag to +view real\-time transfer statistics. .IP .nf \f[C] -rclone\ move\ source:path\ dest:path\ [flags] -\f[] +rclone move source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-create\-empty\-src\-dirs\ \ \ Create\ empty\ source\ dirs\ on\ destination\ after\ move -\ \ \ \ \ \ \-\-delete\-empty\-src\-dirs\ \ \ Delete\ empty\ source\ dirs\ after\ move -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ move -\f[] + \-\-create\-empty\-src\-dirs Create empty source dirs on destination after move + \-\-delete\-empty\-src\-dirs Delete empty source dirs after move + \-h, \-\-help help for move +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -797,13 +837,13 @@ Remove the contents of path. .SS Synopsis .PP Remove the files in path. -Unlike \f[C]purge\f[] it obeys include/exclude filters so can be used to -selectively delete files. +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[] only deletes objects but leaves the directory +\f[C]rclone delete\f[R] only deletes objects but leaves the directory structure alone. If you want to delete a directory and all of its contents use -\f[C]rclone\ purge\f[] +\f[C]rclone purge\f[R] .PP Eg delete all files bigger than 100MBytes .PP @@ -811,17 +851,17 @@ Check what would be deleted first (use either) .IP .nf \f[C] -rclone\ \-\-min\-size\ 100M\ lsl\ remote:path -rclone\ \-\-dry\-run\ \-\-min\-size\ 100M\ delete\ remote:path -\f[] +rclone \-\-min\-size 100M lsl remote:path +rclone \-\-dry\-run \-\-min\-size 100M delete remote:path +\f[R] .fi .PP Then delete .IP .nf \f[C] -rclone\ \-\-min\-size\ 100M\ delete\ remote:path -\f[] +rclone \-\-min\-size 100M delete remote:path +\f[R] .fi .PP That reads \[lq]delete everything with a minimum size of 100 MB\[rq], @@ -829,15 +869,15 @@ hence delete all files bigger than 100MBytes. .IP .nf \f[C] -rclone\ delete\ remote:path\ [flags] -\f[] +rclone delete remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ delete -\f[] + \-h, \-\-help help for delete +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -854,19 +894,19 @@ 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[] if you want to selectively delete files. +Use \f[C]delete\f[R] if you want to selectively delete files. .IP .nf \f[C] -rclone\ purge\ remote:path\ [flags] -\f[] +rclone purge remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ purge -\f[] + \-h, \-\-help help for purge +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -877,22 +917,22 @@ rclone (https://rclone.org/commands/rclone/) \- Show help for rclone commands, flags and backends. .SS rclone mkdir .PP -Make the path if it doesn't already exist. +Make the path if it doesn\[cq]t already exist. .SS Synopsis .PP -Make the path if it doesn't already exist. +Make the path if it doesn\[cq]t already exist. .IP .nf \f[C] -rclone\ mkdir\ remote:path\ [flags] -\f[] +rclone mkdir remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ mkdir -\f[] + \-h, \-\-help help for mkdir +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -907,20 +947,20 @@ Remove the path if empty. .SS Synopsis .PP Remove the path. -Note that you can't remove a path with objects in it, use purge for +Note that you can\[cq]t remove a path with objects in it, use purge for that. .IP .nf \f[C] -rclone\ rmdir\ remote:path\ [flags] -\f[] +rclone rmdir remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ rmdir -\f[] + \-h, \-\-help help for rmdir +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -936,8 +976,8 @@ Checks the files in the source and destination match. .PP 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. +which don\[cq]t match. +It doesn\[cq]t alter the source or destination. .PP If you supply the \[en]size\-only flag, it will only compare the sizes not the hashes as well. @@ -945,7 +985,7 @@ Use this for a quick check. .PP If you supply the \[en]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 +This can be useful for remotes that don\[cq]t support hashes or if you really want to check all the data. .PP If you supply the \[en]one\-way flag, it will only check that files in @@ -955,17 +995,17 @@ trigger an error. .IP .nf \f[C] -rclone\ check\ source:path\ dest:path\ [flags] -\f[] +rclone check source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-download\ \ \ Check\ by\ downloading\ rather\ than\ with\ hash. -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ help\ for\ check -\ \ \ \ \ \ \-\-one\-way\ \ \ \ Check\ one\ way\ only,\ source\ files\ must\ exist\ on\ remote -\f[] + \-\-download Check by downloading rather than with hash. + \-h, \-\-help help for check + \-\-one\-way Check one way only, source files must exist on remote +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -987,53 +1027,54 @@ Eg .IP .nf \f[C] -$\ rclone\ ls\ swift:bucket -\ \ \ \ 60295\ bevajer5jef -\ \ \ \ 90613\ canole -\ \ \ \ 94467\ diwogej7 -\ \ \ \ 37600\ fubuwic -\f[] +$ rclone ls swift:bucket + 60295 bevajer5jef + 90613 canole + 94467 diwogej7 + 37600 fubuwic +\f[R] .fi .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 -\f[C]ls\f[] to list size and path of objects only +\f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 -\f[C]lsl\f[] to list modification time, size and path of objects only +\f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 -\f[C]lsd\f[] to list directories only +\f[C]lsd\f[R] to list directories only .IP \[bu] 2 -\f[C]lsf\f[] to list objects and directories in easy to parse format +\f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 -\f[C]lsjson\f[] to list objects and directories in JSON format +\f[C]lsjson\f[R] to list objects and directories in JSON format .PP -\f[C]ls\f[],\f[C]lsl\f[],\f[C]lsd\f[] are designed to be human readable. -\f[C]lsf\f[] is designed to be human and machine readable. -\f[C]lsjson\f[] is designed to be machine readable. +\f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human +readable. +\f[C]lsf\f[R] is designed to be human and machine readable. +\f[C]lsjson\f[R] is designed to be machine readable. .PP -Note that \f[C]ls\f[] and \f[C]lsl\f[] recurse by default \- use +Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use \[lq]\[en]max\-depth 1\[rq] to stop the recursion. .PP -The other list commands \f[C]lsd\f[],\f[C]lsf\f[],\f[C]lsjson\f[] do not -recurse by default \- use \[lq]\-R\[rq] to make them recurse. +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 \[lq]\-R\[rq] to make them recurse. .PP 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). +remotes which can\[cq]t have empty directories (eg s3, swift, gcs, etc +\- the bucket based remotes). .IP .nf \f[C] -rclone\ ls\ remote:path\ [flags] -\f[] +rclone ls remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ ls -\f[] + \-h, \-\-help help for ls +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1058,21 +1099,21 @@ of the directory, Eg .IP .nf \f[C] -$\ rclone\ lsd\ swift: -\ \ \ \ \ \ 494000\ 2018\-04\-26\ 08:43:20\ \ \ \ \ 10000\ 10000files -\ \ \ \ \ \ \ \ \ \ 65\ 2018\-04\-26\ 08:43:20\ \ \ \ \ \ \ \ \ 1\ 1File -\f[] +$ rclone lsd swift: + 494000 2018\-04\-26 08:43:20 10000 10000files + 65 2018\-04\-26 08:43:20 1 1File +\f[R] .fi .PP Or .IP .nf \f[C] -$\ rclone\ lsd\ drive:test -\ \ \ \ \ \ \ \ \ \ \-1\ 2016\-10\-17\ 17:41:53\ \ \ \ \ \ \ \ \-1\ 1000files -\ \ \ \ \ \ \ \ \ \ \-1\ 2017\-01\-03\ 14:40:54\ \ \ \ \ \ \ \ \-1\ 2500files -\ \ \ \ \ \ \ \ \ \ \-1\ 2017\-07\-08\ 14:39:28\ \ \ \ \ \ \ \ \-1\ 4000files -\f[] +$ rclone lsd drive:test + \-1 2016\-10\-17 17:41:53 \-1 1000files + \-1 2017\-01\-03 14:40:54 \-1 2500files + \-1 2017\-07\-08 14:39:28 \-1 4000files +\f[R] .fi .PP If you just want the directory names use \[lq]rclone lsf @@ -1082,42 +1123,43 @@ Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 -\f[C]ls\f[] to list size and path of objects only +\f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 -\f[C]lsl\f[] to list modification time, size and path of objects only +\f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 -\f[C]lsd\f[] to list directories only +\f[C]lsd\f[R] to list directories only .IP \[bu] 2 -\f[C]lsf\f[] to list objects and directories in easy to parse format +\f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 -\f[C]lsjson\f[] to list objects and directories in JSON format +\f[C]lsjson\f[R] to list objects and directories in JSON format .PP -\f[C]ls\f[],\f[C]lsl\f[],\f[C]lsd\f[] are designed to be human readable. -\f[C]lsf\f[] is designed to be human and machine readable. -\f[C]lsjson\f[] is designed to be machine readable. +\f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human +readable. +\f[C]lsf\f[R] is designed to be human and machine readable. +\f[C]lsjson\f[R] is designed to be machine readable. .PP -Note that \f[C]ls\f[] and \f[C]lsl\f[] recurse by default \- use +Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use \[lq]\[en]max\-depth 1\[rq] to stop the recursion. .PP -The other list commands \f[C]lsd\f[],\f[C]lsf\f[],\f[C]lsjson\f[] do not -recurse by default \- use \[lq]\-R\[rq] to make them recurse. +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 \[lq]\-R\[rq] to make them recurse. .PP 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). +remotes which can\[cq]t have empty directories (eg s3, swift, gcs, etc +\- the bucket based remotes). .IP .nf \f[C] -rclone\ lsd\ remote:path\ [flags] -\f[] +rclone lsd remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ help\ for\ lsd -\ \ \-R,\ \-\-recursive\ \ \ Recurse\ into\ the\ listing. -\f[] + \-h, \-\-help help for lsd + \-R, \-\-recursive Recurse into the listing. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1139,53 +1181,54 @@ Eg .IP .nf \f[C] -$\ rclone\ lsl\ swift:bucket -\ \ \ \ 60295\ 2016\-06\-25\ 18:55:41.062626927\ bevajer5jef -\ \ \ \ 90613\ 2016\-06\-25\ 18:55:43.302607074\ canole -\ \ \ \ 94467\ 2016\-06\-25\ 18:55:43.046609333\ diwogej7 -\ \ \ \ 37600\ 2016\-06\-25\ 18:55:40.814629136\ fubuwic -\f[] +$ rclone lsl swift:bucket + 60295 2016\-06\-25 18:55:41.062626927 bevajer5jef + 90613 2016\-06\-25 18:55:43.302607074 canole + 94467 2016\-06\-25 18:55:43.046609333 diwogej7 + 37600 2016\-06\-25 18:55:40.814629136 fubuwic +\f[R] .fi .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 -\f[C]ls\f[] to list size and path of objects only +\f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 -\f[C]lsl\f[] to list modification time, size and path of objects only +\f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 -\f[C]lsd\f[] to list directories only +\f[C]lsd\f[R] to list directories only .IP \[bu] 2 -\f[C]lsf\f[] to list objects and directories in easy to parse format +\f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 -\f[C]lsjson\f[] to list objects and directories in JSON format +\f[C]lsjson\f[R] to list objects and directories in JSON format .PP -\f[C]ls\f[],\f[C]lsl\f[],\f[C]lsd\f[] are designed to be human readable. -\f[C]lsf\f[] is designed to be human and machine readable. -\f[C]lsjson\f[] is designed to be machine readable. +\f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human +readable. +\f[C]lsf\f[R] is designed to be human and machine readable. +\f[C]lsjson\f[R] is designed to be machine readable. .PP -Note that \f[C]ls\f[] and \f[C]lsl\f[] recurse by default \- use +Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use \[lq]\[en]max\-depth 1\[rq] to stop the recursion. .PP -The other list commands \f[C]lsd\f[],\f[C]lsf\f[],\f[C]lsjson\f[] do not -recurse by default \- use \[lq]\-R\[rq] to make them recurse. +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 \[lq]\-R\[rq] to make them recurse. .PP 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). +remotes which can\[cq]t have empty directories (eg s3, swift, gcs, etc +\- the bucket based remotes). .IP .nf \f[C] -rclone\ lsl\ remote:path\ [flags] -\f[] +rclone lsl remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ lsl -\f[] + \-h, \-\-help help for lsl +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1204,15 +1247,15 @@ This is in the same format as the standard md5sum tool produces. .IP .nf \f[C] -rclone\ md5sum\ remote:path\ [flags] -\f[] +rclone md5sum remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ md5sum -\f[] + \-h, \-\-help help for md5sum +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1231,15 +1274,15 @@ This is in the same format as the standard sha1sum tool produces. .IP .nf \f[C] -rclone\ sha1sum\ remote:path\ [flags] -\f[] +rclone sha1sum remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ sha1sum -\f[] + \-h, \-\-help help for sha1sum +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1257,16 +1300,16 @@ Prints the total size and number of objects in remote:path. .IP .nf \f[C] -rclone\ size\ remote:path\ [flags] -\f[] +rclone size remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ size -\ \ \ \ \ \ \-\-json\ \ \ format\ output\ as\ JSON -\f[] + \-h, \-\-help help for size + \-\-json format output as JSON +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1286,11 +1329,11 @@ Eg .IP .nf \f[C] -$\ rclone\ version -rclone\ v1.41 -\-\ os/arch:\ linux/amd64 -\-\ go\ version:\ go1.10 -\f[] +$ rclone version +rclone v1.41 +\- os/arch: linux/amd64 +\- go version: go1.10 +\f[R] .fi .PP If you supply the \[en]check flag, then it will do an online check to @@ -1298,38 +1341,38 @@ compare your version with the latest release and the latest beta. .IP .nf \f[C] -$\ rclone\ version\ \-\-check -yours:\ \ 1.42.0.6 -latest:\ 1.42\ \ \ \ \ \ \ \ \ \ (released\ 2018\-06\-16) -beta:\ \ \ 1.42.0.5\ \ \ \ \ \ (released\ 2018\-06\-17) -\f[] +$ rclone version \-\-check +yours: 1.42.0.6 +latest: 1.42 (released 2018\-06\-16) +beta: 1.42.0.5 (released 2018\-06\-17) +\f[R] .fi .PP Or .IP .nf \f[C] -$\ rclone\ version\ \-\-check -yours:\ \ 1.41 -latest:\ 1.42\ \ \ \ \ \ \ \ \ \ (released\ 2018\-06\-16) -\ \ upgrade:\ https://downloads.rclone.org/v1.42 -beta:\ \ \ 1.42.0.5\ \ \ \ \ \ (released\ 2018\-06\-17) -\ \ upgrade:\ https://beta.rclone.org/v1.42\-005\-g56e1e820 -\f[] +$ rclone version \-\-check +yours: 1.41 +latest: 1.42 (released 2018\-06\-16) + upgrade: https://downloads.rclone.org/v1.42 +beta: 1.42.0.5 (released 2018\-06\-17) + upgrade: https://beta.rclone.org/v1.42\-005\-g56e1e820 +\f[R] .fi .IP .nf \f[C] -rclone\ version\ [flags] -\f[] +rclone version [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-check\ \ \ Check\ for\ new\ version. -\ \ \-h,\ \-\-help\ \ \ \ help\ for\ version -\f[] + \-\-check Check for new version. + \-h, \-\-help help for version +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1349,15 +1392,15 @@ Not supported by all remotes. .IP .nf \f[C] -rclone\ cleanup\ remote:path\ [flags] -\f[] +rclone cleanup remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ cleanup -\f[] + \-h, \-\-help help for cleanup +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1371,7 +1414,7 @@ commands, flags and backends. Interactively find duplicate files and delete/rename them. .SS Synopsis .PP -By default \f[C]dedupe\f[] interactively finds duplicate files and +By default \f[C]dedupe\f[R] interactively finds duplicate files and offers to delete all but one or rename them to be different. Only useful with Google Drive which can have duplicate file names. .PP @@ -1379,12 +1422,12 @@ In the first pass it will merge directories with the same name. It will do this iteratively until all the identical directories have been merged. .PP -The \f[C]dedupe\f[] command will delete all but one of any identical +The \f[C]dedupe\f[R] command will delete all but one of any identical (same md5sum) files it finds without confirmation. -This means that for most duplicated files the \f[C]dedupe\f[] command +This means that for most duplicated files the \f[C]dedupe\f[R] command will not be interactive. -You can use \f[C]\-\-dry\-run\f[] to see what would happen without doing -anything. +You can use \f[C]\-\-dry\-run\f[R] to see what would happen without +doing anything. .PP Here is an example run. .PP @@ -1392,82 +1435,85 @@ Before \- with duplicates .IP .nf \f[C] -$\ rclone\ lsl\ drive:dupes -\ \ 6048320\ 2016\-03\-05\ 16:23:16.798000000\ one.txt -\ \ 6048320\ 2016\-03\-05\ 16:23:11.775000000\ one.txt -\ \ \ 564374\ 2016\-03\-05\ 16:23:06.731000000\ one.txt -\ \ 6048320\ 2016\-03\-05\ 16:18:26.092000000\ one.txt -\ \ 6048320\ 2016\-03\-05\ 16:22:46.185000000\ two.txt -\ \ 1744073\ 2016\-03\-05\ 16:22:38.104000000\ two.txt -\ \ \ 564374\ 2016\-03\-05\ 16:22:52.118000000\ two.txt -\f[] +$ rclone lsl drive:dupes + 6048320 2016\-03\-05 16:23:16.798000000 one.txt + 6048320 2016\-03\-05 16:23:11.775000000 one.txt + 564374 2016\-03\-05 16:23:06.731000000 one.txt + 6048320 2016\-03\-05 16:18:26.092000000 one.txt + 6048320 2016\-03\-05 16:22:46.185000000 two.txt + 1744073 2016\-03\-05 16:22:38.104000000 two.txt + 564374 2016\-03\-05 16:22:52.118000000 two.txt +\f[R] .fi .PP -Now the \f[C]dedupe\f[] session +Now the \f[C]dedupe\f[R] session .IP .nf \f[C] -$\ rclone\ dedupe\ drive:dupes -2016/03/05\ 16:24:37\ Google\ drive\ root\ \[aq]dupes\[aq]:\ Looking\ for\ duplicates\ using\ interactive\ mode. -one.txt:\ Found\ 4\ duplicates\ \-\ deleting\ identical\ copies -one.txt:\ Deleting\ 2/3\ identical\ duplicates\ (md5sum\ "1eedaa9fe86fd4b8632e2ac549403b36") -one.txt:\ 2\ duplicates\ remain -\ \ 1:\ \ \ \ \ \ 6048320\ bytes,\ 2016\-03\-05\ 16:23:16.798000000,\ md5sum\ 1eedaa9fe86fd4b8632e2ac549403b36 -\ \ 2:\ \ \ \ \ \ \ 564374\ bytes,\ 2016\-03\-05\ 16:23:06.731000000,\ md5sum\ 7594e7dc9fc28f727c42ee3e0749de81 -s)\ Skip\ and\ do\ nothing -k)\ Keep\ just\ one\ (choose\ which\ in\ next\ step) -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\ duplicates\ \-\ deleting\ identical\ copies -two.txt:\ 3\ duplicates\ remain -\ \ 1:\ \ \ \ \ \ \ 564374\ bytes,\ 2016\-03\-05\ 16:22:52.118000000,\ md5sum\ 7594e7dc9fc28f727c42ee3e0749de81 -\ \ 2:\ \ \ \ \ \ 6048320\ bytes,\ 2016\-03\-05\ 16:22:46.185000000,\ md5sum\ 1eedaa9fe86fd4b8632e2ac549403b36 -\ \ 3:\ \ \ \ \ \ 1744073\ bytes,\ 2016\-03\-05\ 16:22:38.104000000,\ md5sum\ 851957f7fb6f0bc4ce76be966d336802 -s)\ Skip\ and\ do\ nothing -k)\ Keep\ just\ one\ (choose\ which\ in\ next\ step) -r)\ Rename\ all\ to\ be\ different\ (by\ changing\ file.jpg\ to\ file\-1.jpg) -s/k/r>\ r -two\-1.txt:\ renamed\ from:\ two.txt -two\-2.txt:\ renamed\ from:\ two.txt -two\-3.txt:\ renamed\ from:\ two.txt -\f[] +$ rclone dedupe drive:dupes +2016/03/05 16:24:37 Google drive root \[aq]dupes\[aq]: Looking for duplicates using interactive mode. +one.txt: Found 4 duplicates \- deleting identical copies +one.txt: Deleting 2/3 identical duplicates (md5sum \[dq]1eedaa9fe86fd4b8632e2ac549403b36\[dq]) +one.txt: 2 duplicates remain + 1: 6048320 bytes, 2016\-03\-05 16:23:16.798000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 + 2: 564374 bytes, 2016\-03\-05 16:23:06.731000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 +s) Skip and do nothing +k) Keep just one (choose which in next step) +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 duplicates \- deleting identical copies +two.txt: 3 duplicates remain + 1: 564374 bytes, 2016\-03\-05 16:22:52.118000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81 + 2: 6048320 bytes, 2016\-03\-05 16:22:46.185000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36 + 3: 1744073 bytes, 2016\-03\-05 16:22:38.104000000, md5sum 851957f7fb6f0bc4ce76be966d336802 +s) Skip and do nothing +k) Keep just one (choose which in next step) +r) Rename all to be different (by changing file.jpg to file\-1.jpg) +s/k/r> r +two\-1.txt: renamed from: two.txt +two\-2.txt: renamed from: two.txt +two\-3.txt: renamed from: two.txt +\f[R] .fi .PP The result being .IP .nf \f[C] -$\ rclone\ lsl\ drive:dupes -\ \ 6048320\ 2016\-03\-05\ 16:23:16.798000000\ one.txt -\ \ \ 564374\ 2016\-03\-05\ 16:22:52.118000000\ two\-1.txt -\ \ 6048320\ 2016\-03\-05\ 16:22:46.185000000\ two\-2.txt -\ \ 1744073\ 2016\-03\-05\ 16:22:38.104000000\ two\-3.txt -\f[] +$ rclone lsl drive:dupes + 6048320 2016\-03\-05 16:23:16.798000000 one.txt + 564374 2016\-03\-05 16:22:52.118000000 two\-1.txt + 6048320 2016\-03\-05 16:22:46.185000000 two\-2.txt + 1744073 2016\-03\-05 16:22:38.104000000 two\-3.txt +\f[R] .fi .PP -Dedupe can be run non interactively using the \f[C]\-\-dedupe\-mode\f[] +Dedupe can be run non interactively using the \f[C]\-\-dedupe\-mode\f[R] flag or by using an extra parameter with the same value .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ interactive\f[] \- interactive as above. +\f[C]\-\-dedupe\-mode interactive\f[R] \- interactive as above. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ skip\f[] \- removes identical files then skips +\f[C]\-\-dedupe\-mode skip\f[R] \- removes identical files then skips anything left. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ first\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode first\f[R] \- removes identical files then keeps the first one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ newest\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode newest\f[R] \- removes identical files then keeps the newest one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ oldest\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode oldest\f[R] \- removes identical files then keeps the oldest one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ largest\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode largest\f[R] \- removes identical files then keeps the largest one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ rename\f[] \- removes identical files then +\f[C]\-\-dedupe\-mode smallest\f[R] \- removes identical files then +keeps the smallest one. +.IP \[bu] 2 +\f[C]\-\-dedupe\-mode rename\f[R] \- removes identical files then renames the rest to be different. .PP For example to rename all the identically named photos in your Google @@ -1475,30 +1521,30 @@ Photos directory, do .IP .nf \f[C] -rclone\ dedupe\ \-\-dedupe\-mode\ rename\ "drive:Google\ Photos" -\f[] +rclone dedupe \-\-dedupe\-mode rename \[dq]drive:Google Photos\[dq] +\f[R] .fi .PP Or .IP .nf \f[C] -rclone\ dedupe\ rename\ "drive:Google\ Photos" -\f[] +rclone dedupe rename \[dq]drive:Google Photos\[dq] +\f[R] .fi .IP .nf \f[C] -rclone\ dedupe\ [mode]\ remote:path\ [flags] -\f[] +rclone dedupe [mode] remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-dedupe\-mode\ string\ \ \ Dedupe\ mode\ interactive|skip|first|newest|oldest|rename.\ (default\ "interactive") -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ dedupe -\f[] + \-\-dedupe\-mode string Dedupe mode interactive|skip|first|newest|oldest|largest|smallest|rename. (default \[dq]interactive\[dq]) + \-h, \-\-help help for dedupe +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1520,12 +1566,12 @@ This will print to stdout something like this: .IP .nf \f[C] -Total:\ \ \ 17G -Used:\ \ \ \ 7.444G -Free:\ \ \ \ 1.315G -Trashed:\ 100.000M -Other:\ \ \ 8.241G -\f[] +Total: 17G +Used: 7.444G +Free: 1.315G +Trashed: 100.000M +Other: 8.241G +\f[R] .fi .PP Where the fields are: @@ -1551,12 +1597,12 @@ Use the \[en]full flag to see the numbers written out in full, eg .IP .nf \f[C] -Total:\ \ \ 18253611008 -Used:\ \ \ \ 7993453766 -Free:\ \ \ \ 1411001220 -Trashed:\ 104857602 -Other:\ \ \ 8849156022 -\f[] +Total: 18253611008 +Used: 7993453766 +Free: 1411001220 +Trashed: 104857602 +Other: 8849156022 +\f[R] .fi .PP Use the \[en]json flag for a computer readable output, eg @@ -1564,28 +1610,28 @@ Use the \[en]json flag for a computer readable output, eg .nf \f[C] { -\ \ \ \ "total":\ 18253611008, -\ \ \ \ "used":\ 7993453766, -\ \ \ \ "trashed":\ 104857602, -\ \ \ \ "other":\ 8849156022, -\ \ \ \ "free":\ 1411001220 + \[dq]total\[dq]: 18253611008, + \[dq]used\[dq]: 7993453766, + \[dq]trashed\[dq]: 104857602, + \[dq]other\[dq]: 8849156022, + \[dq]free\[dq]: 1411001220 } -\f[] +\f[R] .fi .IP .nf \f[C] -rclone\ about\ remote:\ [flags] -\f[] +rclone about remote: [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-full\ \ \ Full\ numbers\ instead\ of\ SI\ units -\ \ \-h,\ \-\-help\ \ \ help\ for\ about -\ \ \ \ \ \ \-\-json\ \ \ Format\ output\ as\ JSON -\f[] + \-\-full Full numbers instead of SI units + \-h, \-\-help help for about + \-\-json Format output as JSON +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1602,18 +1648,22 @@ Remote authorization. Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser \- use as instructed by rclone config. +.PP +Use the \[en]auth\-no\-open\-browser to prevent rclone to open auth link +in default browser automatically. .IP .nf \f[C] -rclone\ authorize\ [flags] -\f[] +rclone authorize [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ authorize -\f[] + \-\-auth\-no\-open\-browser Do not automatically open auth link in default browser + \-h, \-\-help help for authorize +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1631,15 +1681,15 @@ Print cache stats for a remote in JSON format .IP .nf \f[C] -rclone\ cachestats\ source:\ [flags] -\f[] +rclone cachestats source: [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ cachestats -\f[] + \-h, \-\-help help for cachestats +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1659,24 +1709,24 @@ You can use it like this to output a single file .IP .nf \f[C] -rclone\ cat\ remote:path/to/file -\f[] +rclone cat remote:path/to/file +\f[R] .fi .PP Or like this to output any file in dir or subdirectories. .IP .nf \f[C] -rclone\ cat\ remote:path/to/dir -\f[] +rclone cat remote:path/to/dir +\f[R] .fi .PP Or like this to output any .txt files in dir or subdirectories. .IP .nf \f[C] -rclone\ \-\-include\ "*.txt"\ cat\ remote:path/to/dir -\f[] +rclone \-\-include \[dq]*.txt\[dq] cat remote:path/to/dir +\f[R] .fi .PP Use the \[en]head flag to print characters only at the start, \[en]tail @@ -1687,20 +1737,20 @@ Note that if offset is negative it will count from the end, so .IP .nf \f[C] -rclone\ cat\ remote:path\ [flags] -\f[] +rclone cat remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-count\ int\ \ \ \ Only\ print\ N\ characters.\ (default\ \-1) -\ \ \ \ \ \ \-\-discard\ \ \ \ \ \ Discard\ the\ output\ instead\ of\ printing. -\ \ \ \ \ \ \-\-head\ int\ \ \ \ \ Only\ print\ the\ first\ N\ characters. -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ help\ for\ cat -\ \ \ \ \ \ \-\-offset\ int\ \ \ Start\ printing\ at\ offset\ N\ (or\ from\ end\ if\ \-ve). -\ \ \ \ \ \ \-\-tail\ int\ \ \ \ \ Only\ print\ the\ last\ N\ characters. -\f[] + \-\-count int Only print N characters. (default \-1) + \-\-discard Discard the output instead of printing. + \-\-head int Only print the first N characters. + \-h, \-\-help help for cat + \-\-offset int Start printing at offset N (or from end if \-ve). + \-\-tail int Only print the last N characters. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1722,8 +1772,8 @@ you would do: .IP .nf \f[C] -rclone\ config\ create\ myremote\ swift\ env_auth\ true -\f[] +rclone config create myremote swift env_auth true +\f[R] .fi .PP Note that if the config process would normally ask a question the @@ -1739,21 +1789,21 @@ using remote authorization you would do this: .IP .nf \f[C] -rclone\ config\ create\ mydrive\ drive\ config_is_local\ false -\f[] +rclone config create mydrive drive config_is_local false +\f[R] .fi .IP .nf \f[C] -rclone\ config\ create\ \ \ [\ ]*\ [flags] -\f[] +rclone config create [ ]* [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ create -\f[] + \-h, \-\-help help for create +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1771,15 +1821,15 @@ Delete an existing remote . .IP .nf \f[C] -rclone\ config\ delete\ \ [flags] -\f[] +rclone config delete [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ delete -\f[] + \-h, \-\-help help for delete +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1801,15 +1851,15 @@ To reconnect use \[lq]rclone config reconnect\[rq]. .IP .nf \f[C] -rclone\ config\ disconnect\ remote:\ [flags] -\f[] +rclone config disconnect remote: [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ disconnect -\f[] + \-h, \-\-help help for disconnect +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1827,15 +1877,15 @@ Dump the config file as JSON. .IP .nf \f[C] -rclone\ config\ dump\ [flags] -\f[] +rclone config dump [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ dump -\f[] + \-h, \-\-help help for dump +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1855,15 +1905,15 @@ You may also set or remove a password to protect your configuration. .IP .nf \f[C] -rclone\ config\ edit\ [flags] -\f[] +rclone config edit [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ edit -\f[] + \-h, \-\-help help for edit +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1881,15 +1931,15 @@ Show path of configuration file in use. .IP .nf \f[C] -rclone\ config\ file\ [flags] -\f[] +rclone config file [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ file -\f[] + \-h, \-\-help help for file +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1903,15 +1953,15 @@ interactive configuration session. Update password in an existing remote. .SS Synopsis .PP -Update an existing remote's password. +Update an existing remote\[cq]s password. The password should be passed in in pairs of . .PP For example to set password of a remote of name myremote you would do: .IP .nf \f[C] -rclone\ config\ password\ myremote\ fieldname\ mypassword -\f[] +rclone config password myremote fieldname mypassword +\f[R] .fi .PP This command is obsolete now that \[lq]config update\[rq] and @@ -1919,15 +1969,15 @@ This command is obsolete now that \[lq]config update\[rq] and .IP .nf \f[C] -rclone\ config\ password\ \ [\ ]+\ [flags] -\f[] +rclone config password [ ]+ [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ password -\f[] + \-h, \-\-help help for password +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1945,15 +1995,15 @@ List in JSON format all the providers and options. .IP .nf \f[C] -rclone\ config\ providers\ [flags] -\f[] +rclone config providers [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ providers -\f[] + \-h, \-\-help help for providers +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -1975,15 +2025,15 @@ This normally means going through the interactive oauth flow again. .IP .nf \f[C] -rclone\ config\ reconnect\ remote:\ [flags] -\f[] +rclone config reconnect remote: [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ reconnect -\f[] + \-h, \-\-help help for reconnect +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2001,15 +2051,15 @@ Print (decrypted) config file, or the config for a single remote. .IP .nf \f[C] -rclone\ config\ show\ []\ [flags] -\f[] +rclone config show [] [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ show -\f[] + \-h, \-\-help help for show +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2023,7 +2073,7 @@ interactive configuration session. Update options in an existing remote. .SS Synopsis .PP -Update an existing remote's options. +Update an existing remote\[cq]s options. The options should be passed in in pairs of . .PP For example to update the env_auth field of a remote of name myremote @@ -2031,33 +2081,33 @@ you would do: .IP .nf \f[C] -rclone\ config\ update\ myremote\ swift\ env_auth\ true -\f[] +rclone config update myremote swift env_auth true +\f[R] .fi .PP If any of the parameters passed is a password field, then rclone will automatically obscure them before putting them in the config file. .PP -If the remote uses oauth the token will be updated, if you don't require -this add an extra parameter thus: +If the remote uses oauth the token will be updated, if you don\[cq]t +require this add an extra parameter thus: .IP .nf \f[C] -rclone\ config\ update\ myremote\ swift\ env_auth\ true\ config_refresh_token\ false -\f[] +rclone config update myremote swift env_auth true config_refresh_token false +\f[R] .fi .IP .nf \f[C] -rclone\ config\ update\ \ [\ ]+\ [flags] -\f[] +rclone config update [ ]+ [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ update -\f[] + \-h, \-\-help help for update +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2076,16 +2126,16 @@ system. .IP .nf \f[C] -rclone\ config\ userinfo\ remote:\ [flags] -\f[] +rclone config userinfo remote: [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ userinfo -\ \ \ \ \ \ \-\-json\ \ \ Format\ output\ as\ JSON -\f[] + \-h, \-\-help help for userinfo + \-\-json Format output as JSON +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2110,8 +2160,8 @@ So .IP .nf \f[C] -rclone\ copyto\ src\ dst -\f[] +rclone copyto src dst +\f[R] .fi .PP where src and dst are rclone paths, either remote:path or /path/to/local @@ -2121,32 +2171,32 @@ This will: .IP .nf \f[C] -if\ src\ is\ file -\ \ \ \ copy\ it\ to\ dst,\ overwriting\ an\ existing\ file\ if\ it\ exists -if\ src\ is\ directory -\ \ \ \ copy\ it\ to\ dst,\ overwriting\ existing\ files\ if\ they\ exist -\ \ \ \ see\ copy\ command\ for\ full\ details -\f[] +if src is file + copy it to dst, overwriting an existing file if it exists +if src is directory + copy it to dst, overwriting existing files if they exist + see copy command for full details +\f[R] .fi .PP -This doesn't transfer unchanged files, testing by size and modification -time or MD5SUM. -It doesn't delete files from the destination. +This doesn\[cq]t transfer unchanged files, testing by size and +modification time or MD5SUM. +It doesn\[cq]t delete files from the destination. .PP -\f[B]Note\f[]: Use the \f[C]\-P\f[]/\f[C]\-\-progress\f[] flag to view -real\-time transfer statistics +\f[B]Note\f[R]: Use the \f[C]\-P\f[R]/\f[C]\-\-progress\f[R] flag to +view real\-time transfer statistics .IP .nf \f[C] -rclone\ copyto\ source:path\ dest:path\ [flags] -\f[] +rclone copyto source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ copyto -\f[] + \-h, \-\-help help for copyto +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2160,24 +2210,29 @@ commands, flags and backends. Copy url content to dest. .SS Synopsis .PP -Download urls content and copy it to destination without saving it in -tmp storage. +Download a URL\[cq]s content and copy it to the destination without +saving it in temporary storage. .PP -Setting \[en]auto\-filename flag will cause retrieving file name from -url and using it in destination path. +Setting \[en]auto\-filename will cause the file name to be retreived +from the from URL (after any redirections) and used in the destination +path. +.PP +Setting \[en]stdout or making the output file name \[lq]\-\[rq] will +cause the output to be written to standard output. .IP .nf \f[C] -rclone\ copyurl\ https://example.com\ dest:path\ [flags] -\f[] +rclone copyurl https://example.com dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-a,\ \-\-auto\-filename\ \ \ Get\ the\ file\ name\ from\ the\ url\ and\ use\ it\ for\ destination\ file\ path -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ help\ for\ copyurl -\f[] + \-a, \-\-auto\-filename Get the file name from the URL and use it for destination file path + \-h, \-\-help help for copyurl + \-\-stdout Write the output to stdout rather than a file +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2207,8 +2262,8 @@ Use it like this .IP .nf \f[C] -rclone\ cryptcheck\ /path/to/files\ encryptedremote:path -\f[] +rclone cryptcheck /path/to/files encryptedremote:path +\f[R] .fi .PP You can use it like this also, but that will involve downloading all the @@ -2216,8 +2271,8 @@ files in remote:path. .IP .nf \f[C] -rclone\ cryptcheck\ remote:path\ encryptedremote:path -\f[] +rclone cryptcheck remote:path encryptedremote:path +\f[R] .fi .PP After it has run it will log the status of the encryptedremote:. @@ -2229,16 +2284,16 @@ trigger an error. .IP .nf \f[C] -rclone\ cryptcheck\ remote:path\ cryptedremote:path\ [flags] -\f[] +rclone cryptcheck remote:path cryptedremote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ \ \ \ help\ for\ cryptcheck -\ \ \ \ \ \ \-\-one\-way\ \ \ Check\ one\ way\ only,\ source\ files\ must\ exist\ on\ destination -\f[] + \-h, \-\-help help for cryptcheck + \-\-one\-way Check one way only, source files must exist on destination +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2263,24 +2318,24 @@ use it like this .IP .nf \f[C] -rclone\ cryptdecode\ encryptedremote:\ encryptedfilename1\ encryptedfilename2 +rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2 -rclone\ cryptdecode\ \-\-reverse\ encryptedremote:\ filename1\ filename2 -\f[] +rclone cryptdecode \-\-reverse encryptedremote: filename1 filename2 +\f[R] .fi .IP .nf \f[C] -rclone\ cryptdecode\ encryptedremote:\ encryptedfilename\ [flags] -\f[] +rclone cryptdecode encryptedremote: encryptedfilename [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ \ \ \ help\ for\ cryptdecode -\ \ \ \ \ \ \-\-reverse\ \ \ Reverse\ cryptdecode,\ encrypts\ filenames -\f[] + \-h, \-\-help help for cryptdecode + \-\-reverse Reverse cryptdecode, encrypts filenames +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2301,15 +2356,15 @@ The output is in the same format as md5sum and sha1sum. .IP .nf \f[C] -rclone\ dbhashsum\ remote:path\ [flags] -\f[] +rclone dbhashsum remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ dbhashsum -\f[] + \-h, \-\-help help for dbhashsum +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2324,21 +2379,21 @@ Remove a single file from remote. .SS Synopsis .PP Remove a single file from remote. -Unlike \f[C]delete\f[] 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. +Unlike \f[C]delete\f[R] it cannot be used to remove a directory and it +doesn\[cq]t obey include/exclude filters \- if the specified file +exists, it will always be removed. .IP .nf \f[C] -rclone\ deletefile\ remote:path\ [flags] -\f[] +rclone deletefile remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ deletefile -\f[] + \-h, \-\-help help for deletefile +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2358,8 +2413,8 @@ Run with \[en]help to list the supported shells. .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ genautocomplete -\f[] + \-h, \-\-help help for genautocomplete +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2388,8 +2443,8 @@ need to be run with sudo or as root, eg .IP .nf \f[C] -sudo\ rclone\ genautocomplete\ bash -\f[] +sudo rclone genautocomplete bash +\f[R] .fi .PP Logout and login again to use the autocompletion scripts, or source them @@ -2397,23 +2452,23 @@ directly .IP .nf \f[C] -\&.\ /etc/bash_completion -\f[] +\&. /etc/bash_completion +\f[R] .fi .PP If you supply a command line argument the script will be written there. .IP .nf \f[C] -rclone\ genautocomplete\ bash\ [output_file]\ [flags] -\f[] +rclone genautocomplete bash [output_file] [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ bash -\f[] + \-h, \-\-help help for bash +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2435,8 +2490,8 @@ will probably need to be run with sudo or as root, eg .IP .nf \f[C] -sudo\ rclone\ genautocomplete\ zsh -\f[] +sudo rclone genautocomplete zsh +\f[R] .fi .PP Logout and login again to use the autocompletion scripts, or source them @@ -2444,23 +2499,23 @@ directly .IP .nf \f[C] -autoload\ \-U\ compinit\ &&\ compinit -\f[] +autoload \-U compinit && compinit +\f[R] .fi .PP If you supply a command line argument the script will be written there. .IP .nf \f[C] -rclone\ genautocomplete\ zsh\ [output_file]\ [flags] -\f[] +rclone genautocomplete zsh [output_file] [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ zsh -\f[] + \-h, \-\-help help for zsh +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2482,15 +2537,15 @@ website. .IP .nf \f[C] -rclone\ gendocs\ output_directory\ [flags] -\f[] +rclone gendocs output_directory [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ gendocs -\f[] + \-h, \-\-help help for gendocs +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2512,34 +2567,35 @@ Run without a hash to see the list of supported hashes, eg .IP .nf \f[C] -$\ rclone\ hashsum -Supported\ hashes\ are: -\ \ *\ MD5 -\ \ *\ SHA\-1 -\ \ *\ DropboxHash -\ \ *\ QuickXorHash -\f[] +$ rclone hashsum +Supported hashes are: + * MD5 + * SHA\-1 + * DropboxHash + * QuickXorHash +\f[R] .fi .PP Then .IP .nf \f[C] -$\ rclone\ hashsum\ MD5\ remote:path -\f[] +$ rclone hashsum MD5 remote:path +\f[R] .fi .IP .nf \f[C] -rclone\ hashsum\ \ remote:path\ [flags] -\f[] +rclone hashsum remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ hashsum -\f[] + \-\-base64 Output base64 encoded hashsum + \-h, \-\-help help for hashsum +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2558,9 +2614,9 @@ folder. .IP .nf \f[C] -rclone\ link\ remote:path/to/file -rclone\ link\ remote:path/to/folder/ -\f[] +rclone link remote:path/to/file +rclone link remote:path/to/folder/ +\f[R] .fi .PP If successful, the last line of the output will contain the link. @@ -2570,15 +2626,15 @@ protection, accessible without account. .IP .nf \f[C] -rclone\ link\ remote:path\ [flags] -\f[] +rclone link remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ link -\f[] + \-h, \-\-help help for link +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2598,16 +2654,16 @@ When uses with the \-l flag it lists the types too. .IP .nf \f[C] -rclone\ listremotes\ [flags] -\f[] +rclone listremotes [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ listremotes -\ \ \ \ \ \ \-\-long\ \ \ Show\ the\ type\ as\ well\ as\ names. -\f[] + \-h, \-\-help help for listremotes + \-\-long Show the type as well as names. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2631,13 +2687,13 @@ Eg .IP .nf \f[C] -$\ rclone\ lsf\ swift:bucket +$ rclone lsf swift:bucket bevajer5jef canole diwogej7 ferejej3gux/ fubuwic -\f[] +\f[R] .fi .PP Use the \[en]format option to control what gets listed. @@ -2646,16 +2702,16 @@ control the output: .IP .nf \f[C] -p\ \-\ path -s\ \-\ size -t\ \-\ modification\ time -h\ \-\ hash -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" -\f[] +p \- path +s \- size +t \- modification time +h \- hash +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] +\f[R] .fi .PP So if you wanted the path, size and modification time, you would use @@ -2666,75 +2722,75 @@ Eg .IP .nf \f[C] -$\ rclone\ lsf\ \ \-\-format\ "tsp"\ swift:bucket -2016\-06\-25\ 18:55:41;60295;bevajer5jef -2016\-06\-25\ 18:55:43;90613;canole -2016\-06\-25\ 18:55:43;94467;diwogej7 -2018\-04\-26\ 08:50:45;0;ferejej3gux/ -2016\-06\-25\ 18:55:40;37600;fubuwic -\f[] +$ rclone lsf \-\-format \[dq]tsp\[dq] swift:bucket +2016\-06\-25 18:55:41;60295;bevajer5jef +2016\-06\-25 18:55:43;90613;canole +2016\-06\-25 18:55:43;94467;diwogej7 +2018\-04\-26 08:50:45;0;ferejej3gux/ +2016\-06\-25 18:55:40;37600;fubuwic +\f[R] .fi .PP If you specify \[lq]h\[rq] in the format you will get the MD5 hash by default, use the \[lq]\[en]hash\[rq] flag to change which hash you want. -Note that this can be returned as an empty string if it isn't available -on the object (and for directories), \[lq]ERROR\[rq] if there was an -error reading it from the object and \[lq]UNSUPPORTED\[rq] if that -object does not support that hash type. +Note that this can be returned as an empty string if it isn\[cq]t +available on the object (and for directories), \[lq]ERROR\[rq] if there +was an error reading it from the object and \[lq]UNSUPPORTED\[rq] if +that object does not support that hash type. .PP For example to emulate the md5sum command you can use .IP .nf \f[C] -rclone\ lsf\ \-R\ \-\-hash\ MD5\ \-\-format\ hp\ \-\-separator\ "\ \ "\ \-\-files\-only\ . -\f[] +rclone lsf \-R \-\-hash MD5 \-\-format hp \-\-separator \[dq] \[dq] \-\-files\-only . +\f[R] .fi .PP Eg .IP .nf \f[C] -$\ rclone\ lsf\ \-R\ \-\-hash\ MD5\ \-\-format\ hp\ \-\-separator\ "\ \ "\ \-\-files\-only\ swift:bucket\ -7908e352297f0f530b84a756f188baa3\ \ bevajer5jef -cd65ac234e6fea5925974a51cdd865cc\ \ canole -03b5341b4f234b9d984d03ad076bae91\ \ diwogej7 -8fd37c3810dd660778137ac3a66cc06d\ \ fubuwic -99713e14a4c4ff553acaf1930fad985b\ \ gixacuh7ku -\f[] +$ rclone lsf \-R \-\-hash MD5 \-\-format hp \-\-separator \[dq] \[dq] \-\-files\-only swift:bucket +7908e352297f0f530b84a756f188baa3 bevajer5jef +cd65ac234e6fea5925974a51cdd865cc canole +03b5341b4f234b9d984d03ad076bae91 diwogej7 +8fd37c3810dd660778137ac3a66cc06d fubuwic +99713e14a4c4ff553acaf1930fad985b gixacuh7ku +\f[R] .fi .PP (Though \[lq]rclone md5sum .\[rq] is an easier way of typing this.) .PP By default the separator is \[lq];\[rq] this can be changed with the \[en]separator flag. -Note that separators aren't escaped in the path so putting it last is a -good strategy. +Note that separators aren\[cq]t escaped in the path so putting it last +is a good strategy. .PP Eg .IP .nf \f[C] -$\ rclone\ lsf\ \ \-\-separator\ ","\ \-\-format\ "tshp"\ swift:bucket -2016\-06\-25\ 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef -2016\-06\-25\ 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole -2016\-06\-25\ 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 -2018\-04\-26\ 08:52:53,0,,ferejej3gux/ -2016\-06\-25\ 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic -\f[] +$ rclone lsf \-\-separator \[dq],\[dq] \-\-format \[dq]tshp\[dq] swift:bucket +2016\-06\-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef +2016\-06\-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole +2016\-06\-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7 +2018\-04\-26 08:52:53,0,,ferejej3gux/ +2016\-06\-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic +\f[R] .fi .PP You can output in CSV standard format. -This will escape things in " if they contain , +This will escape things in \[dq] if they contain , .PP Eg .IP .nf \f[C] -$\ rclone\ lsf\ \-\-csv\ \-\-files\-only\ \-\-format\ ps\ remote:path +$ rclone lsf \-\-csv \-\-files\-only \-\-format ps remote:path test.log,22355 test.sh,449 -"this\ file\ contains\ a\ comma,\ in\ the\ file\ name.txt",6 -\f[] +\[dq]this file contains a comma, in the file name.txt\[dq],6 +\f[R] .fi .PP Note that the \[en]absolute parameter is useful for making lists of @@ -2745,59 +2801,60 @@ only (without traversing the whole directory structure): .IP .nf \f[C] -rclone\ lsf\ \-\-absolute\ \-\-files\-only\ \-\-max\-age\ 1d\ /path/to/local\ >\ new_files -rclone\ copy\ \-\-files\-from\ new_files\ /path/to/local\ remote:path -\f[] +rclone lsf \-\-absolute \-\-files\-only \-\-max\-age 1d /path/to/local > new_files +rclone copy \-\-files\-from new_files /path/to/local remote:path +\f[R] .fi .PP Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 -\f[C]ls\f[] to list size and path of objects only +\f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 -\f[C]lsl\f[] to list modification time, size and path of objects only +\f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 -\f[C]lsd\f[] to list directories only +\f[C]lsd\f[R] to list directories only .IP \[bu] 2 -\f[C]lsf\f[] to list objects and directories in easy to parse format +\f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 -\f[C]lsjson\f[] to list objects and directories in JSON format +\f[C]lsjson\f[R] to list objects and directories in JSON format .PP -\f[C]ls\f[],\f[C]lsl\f[],\f[C]lsd\f[] are designed to be human readable. -\f[C]lsf\f[] is designed to be human and machine readable. -\f[C]lsjson\f[] is designed to be machine readable. +\f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human +readable. +\f[C]lsf\f[R] is designed to be human and machine readable. +\f[C]lsjson\f[R] is designed to be machine readable. .PP -Note that \f[C]ls\f[] and \f[C]lsl\f[] recurse by default \- use +Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use \[lq]\[en]max\-depth 1\[rq] to stop the recursion. .PP -The other list commands \f[C]lsd\f[],\f[C]lsf\f[],\f[C]lsjson\f[] do not -recurse by default \- use \[lq]\-R\[rq] to make them recurse. +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 \[lq]\-R\[rq] to make them recurse. .PP 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). +remotes which can\[cq]t have empty directories (eg s3, swift, gcs, etc +\- the bucket based remotes). .IP .nf \f[C] -rclone\ lsf\ remote:path\ [flags] -\f[] +rclone lsf remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-absolute\ \ \ \ \ \ \ \ \ \ \ Put\ a\ leading\ /\ in\ front\ of\ path\ names. -\ \ \ \ \ \ \-\-csv\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Output\ in\ CSV\ format. -\ \ \-d,\ \-\-dir\-slash\ \ \ \ \ \ \ \ \ \ Append\ a\ slash\ to\ directory\ names.\ (default\ true) -\ \ \ \ \ \ \-\-dirs\-only\ \ \ \ \ \ \ \ \ \ Only\ list\ directories. -\ \ \ \ \ \ \-\-files\-only\ \ \ \ \ \ \ \ \ Only\ list\ files. -\ \ \-F,\ \-\-format\ string\ \ \ \ \ \ Output\ format\ \-\ see\ \ help\ for\ details\ (default\ "p") -\ \ \ \ \ \ \-\-hash\ h\ \ \ \ \ \ \ \ \ \ \ \ \ Use\ this\ hash\ when\ h\ is\ used\ in\ the\ format\ MD5|SHA\-1|DropboxHash\ (default\ "MD5") -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ lsf -\ \ \-R,\ \-\-recursive\ \ \ \ \ \ \ \ \ \ Recurse\ into\ the\ listing. -\ \ \-s,\ \-\-separator\ string\ \ \ Separator\ for\ the\ items\ in\ the\ format.\ (default\ ";") -\f[] + \-\-absolute Put a leading / in front of path names. + \-\-csv Output in CSV format. + \-d, \-\-dir\-slash Append a slash to directory names. (default true) + \-\-dirs\-only Only list directories. + \-\-files\-only Only list files. + \-F, \-\-format string Output format \- see help for details (default \[dq]p\[dq]) + \-\-hash h Use this hash when h is used in the format MD5|SHA\-1|DropboxHash (default \[dq]MD5\[dq]) + \-h, \-\-help help for lsf + \-R, \-\-recursive Recurse into the listing. + \-s, \-\-separator string Separator for the items in the format. (default \[dq];\[dq]) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2829,11 +2886,17 @@ The output is an array of Items, where each Item looks like this \[lq]full/path/goes/here/file.txt\[rq], \[lq]Size\[rq] : 6, \[lq]Tier\[rq] : \[lq]hot\[rq], } .PP -If \[en]hash is not specified the Hashes property won't be emitted. +If \[en]hash is not specified the Hashes property won\[cq]t be emitted. .PP If \[en]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). .PP -If \[en]encrypted is not specified the Encrypted won't be emitted. +If \[en]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). +.PP +If \[en]encrypted is not specified the Encrypted won\[cq]t be emitted. .PP If \[en]dirs\-only is not specified files in addition to directories are returned @@ -2851,7 +2914,7 @@ Name. .PP If the directory is a bucket in a bucket based backend, then \[lq]IsBucket\[rq] will be set to true. -This key won't be present unless it is \[lq]true\[rq]. +This key won\[cq]t be present unless it is \[lq]true\[rq]. .PP The time is in RFC3339 format with up to nanosecond precision. The number of decimal digits in the seconds will depend on the precision @@ -2868,48 +2931,50 @@ Any of the filtering options can be applied to this command. .PP There are several related list commands .IP \[bu] 2 -\f[C]ls\f[] to list size and path of objects only +\f[C]ls\f[R] to list size and path of objects only .IP \[bu] 2 -\f[C]lsl\f[] to list modification time, size and path of objects only +\f[C]lsl\f[R] to list modification time, size and path of objects only .IP \[bu] 2 -\f[C]lsd\f[] to list directories only +\f[C]lsd\f[R] to list directories only .IP \[bu] 2 -\f[C]lsf\f[] to list objects and directories in easy to parse format +\f[C]lsf\f[R] to list objects and directories in easy to parse format .IP \[bu] 2 -\f[C]lsjson\f[] to list objects and directories in JSON format +\f[C]lsjson\f[R] to list objects and directories in JSON format .PP -\f[C]ls\f[],\f[C]lsl\f[],\f[C]lsd\f[] are designed to be human readable. -\f[C]lsf\f[] is designed to be human and machine readable. -\f[C]lsjson\f[] is designed to be machine readable. +\f[C]ls\f[R],\f[C]lsl\f[R],\f[C]lsd\f[R] are designed to be human +readable. +\f[C]lsf\f[R] is designed to be human and machine readable. +\f[C]lsjson\f[R] is designed to be machine readable. .PP -Note that \f[C]ls\f[] and \f[C]lsl\f[] recurse by default \- use +Note that \f[C]ls\f[R] and \f[C]lsl\f[R] recurse by default \- use \[lq]\[en]max\-depth 1\[rq] to stop the recursion. .PP -The other list commands \f[C]lsd\f[],\f[C]lsf\f[],\f[C]lsjson\f[] do not -recurse by default \- use \[lq]\-R\[rq] to make them recurse. +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 \[lq]\-R\[rq] to make them recurse. .PP 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). +remotes which can\[cq]t have empty directories (eg s3, swift, gcs, etc +\- the bucket based remotes). .IP .nf \f[C] -rclone\ lsjson\ remote:path\ [flags] -\f[] +rclone lsjson remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-dirs\-only\ \ \ \ Show\ only\ directories\ in\ the\ listing. -\ \ \-M,\ \-\-encrypted\ \ \ \ Show\ the\ encrypted\ names. -\ \ \ \ \ \ \-\-files\-only\ \ \ Show\ only\ files\ in\ the\ listing. -\ \ \ \ \ \ \-\-hash\ \ \ \ \ \ \ \ \ Include\ hashes\ in\ the\ output\ (may\ take\ longer). -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ help\ for\ lsjson -\ \ \ \ \ \ \-\-no\-modtime\ \ \ Don\[aq]t\ read\ the\ modification\ time\ (can\ speed\ things\ up). -\ \ \ \ \ \ \-\-original\ \ \ \ \ Show\ the\ ID\ of\ the\ underlying\ Object. -\ \ \-R,\ \-\-recursive\ \ \ \ Recurse\ into\ the\ listing. -\f[] + \-\-dirs\-only Show only directories in the listing. + \-M, \-\-encrypted Show the encrypted names. + \-\-files\-only Show only files in the listing. + \-\-hash Include hashes in the output (may take longer). + \-h, \-\-help help for lsjson + \-\-no\-mimetype Don\[aq]t read the mime type (can speed things up). + \-\-no\-modtime Don\[aq]t read the modification time (can speed things up). + \-\-original Show the ID of the underlying Object. + \-R, \-\-recursive Recurse into the listing. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -2924,41 +2989,41 @@ Mount the remote as file system on a mountpoint. .SS Synopsis .PP rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of -Rclone's cloud storage systems as a file system with FUSE. +Rclone\[cq]s cloud storage systems as a file system with FUSE. .PP -First set up your remote using \f[C]rclone\ config\f[]. -Check it works with \f[C]rclone\ ls\f[] etc. +First set up your remote using \f[C]rclone config\f[R]. +Check it works with \f[C]rclone ls\f[R] etc. .PP Start the mount like this .IP .nf \f[C] -rclone\ mount\ remote:path/to/files\ /path/to/local/mount -\f[] +rclone mount remote:path/to/files /path/to/local/mount +\f[R] .fi .PP Or on Windows like this where X: is an unused drive letter .IP .nf \f[C] -rclone\ mount\ remote:path/to/files\ X: -\f[] +rclone mount remote:path/to/files X: +\f[R] .fi .PP When the program ends, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped. .PP 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 +When that happens, it is the user\[cq]s responsibility to stop the mount manually with .IP .nf \f[C] -#\ Linux -fusermount\ \-u\ /path/to/local/mount -#\ OS\ X -umount\ /path/to/local/mount -\f[] +# Linux +fusermount \-u /path/to/local/mount +# OS X +umount /path/to/local/mount +\f[R] .fi .SS Installing on Windows .PP @@ -2991,7 +3056,7 @@ alternatively using the nssm service manager (https://nssm.cc/usage). .PP Without the use of \[lq]\[en]vfs\-cache\-mode\[rq] 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 +This means that many applications won\[cq]t work with their files on an rclone mount without \[lq]\[en]vfs\-cache\-mode writes\[rq] or \[lq]\[en]vfs\-cache\-mode full\[rq]. See the File Caching section for more info. @@ -3007,8 +3072,8 @@ Only supported on Linux, FreeBSD, OS X and Windows at the moment. 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. +However rclone mount can\[cq]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. .SS Attribute caching .PP @@ -3044,7 +3109,7 @@ 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. .PP -If files don't change on the remote outside of the control of rclone +If files don\[cq]t change on the remote outside of the control of rclone then there is no chance of corruption. .PP This is the same as setting the attr_timeout option in mount.fuse. @@ -3086,7 +3151,7 @@ file will always be copied to the vfs cache before opening with \[en]vfs\-cache\-mode full. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -3094,15 +3159,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -3110,41 +3175,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -3152,27 +3217,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -3188,9 +3253,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -3200,7 +3265,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -3210,13 +3275,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -3239,7 +3304,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -3248,46 +3313,46 @@ If an upload or download fails it will be retried up to .IP .nf \f[C] -rclone\ mount\ remote:path\ /path/to/mountpoint\ [flags] -\f[] +rclone mount remote:path /path/to/mountpoint [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-allow\-non\-empty\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ mounting\ over\ a\ non\-empty\ directory. -\ \ \ \ \ \ \-\-allow\-other\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ access\ to\ other\ users. -\ \ \ \ \ \ \-\-allow\-root\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ access\ to\ root\ user. -\ \ \ \ \ \ \-\-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). -\ \ \ \ \ \ \-\-debug\-fuse\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Debug\ the\ FUSE\ internals\ \-\ needs\ \-v. -\ \ \ \ \ \ \-\-default\-permissions\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Makes\ kernel\ enforce\ access\ control\ based\ on\ the\ file\ mode. -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ mount -\ \ \ \ \ \ \-\-max\-read\-ahead\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ number\ of\ bytes\ that\ can\ be\ prefetched\ for\ sequential\ reads.\ (default\ 128k) -\ \ \ \ \ \ \-\-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. -\ \ \-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. -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\ \ \ \ \ \ \-\-volname\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Set\ the\ volume\ name\ (not\ supported\ by\ all\ OSes). -\ \ \ \ \ \ \-\-write\-back\-cache\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Makes\ kernel\ buffer\ writes\ before\ sending\ them\ to\ rclone.\ Without\ this,\ writethrough\ caching\ is\ used. -\f[] + \-\-allow\-non\-empty Allow mounting over a non\-empty directory. + \-\-allow\-other Allow access to other users. + \-\-allow\-root Allow access to root user. + \-\-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). + \-\-debug\-fuse Debug the FUSE internals \- needs \-v. + \-\-default\-permissions Makes kernel enforce access control based on the file mode. + \-\-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) + \-h, \-\-help help for mount + \-\-max\-read\-ahead SizeSuffix The number of bytes that can be prefetched for sequential reads. (default 128k) + \-\-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. + \-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. + \-\-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) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) + \-\-volname string Set the volume name (not supported by all OSes). + \-\-write\-back\-cache Makes kernel buffer writes before sending them to rclone. Without this, writethrough caching is used. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3312,8 +3377,8 @@ So .IP .nf \f[C] -rclone\ moveto\ src\ dst -\f[] +rclone moveto src dst +\f[R] .fi .PP where src and dst are rclone paths, either remote:path or /path/to/local @@ -3323,35 +3388,35 @@ This will: .IP .nf \f[C] -if\ src\ is\ file -\ \ \ \ move\ it\ to\ dst,\ overwriting\ an\ existing\ file\ if\ it\ exists -if\ src\ is\ directory -\ \ \ \ move\ it\ to\ dst,\ overwriting\ existing\ files\ if\ they\ exist -\ \ \ \ see\ move\ command\ for\ full\ details -\f[] +if src is file + move it to dst, overwriting an existing file if it exists +if src is directory + move it to dst, overwriting existing files if they exist + see move command for full details +\f[R] .fi .PP -This doesn't transfer unchanged files, testing by size and modification -time or MD5SUM. +This doesn\[cq]t transfer unchanged files, testing by size and +modification time or MD5SUM. src will be deleted on successful transfer. .PP -\f[B]Important\f[]: Since this can cause data loss, test first with the +\f[B]Important\f[R]: Since this can cause data loss, test first with the \[en]dry\-run flag. .PP -\f[B]Note\f[]: Use the \f[C]\-P\f[]/\f[C]\-\-progress\f[] flag to view -real\-time transfer statistics. +\f[B]Note\f[R]: Use the \f[C]\-P\f[R]/\f[C]\-\-progress\f[R] flag to +view real\-time transfer statistics. .IP .nf \f[C] -rclone\ moveto\ source:path\ dest:path\ [flags] -\f[] +rclone moveto source:path dest:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ moveto -\f[] + \-h, \-\-help help for moveto +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3379,18 +3444,19 @@ Here are the keys \- press `?' to toggle the help on and off .IP .nf \f[C] -\ ↑,↓\ or\ k,j\ to\ Move -\ →,l\ to\ enter -\ ←,h\ to\ return -\ c\ toggle\ counts -\ g\ toggle\ graph -\ n,s,C\ sort\ by\ name,size,count -\ d\ delete\ file/directory -\ Y\ display\ current\ path -\ ^L\ refresh\ screen -\ ?\ to\ toggle\ help\ on\ and\ off -\ q/ESC/c\-C\ to\ quit -\f[] + \[ua],\[da] or k,j to Move + \[->],l to enter + \[<-],h to return + c toggle counts + g toggle graph + n,s,C sort by name,size,count + d delete file/directory + y copy current path to clipbard + Y display current path + \[ha]L refresh screen + ? to toggle help on and off + q/ESC/c\-C to quit +\f[R] .fi .PP This an homage to the ncdu tool (https://dev.yorhel.nl/ncdu) but for @@ -3398,20 +3464,20 @@ rclone remotes. It is missing lots of features at the moment but is useful as it stands. .PP Note that it might take some time to delete big files/folders. -The UI won't respond in the meantime since the deletion is done +The UI won\[cq]t respond in the meantime since the deletion is done synchronously. .IP .nf \f[C] -rclone\ ncdu\ remote:path\ [flags] -\f[] +rclone ncdu remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ ncdu -\f[] + \-h, \-\-help help for ncdu +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3429,15 +3495,15 @@ Obscure password for use in the rclone.conf .IP .nf \f[C] -rclone\ obscure\ password\ [flags] -\f[] +rclone obscure password [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ obscure -\f[] + \-h, \-\-help help for obscure +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3477,29 +3543,29 @@ rc server, eg: .IP .nf \f[C] -rclone\ rc\ \-\-loopback\ operations/about\ fs=/ -\f[] +rclone rc \-\-loopback operations/about fs=/ +\f[R] .fi .PP Use \[lq]rclone rc\[rq] to see a list of all possible commands. .IP .nf \f[C] -rclone\ rc\ commands\ parameter\ [flags] -\f[] +rclone rc commands parameter [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-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. -\ \ \ \ \ \ \-\-pass\ string\ \ \ Password\ to\ use\ to\ connect\ to\ rclone\ remote\ control. -\ \ \ \ \ \ \-\-url\ string\ \ \ \ URL\ to\ connect\ to\ rclone\ remote\ control.\ (default\ "http://localhost:5572/") -\ \ \ \ \ \ \-\-user\ string\ \ \ Username\ to\ use\ to\ rclone\ remote\ control. -\f[] + \-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. + \-\-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]) + \-\-user string Username to use to rclone remote control. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3518,9 +3584,9 @@ remote file. .IP .nf \f[C] -echo\ "hello\ world"\ |\ rclone\ rcat\ remote:path/to/file -ffmpeg\ \-\ |\ rclone\ rcat\ remote:path/to/file -\f[] +echo \[dq]hello world\[dq] | rclone rcat remote:path/to/file +ffmpeg \- | rclone rcat remote:path/to/file +\f[R] .fi .PP If the remote file already exists, it will be overwritten. @@ -3530,7 +3596,7 @@ usually more efficient than the streaming/chunked upload endpoints, which use multiple requests. Exact behaviour depends on the remote. What is considered a small file may be set through -\f[C]\-\-streaming\-upload\-cutoff\f[]. +\f[C]\-\-streaming\-upload\-cutoff\f[R]. Uploading only starts after the cutoff is reached or if the file ends before that. The data must fit into RAM. @@ -3541,20 +3607,20 @@ performance. .PP Note that the upload can also not be retried because the data is not kept around until the upload succeeds. -If you need to transfer a lot of data, you're better off caching locally -and then \f[C]rclone\ move\f[] it to the destination. +If you need to transfer a lot of data, you\[cq]re better off caching +locally and then \f[C]rclone move\f[R] it to the destination. .IP .nf \f[C] -rclone\ rcat\ remote:path\ [flags] -\f[] +rclone rcat remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ rcat -\f[] + \-h, \-\-help help for rcat +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3581,15 +3647,15 @@ rc flags. .IP .nf \f[C] -rclone\ rcd\ *\ [flags] -\f[] +rclone rcd * [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ rcd -\f[] + \-h, \-\-help help for rcd +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3615,16 +3681,16 @@ empty directories in. .IP .nf \f[C] -rclone\ rmdirs\ remote:path\ [flags] -\f[] +rclone rmdirs remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ help\ for\ rmdirs -\ \ \ \ \ \ \-\-leave\-root\ \ \ Do\ not\ remove\ root\ directory\ if\ empty -\f[] + \-h, \-\-help help for rmdirs + \-\-leave\-root Do not remove root directory if empty +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3644,23 +3710,23 @@ eg .IP .nf \f[C] -rclone\ serve\ http\ remote: -\f[] +rclone serve http remote: +\f[R] .fi .PP Each subcommand has its own options which you can see in their help. .IP .nf \f[C] -rclone\ serve\ \ [opts]\ \ [flags] -\f[] +rclone serve [opts] [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ serve -\f[] + \-h, \-\-help help for serve +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3680,7 +3746,7 @@ rclone serve http (https://rclone.org/commands/rclone_serve_http/) \- Serve the remote over HTTP. .IP \[bu] 2 rclone serve restic (https://rclone.org/commands/rclone_serve_restic/) -\- Serve the remote for restic's REST API. +\- Serve the remote for restic\[cq]s REST API. .IP \[bu] 2 rclone serve sftp (https://rclone.org/commands/rclone_serve_sftp/) \- Serve the remote over SFTP. @@ -3718,7 +3784,7 @@ Use \[en]log\-trace in conjunction with \-vv to enable additional debug logging of all UPNP traffic. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -3726,15 +3792,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -3742,41 +3808,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -3784,27 +3850,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -3820,9 +3886,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -3832,7 +3898,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -3842,13 +3908,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -3871,7 +3937,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -3880,36 +3946,36 @@ If an upload or download fails it will be retried up to .IP .nf \f[C] -rclone\ serve\ dlna\ remote:path\ [flags] -\f[] +rclone serve dlna remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-addr\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ip:port\ or\ :port\ to\ bind\ the\ DLNA\ http\ server\ to.\ (default\ ":7879") -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ dlna -\ \ \ \ \ \ \-\-log\-trace\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ enable\ trace\ logging\ of\ SOAP\ traffic -\ \ \ \ \ \ \-\-name\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ name\ of\ DLNA\ server -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\f[] + \-\-addr string ip:port or :port to bind the DLNA http server to. (default \[dq]:7879\[dq]) + \-\-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) + \-h, \-\-help help for dlna + \-\-log\-trace enable trace logging of SOAP traffic + \-\-name string name of DLNA server + \-\-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. + \-\-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) + \-\-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) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -3945,7 +4011,7 @@ You can set a single username and password with the \[en]user and \[en]pass flags. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -3953,15 +4019,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -3969,41 +4035,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -4011,27 +4077,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -4047,9 +4113,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -4059,7 +4125,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -4069,13 +4135,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -4098,7 +4164,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -4106,7 +4172,7 @@ If an upload or download fails it will be retried up to \[en]low\-level\-retries times. .SS Auth Proxy .PP -If you supply the parameter \f[C]\-\-auth\-proxy\ /path/to/program\f[] +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 @@ -4116,17 +4182,18 @@ There is an example program bin/test_proxy.py (https://github.com/rclone/rclone/blob/master/test_proxy.py) in the rclone source code. .PP -The program's job is to take a \f[C]user\f[] and \f[C]pass\f[] on the -input and turn those into the config for a backend on STDOUT in JSON +The program\[cq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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. +it won\[cq]t use configuration from environment variables or command +line options \- it is the job of the proxy program to make a complete +config. .PP -This config generated must have this extra parameter \- \f[C]_root\f[] +This config generated must have this extra parameter \- \f[C]_root\f[R] \- root to use for the backend .PP -And it may have this parameter \- \f[C]_obscure\f[] \- comma separated +And it may have this parameter \- \f[C]_obscure\f[R] \- comma separated strings for parameters to obscure .PP For example the program might take this on STDIN @@ -4134,10 +4201,10 @@ For example the program might take this on STDIN .nf \f[C] { -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword" + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq] } -\f[] +\f[R] .fi .PP And return this on STDOUT @@ -4145,74 +4212,74 @@ And return this on STDOUT .nf \f[C] { -\ \ \ \ "type":\ "sftp", -\ \ \ \ "_root":\ "", -\ \ \ \ "_obscure":\ "pass", -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword", -\ \ \ \ "host":\ "sftp.example.com" + \[dq]type\[dq]: \[dq]sftp\[dq], + \[dq]_root\[dq]: \[dq]\[dq], + \[dq]_obscure\[dq]: \[dq]pass\[dq], + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq], + \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } -\f[] +\f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the -\f[C]user\f[] and \f[C]pass\f[] returned in the output to the host +\f[C]user\f[R] and \f[C]pass\f[R] returned in the output to the host given. -Note that since \f[C]_obscure\f[] is set to \f[C]pass\f[], rclone will -obscure the \f[C]pass\f[] parameter before creating the backend (which +Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will +obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP -The progam can manipulate the supplied \f[C]user\f[] in any way, for +The progam can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make -the \f[C]user\f[] be \f[C]user\@example.com\f[] and then set the -\f[C]host\f[] to \f[C]example.com\f[] in the output and the user to -\f[C]user\f[]. -For security you'd probably want to restrict the \f[C]host\f[] to a +the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the +\f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to +\f[C]user\f[R]. +For security you\[cq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP -Note that an internal cache is keyed on \f[C]user\f[] so only use that -for configuration, don't use \f[C]pass\f[]. -This also means that if a user's password is changed the cache will need -to expire (which takes 5 mins) before it takes effect. +Note that an internal cache is keyed on \f[C]user\f[R] so only use that +for configuration, don\[cq]t use \f[C]pass\f[R]. +This also means that if a user\[cq]s password is changed the cache will +need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] -rclone\ serve\ ftp\ remote:path\ [flags] -\f[] +rclone serve ftp remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ ftp -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ for\ authentication.\ (empty\ value\ allow\ every\ password) -\ \ \ \ \ \ \-\-passive\-port\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Passive\ port\ range\ to\ use.\ (default\ "30000\-32000") -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\f[] + \-\-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. + \-\-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) + \-h, \-\-help help for ftp + \-\-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. + \-\-pass string Password for authentication. (empty value allow every password) + \-\-passive\-port string Passive port range to use. (default \[dq]30000\-32000\[dq]) + \-\-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) + \-\-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) + \-\-vfs\-cache\-mode CacheMode Cache mode off|minimal|writes|full (default off) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -4282,10 +4349,10 @@ To create an htpasswd file: .IP .nf \f[C] -touch\ htpasswd -htpasswd\ \-B\ htpasswd\ user -htpasswd\ \-B\ htpasswd\ anotherUser -\f[] +touch htpasswd +htpasswd \-B htpasswd user +htpasswd \-B htpasswd anotherUser +\f[R] .fi .PP The password file can be updated while rclone is running. @@ -4305,7 +4372,7 @@ concatenation of that with the CA certificate. should be the PEM encoded client certificate authority certificate. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -4313,15 +4380,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -4329,41 +4396,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -4371,27 +4438,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -4407,9 +4474,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -4419,7 +4486,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -4429,13 +4496,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -4458,7 +4525,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -4467,45 +4534,45 @@ If an upload or download fails it will be retried up to .IP .nf \f[C] -rclone\ serve\ http\ remote:path\ [flags] -\f[] +rclone serve http remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-addr\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ IPaddress:Port\ or\ :Port\ to\ bind\ server\ to.\ (default\ "localhost:8080") -\ \ \ \ \ \ \-\-baseurl\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Prefix\ for\ URLs\ \-\ leave\ blank\ for\ root. -\ \ \ \ \ \ \-\-cert\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ key\ (concatenation\ of\ certificate\ and\ CA\ certificate) -\ \ \ \ \ \ \-\-client\-ca\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Client\ certificate\ authority\ to\ verify\ clients\ with -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ http -\ \ \ \ \ \ \-\-htpasswd\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ htpasswd\ file\ \-\ if\ not\ provided\ no\ authentication\ is\ done -\ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key -\ \ \ \ \ \ \-\-max\-header\-bytes\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Maximum\ size\ of\ request\ header\ (default\ 4096) -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") -\ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) -\ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (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) -\ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\f[] + \-\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:8080\[dq]) + \-\-baseurl string Prefix for URLs \- leave blank for root. + \-\-cert string SSL PEM key (concatenation of certificate and CA certificate) + \-\-client\-ca string Client certificate authority to verify clients with + \-\-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) + \-h, \-\-help help for http + \-\-htpasswd string htpasswd file \- if not provided no authentication is done + \-\-key string SSL PEM Private key + \-\-max\-header\-bytes int Maximum size of request header (default 4096) + \-\-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. + \-\-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. + \-\-realm string realm for authentication (default \[dq]rclone\[dq]) + \-\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) + \-\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) + \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. (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) + \-\-vfs\-cache\-mode CacheMode Cache mode off|minimal|writes|full (default off) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -4516,10 +4583,10 @@ rclone serve (https://rclone.org/commands/rclone_serve/) \- Serve a remote over a protocol. .SS rclone serve restic .PP -Serve the remote for restic's REST API. +Serve the remote for restic\[cq]s REST API. .SS Synopsis .PP -rclone serve restic implements restic's REST backend API over HTTP. +rclone serve restic implements restic\[cq]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. .PP @@ -4544,8 +4611,8 @@ Now start the rclone restic server .IP .nf \f[C] -rclone\ serve\ restic\ \-v\ remote:backup -\f[] +rclone serve restic \-v remote:backup +\f[R] .fi .PP Where you can replace \[lq]backup\[rq] in the above by whatever path in @@ -4571,36 +4638,36 @@ For example: .IP .nf \f[C] -$\ export\ RESTIC_REPOSITORY=rest:http://localhost:8080/ -$\ export\ RESTIC_PASSWORD=yourpassword -$\ restic\ init -created\ restic\ backend\ 8b1a4b56ae\ at\ rest:http://localhost:8080/ +$ export RESTIC_REPOSITORY=rest:http://localhost:8080/ +$ export RESTIC_PASSWORD=yourpassword +$ restic init +created restic backend 8b1a4b56ae at rest:http://localhost:8080/ -Please\ note\ that\ knowledge\ of\ your\ password\ is\ required\ to\ access -the\ repository.\ Losing\ your\ password\ means\ that\ your\ data\ is -irrecoverably\ lost. -$\ restic\ backup\ /path/to/files/to/backup -scan\ [/path/to/files/to/backup] -scanned\ 189\ directories,\ 312\ files\ in\ 0:00 -[0:00]\ 100.00%\ \ 38.128\ MiB\ /\ 38.128\ MiB\ \ 501\ /\ 501\ items\ \ 0\ errors\ \ ETA\ 0:00 -duration:\ 0:00 -snapshot\ 45c8fdd8\ saved -\f[] +Please note that knowledge of your password is required to access +the repository. Losing your password means that your data is +irrecoverably lost. +$ restic backup /path/to/files/to/backup +scan [/path/to/files/to/backup] +scanned 189 directories, 312 files in 0:00 +[0:00] 100.00% 38.128 MiB / 38.128 MiB 501 / 501 items 0 errors ETA 0:00 +duration: 0:00 +snapshot 45c8fdd8 saved +\f[R] .fi .SS Multiple repositories .PP Note that you can use the endpoint to host multiple repositories. Do this by adding a directory name or path after the URL. -Note that these \f[B]must\f[] end with /. +Note that these \f[B]must\f[R] end with /. Eg .IP .nf \f[C] -$\ export\ RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ -#\ backup\ user1\ stuff -$\ export\ RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ -#\ backup\ user2\ stuff -\f[] +$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user1repo/ +# backup user1 stuff +$ export RESTIC_REPOSITORY=rest:http://localhost:8080/user2repo/ +# backup user2 stuff +\f[R] .fi .SS Private repositories .PP @@ -4649,10 +4716,10 @@ To create an htpasswd file: .IP .nf \f[C] -touch\ htpasswd -htpasswd\ \-B\ htpasswd\ user -htpasswd\ \-B\ htpasswd\ anotherUser -\f[] +touch htpasswd +htpasswd \-B htpasswd user +htpasswd \-B htpasswd anotherUser +\f[R] .fi .PP The password file can be updated while rclone is running. @@ -4673,30 +4740,30 @@ should be the PEM encoded client certificate authority certificate. .IP .nf \f[C] -rclone\ serve\ restic\ remote:path\ [flags] -\f[] +rclone serve restic remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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 -\ \ \ \ \ \ \-\-htpasswd\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ htpasswd\ file\ \-\ if\ not\ provided\ no\ authentication\ is\ done -\ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key -\ \ \ \ \ \ \-\-max\-header\-bytes\ int\ \ \ \ \ \ \ \ \ \ \ \ Maximum\ size\ of\ request\ header\ (default\ 4096) -\ \ \ \ \ \ \-\-pass\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Password\ for\ authentication. -\ \ \ \ \ \ \-\-private\-repos\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ users\ can\ only\ access\ their\ private\ repo -\ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") -\ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-stdio\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ run\ an\ HTTP2\ server\ on\ stdin/stdout -\ \ \ \ \ \ \-\-user\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ User\ name\ for\ authentication. -\f[] + \-\-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. + \-\-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 + \-\-htpasswd string htpasswd file \- if not provided no authentication is done + \-\-key string SSL PEM Private key + \-\-max\-header\-bytes int Maximum size of request header (default 4096) + \-\-pass string Password for authentication. + \-\-private\-repos users can only access their private repo + \-\-realm string realm for authentication (default \[dq]rclone\[dq]) + \-\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) + \-\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) + \-\-stdio run an HTTP2 server on stdin/stdout + \-\-user string User name for authentication. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -4735,8 +4802,8 @@ backend. This means that is can support SHA1SUMs, MD5SUMs and the about command when paired with the rclone sftp backend. .PP -If you don't supply a \[en]key then rclone will generate one and cache -it for later use. +If you don\[cq]t supply a \[en]key then rclone will generate one and +cache it for later use. .PP By default the server binds to localhost:2022 \- if you want it to be reachable externally then supply \[lq]\[en]addr :2022\[rq] for example. @@ -4745,7 +4812,7 @@ Note that the default of \[lq]\[en]vfs\-cache\-mode off\[rq] is fine for the rclone sftp backend, but it may not be with other SFTP clients. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -4753,15 +4820,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -4769,41 +4836,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -4811,27 +4878,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -4847,9 +4914,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -4859,7 +4926,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -4869,13 +4936,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -4898,7 +4965,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -4906,7 +4973,7 @@ If an upload or download fails it will be retried up to \[en]low\-level\-retries times. .SS Auth Proxy .PP -If you supply the parameter \f[C]\-\-auth\-proxy\ /path/to/program\f[] +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 @@ -4916,17 +4983,18 @@ There is an example program bin/test_proxy.py (https://github.com/rclone/rclone/blob/master/test_proxy.py) in the rclone source code. .PP -The program's job is to take a \f[C]user\f[] and \f[C]pass\f[] on the -input and turn those into the config for a backend on STDOUT in JSON +The program\[cq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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. +it won\[cq]t use configuration from environment variables or command +line options \- it is the job of the proxy program to make a complete +config. .PP -This config generated must have this extra parameter \- \f[C]_root\f[] +This config generated must have this extra parameter \- \f[C]_root\f[R] \- root to use for the backend .PP -And it may have this parameter \- \f[C]_obscure\f[] \- comma separated +And it may have this parameter \- \f[C]_obscure\f[R] \- comma separated strings for parameters to obscure .PP For example the program might take this on STDIN @@ -4934,10 +5002,10 @@ For example the program might take this on STDIN .nf \f[C] { -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword" + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq] } -\f[] +\f[R] .fi .PP And return this on STDOUT @@ -4945,75 +5013,75 @@ And return this on STDOUT .nf \f[C] { -\ \ \ \ "type":\ "sftp", -\ \ \ \ "_root":\ "", -\ \ \ \ "_obscure":\ "pass", -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword", -\ \ \ \ "host":\ "sftp.example.com" + \[dq]type\[dq]: \[dq]sftp\[dq], + \[dq]_root\[dq]: \[dq]\[dq], + \[dq]_obscure\[dq]: \[dq]pass\[dq], + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq], + \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } -\f[] +\f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the -\f[C]user\f[] and \f[C]pass\f[] returned in the output to the host +\f[C]user\f[R] and \f[C]pass\f[R] returned in the output to the host given. -Note that since \f[C]_obscure\f[] is set to \f[C]pass\f[], rclone will -obscure the \f[C]pass\f[] parameter before creating the backend (which +Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will +obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP -The progam can manipulate the supplied \f[C]user\f[] in any way, for +The progam can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make -the \f[C]user\f[] be \f[C]user\@example.com\f[] and then set the -\f[C]host\f[] to \f[C]example.com\f[] in the output and the user to -\f[C]user\f[]. -For security you'd probably want to restrict the \f[C]host\f[] to a +the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the +\f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to +\f[C]user\f[R]. +For security you\[cq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP -Note that an internal cache is keyed on \f[C]user\f[] so only use that -for configuration, don't use \f[C]pass\f[]. -This also means that if a user's password is changed the cache will need -to expire (which takes 5 mins) before it takes effect. +Note that an internal cache is keyed on \f[C]user\f[R] so only use that +for configuration, don\[cq]t use \f[C]pass\f[R]. +This also means that if a user\[cq]s password is changed the cache will +need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] -rclone\ serve\ sftp\ remote:path\ [flags] -\f[] +rclone serve sftp remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-addr\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ IPaddress:Port\ or\ :Port\ to\ bind\ server\ to.\ (default\ "localhost:2022") -\ \ \ \ \ \ \-\-auth\-proxy\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ A\ program\ to\ use\ to\ create\ the\ backend\ from\ the\ auth. -\ \ \ \ \ \ \-\-authorized\-keys\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Authorized\ keys\ file\ (default\ "~/.ssh/authorized_keys") -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ sftp -\ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSH\ private\ key\ file\ (leave\ blank\ to\ auto\ generate) -\ \ \ \ \ \ \-\-no\-auth\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ connections\ with\ no\ authentication\ if\ set. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-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) -\ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\f[] + \-\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:2022\[dq]) + \-\-auth\-proxy string A program to use to create the backend from the auth. + \-\-authorized\-keys string Authorized keys file (default \[dq]\[ti]/.ssh/authorized_keys\[dq]) + \-\-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) + \-h, \-\-help help for sftp + \-\-key string SSH private key file (leave blank to auto generate) + \-\-no\-auth Allow connections with no authentication if set. + \-\-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. + \-\-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) + \-\-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) + \-\-vfs\-cache\-mode CacheMode Cache mode off|minimal|writes|full (default off) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -5086,10 +5154,10 @@ To create an htpasswd file: .IP .nf \f[C] -touch\ htpasswd -htpasswd\ \-B\ htpasswd\ user -htpasswd\ \-B\ htpasswd\ anotherUser -\f[] +touch htpasswd +htpasswd \-B htpasswd user +htpasswd \-B htpasswd anotherUser +\f[R] .fi .PP The password file can be updated while rclone is running. @@ -5109,7 +5177,7 @@ concatenation of that with the CA certificate. should be the PEM encoded client certificate authority certificate. .SS Directory Cache .PP -Using the \f[C]\-\-dir\-cache\-time\f[] flag, you can set how long a +Using the \f[C]\-\-dir\-cache\-time\f[R] flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate @@ -5117,15 +5185,15 @@ the cache. However, changes done on the remote will only be picked up once the cache expires. .PP -Alternatively, you can send a \f[C]SIGHUP\f[] signal to rclone for it to -flush all directory caches, regardless of how old they are. +Alternatively, you can send a \f[C]SIGHUP\f[R] signal to rclone for it +to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this: .IP .nf \f[C] -kill\ \-SIGHUP\ $(pidof\ rclone) -\f[] +kill \-SIGHUP $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -5133,41 +5201,41 @@ rclone rc to flush the whole directory cache: .IP .nf \f[C] -rclone\ rc\ vfs/forget -\f[] +rclone rc vfs/forget +\f[R] .fi .PP Or individual files or directories: .IP .nf \f[C] -rclone\ rc\ vfs/forget\ file=path/to/file\ dir=path/to/dir -\f[] +rclone rc vfs/forget file=path/to/file dir=path/to/dir +\f[R] .fi .SS File Buffering .PP -The \f[C]\-\-buffer\-size\f[] flag determines the amount of memory, that -will be used to buffer data in advance. +The \f[C]\-\-buffer\-size\f[R] flag determines the amount of memory, +that will be used to buffer data in advance. .PP Each open file descriptor will try to keep the specified amount of data in memory at all times. -The buffered data is bound to one file descriptor and won't be shared -between multiple open file descriptors of the same file. +The buffered data is bound to one file descriptor and won\[cq]t be +shared between multiple open file descriptors of the same file. .PP This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to -\f[C]\-\-buffer\-size\ *\ open\ files\f[]. +\f[C]\-\-buffer\-size * open files\f[R]. .SS File Caching .PP These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system. .PP -You'll need to enable VFS caching if you want, for example, to read and -write simultaneously to a file. +You\[cq]ll need to enable VFS caching if you want, for example, to read +and write simultaneously to a file. See below for more details. .PP Note that the VFS cache works in addition to the cache backend and you @@ -5175,27 +5243,27 @@ may find that you need one or the other or both. .IP .nf \f[C] -\-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching. -\-\-vfs\-cache\-max\-age\ duration\ \ \ \ \ \ \ \ \ Max\ age\ of\ objects\ in\ the\ cache.\ (default\ 1h0m0s) -\-\-vfs\-cache\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ "off") -\-\-vfs\-cache\-poll\-interval\ duration\ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\-\-vfs\-cache\-max\-size\ int\ \ \ \ \ \ \ \ \ \ \ \ \ Max\ total\ size\ of\ objects\ in\ the\ cache.\ (default\ off) -\f[] +\-\-cache\-dir string Directory rclone will use for caching. +\-\-vfs\-cache\-max\-age duration Max age of objects in the cache. (default 1h0m0s) +\-\-vfs\-cache\-mode string Cache mode off|minimal|writes|full (default \[dq]off\[dq]) +\-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) +\-\-vfs\-cache\-max\-size int Max total size of objects in the cache. (default off) +\f[R] .fi .PP -If run with \f[C]\-vv\f[] rclone will print the location of the file +If run with \f[C]\-vv\f[R] 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 \f[C]\-\-cache\-dir\f[] or setting the +but can be controlled with \f[C]\-\-cache\-dir\f[R] or setting the appropriate environment variable. .PP The cache has 4 different modes selected by -\f[C]\-\-vfs\-cache\-mode\f[]. +\f[C]\-\-vfs\-cache\-mode\f[R]. The higher the cache mode the more compatible rclone becomes at the cost of using disk space. .PP Note that files are written back to the remote only when they are closed -so if rclone is quit or dies with open files then these won't get +so if rclone is quit or dies with open files then these won\[cq]t get written back to the remote. However they will still be in the on disk cache. .PP @@ -5211,9 +5279,9 @@ directly to the remote without caching anything on disk. .PP This will mean some operations are not possible .IP \[bu] 2 -Files can't be opened for both read AND write +Files can\[cq]t be opened for both read AND write .IP \[bu] 2 -Files opened for write can't be seeked +Files opened for write can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 @@ -5223,7 +5291,7 @@ Files open for write only will behave as if O_TRUNC was supplied .IP \[bu] 2 Open modes O_APPEND, O_TRUNC are ignored .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode minimal .PP This is very similar to \[lq]off\[rq] except that files opened for read @@ -5233,13 +5301,13 @@ but uses the minimal disk space. .PP These operations are not possible .IP \[bu] 2 -Files opened for write only can't be seeked +Files opened for write only can\[cq]t be seeked .IP \[bu] 2 Existing files opened for write must have O_TRUNC set .IP \[bu] 2 Files opened for write only will ignore O_APPEND, O_TRUNC .IP \[bu] 2 -If an upload fails it can't be retried +If an upload fails it can\[cq]t be retried .SS \[en]vfs\-cache\-mode writes .PP In this mode files opened for read only are still read directly from the @@ -5262,7 +5330,7 @@ including caching directory hierarchies and chunks of files. In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to -\f[C]\-\-vfs\-cache\-max\-age\f[]. +\f[C]\-\-vfs\-cache\-max\-age\f[R]. .PP This mode should support all normal file system operations. .PP @@ -5270,7 +5338,7 @@ If an upload or download fails it will be retried up to \[en]low\-level\-retries times. .SS Auth Proxy .PP -If you supply the parameter \f[C]\-\-auth\-proxy\ /path/to/program\f[] +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 @@ -5280,17 +5348,18 @@ There is an example program bin/test_proxy.py (https://github.com/rclone/rclone/blob/master/test_proxy.py) in the rclone source code. .PP -The program's job is to take a \f[C]user\f[] and \f[C]pass\f[] on the -input and turn those into the config for a backend on STDOUT in JSON +The program\[cq]s job is to take a \f[C]user\f[R] and \f[C]pass\f[R] 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. +it won\[cq]t use configuration from environment variables or command +line options \- it is the job of the proxy program to make a complete +config. .PP -This config generated must have this extra parameter \- \f[C]_root\f[] +This config generated must have this extra parameter \- \f[C]_root\f[R] \- root to use for the backend .PP -And it may have this parameter \- \f[C]_obscure\f[] \- comma separated +And it may have this parameter \- \f[C]_obscure\f[R] \- comma separated strings for parameters to obscure .PP For example the program might take this on STDIN @@ -5298,10 +5367,10 @@ For example the program might take this on STDIN .nf \f[C] { -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword" + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq] } -\f[] +\f[R] .fi .PP And return this on STDOUT @@ -5309,83 +5378,83 @@ And return this on STDOUT .nf \f[C] { -\ \ \ \ "type":\ "sftp", -\ \ \ \ "_root":\ "", -\ \ \ \ "_obscure":\ "pass", -\ \ \ \ "user":\ "me", -\ \ \ \ "pass":\ "mypassword", -\ \ \ \ "host":\ "sftp.example.com" + \[dq]type\[dq]: \[dq]sftp\[dq], + \[dq]_root\[dq]: \[dq]\[dq], + \[dq]_obscure\[dq]: \[dq]pass\[dq], + \[dq]user\[dq]: \[dq]me\[dq], + \[dq]pass\[dq]: \[dq]mypassword\[dq], + \[dq]host\[dq]: \[dq]sftp.example.com\[dq] } -\f[] +\f[R] .fi .PP This would mean that an SFTP backend would be created on the fly for the -\f[C]user\f[] and \f[C]pass\f[] returned in the output to the host +\f[C]user\f[R] and \f[C]pass\f[R] returned in the output to the host given. -Note that since \f[C]_obscure\f[] is set to \f[C]pass\f[], rclone will -obscure the \f[C]pass\f[] parameter before creating the backend (which +Note that since \f[C]_obscure\f[R] is set to \f[C]pass\f[R], rclone will +obscure the \f[C]pass\f[R] parameter before creating the backend (which is required for sftp backends). .PP -The progam can manipulate the supplied \f[C]user\f[] in any way, for +The progam can manipulate the supplied \f[C]user\f[R] in any way, for example to make proxy to many different sftp backends, you could make -the \f[C]user\f[] be \f[C]user\@example.com\f[] and then set the -\f[C]host\f[] to \f[C]example.com\f[] in the output and the user to -\f[C]user\f[]. -For security you'd probably want to restrict the \f[C]host\f[] to a +the \f[C]user\f[R] be \f[C]user\[at]example.com\f[R] and then set the +\f[C]host\f[R] to \f[C]example.com\f[R] in the output and the user to +\f[C]user\f[R]. +For security you\[cq]d probably want to restrict the \f[C]host\f[R] to a limited list. .PP -Note that an internal cache is keyed on \f[C]user\f[] so only use that -for configuration, don't use \f[C]pass\f[]. -This also means that if a user's password is changed the cache will need -to expire (which takes 5 mins) before it takes effect. +Note that an internal cache is keyed on \f[C]user\f[R] so only use that +for configuration, don\[cq]t use \f[C]pass\f[R]. +This also means that if a user\[cq]s password is changed the cache will +need to expire (which takes 5 mins) before it takes effect. .PP This can be used to build general purpose proxies to any kind of backend that rclone supports. .IP .nf \f[C] -rclone\ serve\ webdav\ remote:path\ [flags] -\f[] +rclone serve webdav remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \ \ \ \ \-\-addr\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ IPaddress:Port\ or\ :Port\ to\ bind\ server\ to.\ (default\ "localhost:8080") -\ \ \ \ \ \ \-\-auth\-proxy\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ A\ program\ to\ use\ to\ create\ the\ backend\ from\ the\ auth. -\ \ \ \ \ \ \-\-baseurl\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Prefix\ for\ URLs\ \-\ leave\ blank\ for\ root. -\ \ \ \ \ \ \-\-cert\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ key\ (concatenation\ of\ certificate\ and\ CA\ certificate) -\ \ \ \ \ \ \-\-client\-ca\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Client\ certificate\ authority\ to\ verify\ clients\ with -\ \ \ \ \ \ \-\-dir\-cache\-time\ duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Time\ to\ cache\ directory\ entries\ for.\ (default\ 5m0s) -\ \ \ \ \ \ \-\-dir\-perms\ FileMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ permissions\ (default\ 0777) -\ \ \ \ \ \ \-\-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) -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ webdav -\ \ \ \ \ \ \-\-htpasswd\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ htpasswd\ file\ \-\ if\ not\ provided\ no\ authentication\ is\ done -\ \ \ \ \ \ \-\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SSL\ PEM\ Private\ key -\ \ \ \ \ \ \-\-max\-header\-bytes\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Maximum\ size\ of\ request\ header\ (default\ 4096) -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-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. -\ \ \ \ \ \ \-\-realm\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ realm\ for\ authentication\ (default\ "rclone") -\ \ \ \ \ \ \-\-server\-read\-timeout\ duration\ \ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ reading\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-server\-write\-timeout\ duration\ \ \ \ \ \ \ \ \ \ Timeout\ for\ server\ writing\ data\ (default\ 1h0m0s) -\ \ \ \ \ \ \-\-uid\ uint32\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ uid\ field\ set\ by\ the\ filesystem.\ (default\ 1000) -\ \ \ \ \ \ \-\-umask\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ the\ permission\ bits\ set\ by\ the\ filesystem.\ (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) -\ \ \ \ \ \ \-\-vfs\-cache\-mode\ CacheMode\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ mode\ off|minimal|writes|full\ (default\ off) -\ \ \ \ \ \ \-\-vfs\-cache\-poll\-interval\ duration\ \ \ \ \ \ \ Interval\ to\ poll\ the\ cache\ for\ stale\ objects.\ (default\ 1m0s) -\ \ \ \ \ \ \-\-vfs\-case\-insensitive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ a\ file\ name\ not\ found,\ find\ a\ case\ insensitive\ match. -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ Read\ the\ source\ objects\ in\ chunks.\ (default\ 128M) -\ \ \ \ \ \ \-\-vfs\-read\-chunk\-size\-limit\ SizeSuffix\ \ \ If\ greater\ than\ \-\-vfs\-read\-chunk\-size,\ double\ the\ chunk\ size\ after\ each\ chunk\ read,\ until\ the\ limit\ is\ reached.\ \[aq]off\[aq]\ is\ unlimited.\ (default\ off) -\f[] + \-\-addr string IPaddress:Port or :Port to bind server to. (default \[dq]localhost:8080\[dq]) + \-\-auth\-proxy string A program to use to create the backend from the auth. + \-\-baseurl string Prefix for URLs \- leave blank for root. + \-\-cert string SSL PEM key (concatenation of certificate and CA certificate) + \-\-client\-ca string Client certificate authority to verify clients with + \-\-dir\-cache\-time duration Time to cache directory entries for. (default 5m0s) + \-\-dir\-perms FileMode Directory permissions (default 0777) + \-\-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) + \-h, \-\-help help for webdav + \-\-htpasswd string htpasswd file \- if not provided no authentication is done + \-\-key string SSL PEM Private key + \-\-max\-header\-bytes int Maximum size of request header (default 4096) + \-\-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. + \-\-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. + \-\-realm string realm for authentication (default \[dq]rclone\[dq]) + \-\-server\-read\-timeout duration Timeout for server reading data (default 1h0m0s) + \-\-server\-write\-timeout duration Timeout for server writing data (default 1h0m0s) + \-\-uid uint32 Override the uid field set by the filesystem. (default 1000) + \-\-umask int Override the permission bits set by the filesystem. (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) + \-\-vfs\-cache\-mode CacheMode Cache mode off|minimal|writes|full (default off) + \-\-vfs\-cache\-poll\-interval duration Interval to poll the cache for stale objects. (default 1m0s) + \-\-vfs\-case\-insensitive If a file name not found, find a case insensitive match. + \-\-vfs\-read\-chunk\-size SizeSuffix Read the source objects in chunks. (default 128M) + \-\-vfs\-read\-chunk\-size\-limit SizeSuffix If greater than \-\-vfs\-read\-chunk\-size, double the chunk size after each chunk read, until the limit is reached. \[aq]off\[aq] is unlimited. (default off) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -5415,16 +5484,16 @@ You can use it to tier single object .IP .nf \f[C] -rclone\ settier\ Cool\ remote:path/file -\f[] +rclone settier Cool remote:path/file +\f[R] .fi .PP Or use rclone filters to set tier on only specific files .IP .nf \f[C] -rclone\ \-\-include\ "*.txt"\ settier\ Hot\ remote:path/dir -\f[] +rclone \-\-include \[dq]*.txt\[dq] settier Hot remote:path/dir +\f[R] .fi .PP Or just provide remote directory and all files in directory will be @@ -5432,21 +5501,21 @@ tiered .IP .nf \f[C] -rclone\ settier\ tier\ remote:path/dir -\f[] +rclone settier tier remote:path/dir +\f[R] .fi .IP .nf \f[C] -rclone\ settier\ tier\ remote:path\ [flags] -\f[] +rclone settier tier remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ help\ for\ settier -\f[] + \-h, \-\-help help for settier +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -5464,17 +5533,17 @@ Create new file or change file modification time. .IP .nf \f[C] -rclone\ touch\ remote:path\ [flags] -\f[] +rclone touch remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ help\ for\ touch -\ \ \-C,\ \-\-no\-create\ \ \ \ \ \ \ \ \ \ Do\ not\ create\ the\ file\ if\ it\ does\ not\ exist. -\ \ \-t,\ \-\-timestamp\ string\ \ \ Change\ the\ modification\ times\ to\ the\ specified\ time\ instead\ of\ the\ current\ time\ of\ day.\ The\ argument\ is\ of\ the\ form\ \[aq]YYMMDD\[aq]\ (ex.\ 17.10.30)\ or\ \[aq]YYYY\-MM\-DDTHH:MM:SS\[aq]\ (ex.\ 2006\-01\-02T15:04:05) -\f[] + \-h, \-\-help help for touch + \-C, \-\-no\-create Do not create the file if it does not exist. + \-t, \-\-timestamp string Change the modification times to the specified time instead of the current time of day. The argument is of the form \[aq]YYMMDD\[aq] (ex. 17.10.30) or \[aq]YYYY\-MM\-DDTHH:MM:SS\[aq] (ex. 2006\-01\-02T15:04:05) +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -5495,17 +5564,17 @@ For example .IP .nf \f[C] -$\ rclone\ tree\ remote:path +$ rclone tree remote:path / -├──\ file1 -├──\ file2 -├──\ file3 -└──\ subdir -\ \ \ \ ├──\ file4 -\ \ \ \ └──\ file5 +\[u251C]\[u2500]\[u2500] file1 +\[u251C]\[u2500]\[u2500] file2 +\[u251C]\[u2500]\[u2500] file3 +\[u2514]\[u2500]\[u2500] subdir + \[u251C]\[u2500]\[u2500] file4 + \[u2514]\[u2500]\[u2500] file5 -1\ directories,\ 5\ files -\f[] +1 directories, 5 files +\f[R] .fi .PP You can use any of the filtering options with the tree command (eg @@ -5515,39 +5584,39 @@ You can also use \[en]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\[cq]s short options. .IP .nf \f[C] -rclone\ tree\ remote:path\ [flags] -\f[] +rclone tree remote:path [flags] +\f[R] .fi .SS Options .IP .nf \f[C] -\ \ \-a,\ \-\-all\ \ \ \ \ \ \ \ \ \ \ \ \ All\ files\ are\ listed\ (list\ .\ files\ too). -\ \ \-C,\ \-\-color\ \ \ \ \ \ \ \ \ \ \ Turn\ colorization\ on\ always. -\ \ \-d,\ \-\-dirs\-only\ \ \ \ \ \ \ List\ directories\ only. -\ \ \ \ \ \ \-\-dirsfirst\ \ \ \ \ \ \ List\ directories\ before\ files\ (\-U\ disables). -\ \ \ \ \ \ \-\-full\-path\ \ \ \ \ \ \ Print\ the\ full\ path\ prefix\ for\ each\ file. -\ \ \-h,\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ help\ for\ tree -\ \ \ \ \ \ \-\-human\ \ \ \ \ \ \ \ \ \ \ Print\ the\ size\ in\ a\ more\ human\ readable\ way. -\ \ \ \ \ \ \-\-level\ int\ \ \ \ \ \ \ Descend\ only\ level\ directories\ deep. -\ \ \-D,\ \-\-modtime\ \ \ \ \ \ \ \ \ Print\ the\ date\ of\ last\ modification. -\ \ \-i,\ \-\-noindent\ \ \ \ \ \ \ \ Don\[aq]t\ print\ indentation\ lines. -\ \ \ \ \ \ \-\-noreport\ \ \ \ \ \ \ \ Turn\ off\ file/directory\ count\ at\ end\ of\ tree\ listing. -\ \ \-o,\ \-\-output\ string\ \ \ Output\ to\ file\ instead\ of\ stdout. -\ \ \-p,\ \-\-protections\ \ \ \ \ Print\ the\ protections\ for\ each\ file. -\ \ \-Q,\ \-\-quote\ \ \ \ \ \ \ \ \ \ \ Quote\ filenames\ with\ double\ quotes. -\ \ \-s,\ \-\-size\ \ \ \ \ \ \ \ \ \ \ \ Print\ the\ size\ in\ bytes\ of\ each\ file. -\ \ \ \ \ \ \-\-sort\ string\ \ \ \ \ Select\ sort:\ name,version,size,mtime,ctime. -\ \ \ \ \ \ \-\-sort\-ctime\ \ \ \ \ \ Sort\ files\ by\ last\ status\ change\ time. -\ \ \-t,\ \-\-sort\-modtime\ \ \ \ Sort\ files\ by\ last\ modification\ time. -\ \ \-r,\ \-\-sort\-reverse\ \ \ \ Reverse\ the\ order\ of\ the\ sort. -\ \ \-U,\ \-\-unsorted\ \ \ \ \ \ \ \ Leave\ files\ unsorted. -\ \ \ \ \ \ \-\-version\ \ \ \ \ \ \ \ \ Sort\ files\ alphanumerically\ by\ version. -\f[] + \-a, \-\-all All files are listed (list . files too). + \-C, \-\-color Turn colorization on always. + \-d, \-\-dirs\-only List directories only. + \-\-dirsfirst List directories before files (\-U disables). + \-\-full\-path Print the full path prefix for each file. + \-h, \-\-help help for tree + \-\-human Print the size in a more human readable way. + \-\-level int Descend only level directories deep. + \-D, \-\-modtime Print the date of last modification. + \-i, \-\-noindent Don\[aq]t print indentation lines. + \-\-noreport Turn off file/directory count at end of tree listing. + \-o, \-\-output string Output to file instead of stdout. + \-p, \-\-protections Print the protections for each file. + \-Q, \-\-quote Quote filenames with double quotes. + \-s, \-\-size Print the size in bytes of each file. + \-\-sort string Select sort: name,version,size,mtime,ctime. + \-\-sort\-ctime Sort files by last status change time. + \-t, \-\-sort\-modtime Sort files by last modification time. + \-r, \-\-sort\-reverse Reverse the order of the sort. + \-U, \-\-unsorted Leave files unsorted. + \-\-version Sort files alphanumerically by version. +\f[R] .fi .PP See the global flags page (https://rclone.org/flags/) for global options @@ -5563,39 +5632,40 @@ However, if the source remote points to a file, rclone will just copy that file. The destination remote must point to a directory \- rclone will give the error -\f[C]Failed\ to\ create\ file\ system\ for\ "remote:file":\ is\ a\ file\ not\ a\ directory\f[] -if it isn't. +\f[C]Failed to create file system for \[dq]remote:file\[dq]: is a file not a directory\f[R] +if it isn\[cq]t. .PP For example, suppose you have a remote with a file in called -\f[C]test.jpg\f[], then you could copy just that file like this +\f[C]test.jpg\f[R], then you could copy just that file like this .IP .nf \f[C] -rclone\ copy\ remote:test.jpg\ /tmp/download -\f[] +rclone copy remote:test.jpg /tmp/download +\f[R] .fi .PP -The file \f[C]test.jpg\f[] will be placed inside \f[C]/tmp/download\f[]. +The file \f[C]test.jpg\f[R] will be placed inside +\f[C]/tmp/download\f[R]. .PP This is equivalent to specifying .IP .nf \f[C] -rclone\ copy\ \-\-files\-from\ /tmp/files\ remote:\ /tmp/download -\f[] +rclone copy \-\-files\-from /tmp/files remote: /tmp/download +\f[R] .fi .PP -Where \f[C]/tmp/files\f[] contains the single line +Where \f[C]/tmp/files\f[R] contains the single line .IP .nf \f[C] test.jpg -\f[] +\f[R] .fi .PP -It is recommended to use \f[C]copy\f[] when copying individual files, -not \f[C]sync\f[]. -They have pretty much the same effect but \f[C]copy\f[] will use a lot +It is recommended to use \f[C]copy\f[R] when copying individual files, +not \f[C]sync\f[R]. +They have pretty much the same effect but \f[C]copy\f[R] will use a lot less memory. .SS Syntax of remote paths .PP @@ -5604,29 +5674,29 @@ The syntax of the paths passed to the rclone command are as follows. .PP This refers to the local file system. .PP -On Windows only \f[C]\\\f[] may be used instead of \f[C]/\f[] in local -paths \f[B]only\f[], non local paths must use \f[C]/\f[]. +On Windows only \f[C]\[rs]\f[R] may be used instead of \f[C]/\f[R] in +local paths \f[B]only\f[R], non local paths must use \f[C]/\f[R]. .PP -These paths needn't start with a leading \f[C]/\f[] \- if they don't -then they will be relative to the current directory. +These paths needn\[cq]t start with a leading \f[C]/\f[R] \- if they +don\[cq]t then they will be relative to the current directory. .SS remote:path/to/dir .PP -This refers to a directory \f[C]path/to/dir\f[] on \f[C]remote:\f[] as -defined in the config file (configured with \f[C]rclone\ config\f[]). +This refers to a directory \f[C]path/to/dir\f[R] on \f[C]remote:\f[R] as +defined in the config file (configured with \f[C]rclone config\f[R]). .SS remote:/path/to/dir .PP On most backends this is refers to the same directory as -\f[C]remote:path/to/dir\f[] and that format should be preferred. +\f[C]remote:path/to/dir\f[R] and that format should be preferred. On a very small number of remotes (FTP, SFTP, Dropbox for business) this will refer to a different directory. -On these, paths without a leading \f[C]/\f[] will refer to your -\[lq]home\[rq] directory and paths with a leading \f[C]/\f[] will refer +On these, paths without a leading \f[C]/\f[R] will refer to your +\[lq]home\[rq] directory and paths with a leading \f[C]/\f[R] will refer to the root. .SS :backend:path/to/dir .PP This is an advanced form for creating remotes on the fly. -\f[C]backend\f[] should be the name or prefix of a backend (the -\f[C]type\f[] in the config file) and all the configuration for the +\f[C]backend\f[R] should be the name or prefix of a backend (the +\f[C]type\f[R] in the config file) and all the configuration for the backend should be provided on the command line (or in environment variables). .PP @@ -5634,39 +5704,39 @@ Here are some examples: .IP .nf \f[C] -rclone\ lsd\ \-\-http\-url\ https://pub.rclone.org\ :http: -\f[] +rclone lsd \-\-http\-url https://pub.rclone.org :http: +\f[R] .fi .PP To list all the directories in the root of -\f[C]https://pub.rclone.org/\f[]. +\f[C]https://pub.rclone.org/\f[R]. .IP .nf \f[C] -rclone\ lsf\ \-\-http\-url\ https://example.com\ :http:path/to/dir -\f[] +rclone lsf \-\-http\-url https://example.com :http:path/to/dir +\f[R] .fi .PP To list files and directories in -\f[C]https://example.com/path/to/dir/\f[] +\f[C]https://example.com/path/to/dir/\f[R] .IP .nf \f[C] -rclone\ copy\ \-\-http\-url\ https://example.com\ :http:path/to/dir\ /tmp/dir -\f[] +rclone copy \-\-http\-url https://example.com :http:path/to/dir /tmp/dir +\f[R] .fi .PP To copy files and directories in -\f[C]https://example.com/path/to/dir\f[] to \f[C]/tmp/dir\f[]. +\f[C]https://example.com/path/to/dir\f[R] to \f[C]/tmp/dir\f[R]. .IP .nf \f[C] -rclone\ copy\ \-\-sftp\-host\ example.com\ :sftp:path/to/dir\ /tmp/dir -\f[] +rclone copy \-\-sftp\-host example.com :sftp:path/to/dir /tmp/dir +\f[R] .fi .PP -To copy files and directories from \f[C]example.com\f[] in the relative -directory \f[C]path/to/dir\f[] to \f[C]/tmp/dir\f[] using sftp. +To copy files and directories from \f[C]example.com\f[R] in the relative +directory \f[C]path/to/dir\f[R] to \f[C]/tmp/dir\f[R] using sftp. .SS Quoting and the shell .PP When you are typing commands to your computer you are using something @@ -5677,97 +5747,98 @@ 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[], -\f[C]?\f[], \f[C]$\f[], \f[C]\[aq]\f[], \f[C]"\f[] etc) then you must -quote them. -Use single quotes \f[C]\[aq]\f[] by default. +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. +Use single quotes \f[C]\[aq]\f[R] by default. .IP .nf \f[C] -rclone\ copy\ \[aq]Important\ files?\[aq]\ remote:backup -\f[] +rclone copy \[aq]Important files?\[aq] remote:backup +\f[R] .fi .PP -If you want to send a \f[C]\[aq]\f[] you will need to use \f[C]"\f[], eg +If you want to send a \f[C]\[aq]\f[R] you will need to use +\f[C]\[dq]\f[R], eg .IP .nf \f[C] -rclone\ copy\ "O\[aq]Reilly\ Reviews"\ remote:backup -\f[] +rclone copy \[dq]O\[aq]Reilly Reviews\[dq] remote:backup +\f[R] .fi .PP 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. +full details you\[cq]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]"\f[], eg +If your names have spaces in you need to put them in \f[C]\[dq]\f[R], eg .IP .nf \f[C] -rclone\ copy\ "E:\\folder\ name\\folder\ name\\folder\ name"\ remote:backup -\f[] +rclone copy \[dq]E:\[rs]folder name\[rs]folder name\[rs]folder name\[dq] remote:backup +\f[R] .fi .PP -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 +If you are using the root directory on its own then don\[cq]t quote it +(see #464 (https://github.com/rclone/rclone/issues/464) for why), eg .IP .nf \f[C] -rclone\ copy\ E:\\\ remote:backup -\f[] +rclone copy E:\[rs] remote:backup +\f[R] .fi -.SS Copying files or directories with \f[C]:\f[] in the names +.SS Copying files or directories with \f[C]:\f[R] in the names .PP -rclone uses \f[C]:\f[] to mark a remote name. +rclone uses \f[C]:\f[R] 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 \f[C]:\f[] up to the first -\f[C]/\f[] so if you need to act on a file or directory like this then -use the full path starting with a \f[C]/\f[], or use \f[C]\&./\f[] as a -current directory prefix. +The remote name parser will only search for a \f[C]:\f[R] up to the +first \f[C]/\f[R] so if you need to act on a file or directory like this +then use the full path starting with a \f[C]/\f[R], or use \f[C]./\f[R] +as a current directory prefix. .PP -So to sync a directory called \f[C]sync:me\f[] to a remote called -\f[C]remote:\f[] use +So to sync a directory called \f[C]sync:me\f[R] to a remote called +\f[C]remote:\f[R] use .IP .nf \f[C] -rclone\ sync\ ./sync:me\ remote:path -\f[] +rclone sync ./sync:me remote:path +\f[R] .fi .PP or .IP .nf \f[C] -rclone\ sync\ /full/path/to/sync:me\ remote:path -\f[] +rclone sync /full/path/to/sync:me remote:path +\f[R] .fi .SS Server Side Copy .PP Most remotes (but not all \- see the overview (/overview/#optional-features)) support server side copy. .PP -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. +This means if you want to copy one folder to another then rclone +won\[cq]t download all the files and re\-upload them; it will instruct +the server to copy them in place. .PP Eg .IP .nf \f[C] -rclone\ copy\ s3:oldbucket\ s3:newbucket -\f[] +rclone copy s3:oldbucket s3:newbucket +\f[R] .fi .PP -Will copy the contents of \f[C]oldbucket\f[] to \f[C]newbucket\f[] +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't support server side copy \f[B]will\f[] download and -re\-upload in this case. +Remotes which don\[cq]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[] and \f[C]copy\f[] and -will be identified in the log when using the \f[C]\-v\f[] flag. -The \f[C]move\f[] command may also use them if remote doesn't support -server side move directly. +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\[cq]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. .PP @@ -5778,45 +5849,45 @@ This can be used when scripting to make aged backups efficiently, eg .IP .nf \f[C] -rclone\ sync\ remote:current\-backup\ remote:previous\-backup -rclone\ sync\ /path/to/files\ remote:current\-backup -\f[] +rclone sync remote:current\-backup remote:previous\-backup +rclone sync /path/to/files remote:current\-backup +\f[R] .fi .SS Options .PP Rclone has a number of options to control its behaviour. .PP Options that take parameters can have the values passed in two ways, -\f[C]\-\-option=value\f[] or \f[C]\-\-option\ value\f[]. +\f[C]\-\-option=value\f[R] or \f[C]\-\-option value\f[R]. However boolean (true/false) options behave slightly differently to the -other options in that \f[C]\-\-boolean\f[] sets the option to -\f[C]true\f[] and the absence of the flag sets it to \f[C]false\f[]. -It is also possible to specify \f[C]\-\-boolean=false\f[] or -\f[C]\-\-boolean=true\f[]. -Note that \f[C]\-\-boolean\ false\f[] is not valid \- this is parsed as -\f[C]\-\-boolean\f[] and the \f[C]false\f[] is parsed as an extra +other options in that \f[C]\-\-boolean\f[R] sets the option to +\f[C]true\f[R] and the absence of the flag sets it to \f[C]false\f[R]. +It is also possible to specify \f[C]\-\-boolean=false\f[R] or +\f[C]\-\-boolean=true\f[R]. +Note that \f[C]\-\-boolean false\f[R] is not valid \- this is parsed as +\f[C]\-\-boolean\f[R] and the \f[C]false\f[R] is parsed as an extra command line argument for rclone. .PP 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 \[lq]300ms\[rq], \[lq]\-1.5h\[rq] or \[lq]2h45m\[rq]. -Valid time units are \[lq]ns\[rq], \[lq]us\[rq] (or \[lq]µs\[rq]), +Valid time units are \[lq]ns\[rq], \[lq]us\[rq] (or \[lq]\[mc]s\[rq]), \[lq]ms\[rq], \[lq]s\[rq], \[lq]m\[rq], \[lq]h\[rq]. .PP Options which use SIZE use kByte by default. -However, a suffix of \f[C]b\f[] for bytes, \f[C]k\f[] for kBytes, -\f[C]M\f[] for MBytes, \f[C]G\f[] for GBytes, \f[C]T\f[] for TBytes and -\f[C]P\f[] for PBytes may be used. +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. .SS \[en]backup\-dir=DIR .PP -When using \f[C]sync\f[], \f[C]copy\f[] or \f[C]move\f[] any files which -would have been overwritten or deleted are moved in their original +When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] any files +which would have been overwritten or deleted are moved in their original hierarchy into this directory. .PP -If \f[C]\-\-suffix\f[] is set, then the moved files will have the suffix -added to them. +If \f[C]\-\-suffix\f[R] 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. .PP @@ -5828,26 +5899,27 @@ For example .IP .nf \f[C] -rclone\ sync\ /path/to/local\ remote:current\ \-\-backup\-dir\ remote:old -\f[] +rclone sync /path/to/local remote:current \-\-backup\-dir remote:old +\f[R] .fi .PP -will sync \f[C]/path/to/local\f[] to \f[C]remote:current\f[], but for +will sync \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 will be stored in -\f[C]remote:old\f[]. +\f[C]remote:old\f[R]. .PP -If running rclone from a script you might want to use today's date as -the directory name passed to \f[C]\-\-backup\-dir\f[] to store the old -files, or you might want to pass \f[C]\-\-suffix\f[] with today's date. +If running rclone from a script you might want to use today\[cq]s date +as the directory name passed to \f[C]\-\-backup\-dir\f[R] to store the +old files, or you might want to pass \f[C]\-\-suffix\f[R] with +today\[cq]s date. .PP -See \f[C]\-\-compare\-dest\f[] and \f[C]\-\-copy\-dest\f[]. +See \f[C]\-\-compare\-dest\f[R] and \f[C]\-\-copy\-dest\f[R]. .SS \[en]bind string .PP 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. +If the host name doesn\[cq]t resolve or resolves to more than one IP +address it will give an error. .SS \[en]bwlimit=BANDWIDTH_SPEC .PP This option controls the bandwidth limit. @@ -5857,10 +5929,10 @@ 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 \f[C]0\f[] which means to not limit bandwidth. +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[] +\f[C]\-\-bwlimit 10M\f[R] .PP It is also possible to specify a \[lq]timetable\[rq] of limits, which will cause certain limits to be applied at certain times. @@ -5873,7 +5945,7 @@ 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: .PP -\f[C]\-\-bwlimit\ "08:00,512\ 12:00,10M\ 13:00,512\ 18:00,30M\ 23:00,off"\f[] +\f[C]\-\-bwlimit \[dq]08:00,512 12:00,10M 13:00,512 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. @@ -5885,7 +5957,7 @@ Anything between 11pm and 8am will remain unlimited. .PP An example of timetable with WEEKDAY could be: .PP -\f[C]\-\-bwlimit\ "Mon\-00:00,512\ Fri\-23:59,10M\ Sat\-10:00,1M\ Sun\-20:00,off"\f[] +\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 Monday. @@ -5896,34 +5968,34 @@ From 20:00 at Sunday will be unlimited. Timeslots without weekday are extended to whole week. So this one example: .PP -\f[C]\-\-bwlimit\ "Mon\-00:00,512\ 12:00,1M\ Sun\-20:00,off"\f[] +\f[C]\-\-bwlimit \[dq]Mon\-00:00,512 12:00,1M Sun\-20:00,off\[dq]\f[R] .PP Is equal to this: .PP -\f[C]\-\-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"\f[] +\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't apply to the bandwidth of the directory listings etc. +They don\[cq]t apply to the bandwidth of the directory listings etc. .PP 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 +For example, let\[cq]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 -\f[C]\-\-bwlimit\ 0.625M\f[] parameter for rclone. +\f[C]\-\-bwlimit 0.625M\f[R] parameter for rclone. .PP On Unix systems (Linux, MacOS, \&...) the bandwidth limiter can be -toggled by sending a \f[C]SIGUSR2\f[] signal to rclone. +toggled by sending a \f[C]SIGUSR2\f[R] 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 \f[C]\-\-bwlimit\f[] +and to restore it back to the value specified with \f[C]\-\-bwlimit\f[R] quickly when needed. Assuming there is only one rclone instance running, you can toggle the limiter like this: .IP .nf \f[C] -kill\ \-SIGUSR2\ $(pidof\ rclone) -\f[] +kill \-SIGUSR2 $(pidof rclone) +\f[R] .fi .PP If you configure rclone with a remote control (/rc) then you can use @@ -5931,15 +6003,15 @@ change the bwlimit dynamically: .IP .nf \f[C] -rclone\ rc\ core/bwlimit\ rate=1M -\f[] +rclone rc core/bwlimit rate=1M +\f[R] .fi .SS \[en]buffer\-size=SIZE .PP Use this sized buffer to speed up file transfers. -Each \f[C]\-\-transfer\f[] will use this much memory for buffering. +Each \f[C]\-\-transfer\f[R] will use this much memory for buffering. .PP -When using \f[C]mount\f[] or \f[C]cmount\f[] each open file descriptor +When using \f[C]mount\f[R] or \f[C]cmount\f[R] each open file descriptor will use this much memory for buffering. See the mount (/commands/rclone_mount/#file-buffering) documentation for more details. @@ -5963,23 +6035,23 @@ if they are equal. If you set this flag then rclone will check the file hash and size to determine if files are equal. .PP -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 useful when the remote doesn\[cq]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. For details of which remotes support which hash type see the table in the overview section (https://rclone.org/overview/). .PP -Eg \f[C]rclone\ \-\-checksum\ sync\ s3:/bucket\ swift:/bucket\f[] would -run much quicker than without the \f[C]\-\-checksum\f[] flag. +Eg \f[C]rclone \-\-checksum sync s3:/bucket swift:/bucket\f[R] would run +much quicker than without the \f[C]\-\-checksum\f[R] flag. .PP -When using this flag, rclone won't update mtimes of remote files if they -are incorrect as it would normally. +When using this flag, rclone won\[cq]t update mtimes of remote files if +they are incorrect as it would normally. .SS \[en]compare\-dest=DIR .PP -When using \f[C]sync\f[], \f[C]copy\f[] or \f[C]move\f[] DIR is checked -in addition to the destination for files. +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 NOT copied from source. This is useful to copy just files that have changed since the last @@ -5988,40 +6060,40 @@ backup. You must use the same remote as the destination of the sync. The compare directory must not overlap the destination directory. .PP -See \f[C]\-\-copy\-dest\f[] and \f[C]\-\-backup\-dir\f[]. +See \f[C]\-\-copy\-dest\f[R] and \f[C]\-\-backup\-dir\f[R]. .SS \[en]config=CONFIG_FILE .PP Specify the location of the rclone config file. .PP Normally the config file is in your home directory as a file called -\f[C]\&.config/rclone/rclone.conf\f[] (or \f[C]\&.rclone.conf\f[] if +\f[C].config/rclone/rclone.conf\f[R] (or \f[C].rclone.conf\f[R] if created with an older version). -If \f[C]$XDG_CONFIG_HOME\f[] is set it will be at -\f[C]$XDG_CONFIG_HOME/rclone/rclone.conf\f[]. +If \f[C]$XDG_CONFIG_HOME\f[R] is set it will be at +\f[C]$XDG_CONFIG_HOME/rclone/rclone.conf\f[R]. .PP -If there is a file \f[C]rclone.conf\f[] in the same directory as the +If there is a file \f[C]rclone.conf\f[R] 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. .PP -If you run \f[C]rclone\ config\ file\f[] you will see where the default +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 -\f[C]rclone\ \-\-config=".myconfig"\ .config\f[]. +\f[C]rclone \-\-config=\[dq].myconfig\[dq] .config\f[R]. .SS \[en]contimeout=TIME .PP Set the connection timeout. -This should be in go time format which looks like \f[C]5s\f[] for 5 -seconds, \f[C]10m\f[] for 10 minutes, or \f[C]3h30m\f[]. +This should be in go time format which looks like \f[C]5s\f[R] for 5 +seconds, \f[C]10m\f[R] for 10 minutes, or \f[C]3h30m\f[R]. .PP 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 \f[C]1m\f[] by default. +It is \f[C]1m\f[R] by default. .SS \[en]copy\-dest=DIR .PP -When using \f[C]sync\f[], \f[C]copy\f[] or \f[C]move\f[] DIR is checked -in addition to the destination for files. +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 copied from DIR to the destination. This is useful for incremental backup. @@ -6030,13 +6102,13 @@ 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 -See \f[C]\-\-compare\-dest\f[] and \f[C]\-\-backup\-dir\f[]. +See \f[C]\-\-compare\-dest\f[R] and \f[C]\-\-backup\-dir\f[R]. .SS \[en]dedupe\-mode MODE .PP Mode to run dedupe command in. -One of \f[C]interactive\f[], \f[C]skip\f[], \f[C]first\f[], -\f[C]newest\f[], \f[C]oldest\f[], \f[C]rename\f[]. -The default is \f[C]interactive\f[]. +One of \f[C]interactive\f[R], \f[C]skip\f[R], \f[C]first\f[R], +\f[C]newest\f[R], \f[C]oldest\f[R], \f[C]rename\f[R]. +The default is \f[C]interactive\f[R]. See the dedupe command for more information as to what these options mean. .SS \[en]disable FEATURE,FEATURE,\&... @@ -6046,8 +6118,8 @@ For example to disable server side move and server side copy use: .IP .nf \f[C] -\-\-disable\ move,copy -\f[] +\-\-disable move,copy +\f[R] .fi .PP The features can be put in in any case. @@ -6056,8 +6128,8 @@ To see a list of which features can be disabled use: .IP .nf \f[C] -\-\-disable\ help -\f[] +\-\-disable help +\f[R] .fi .PP See the overview features (/overview/#features) and optional @@ -6071,8 +6143,21 @@ This flag can be useful for debugging and in exceptional circumstances .PP 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 \f[C]sync\f[] command which deletes files in +Useful when setting up the \f[C]sync\f[R] command which deletes files in the destination. +.SS \[en]expect\-continue\-timeout=TIME +.PP +This specifies the amount of time to wait for a server\[cq]s first +response headers after fully writing the request headers if the request +has an \[lq]Expect: 100\-continue\[rq] header. +Not all backends support using this. +.PP +Zero means no timeout and causes the body to be sent immediately, +without waiting for the server to approve. +This time does not include the time to send the request header. +.PP +The default is \f[C]1s\f[R]. +Set to 0 to disable. .SS \[en]ignore\-case\-sync .PP Using this option will cause rclone to ignore the case of the files when @@ -6081,7 +6166,8 @@ filenames are the same, even if the casing is different. .SS \[en]ignore\-checksum .PP Normally rclone will check that the checksums of transferred files -match, and give an error \[lq]corrupted on transfer\[rq] if they don't. +match, and give an error \[lq]corrupted on transfer\[rq] if they +don\[cq]t. .PP You can use this option to skip that check. You should only use it if you have had the \[lq]corrupted on @@ -6092,7 +6178,7 @@ potentially corrupted data. Using this option will make rclone unconditionally skip all files that exist on the destination, no matter the content of these files. .PP -While this isn't a generally recommended option, it can be useful in +While this isn\[cq]t a generally recommended option, it can be useful in cases where your files change due to encryption. However, it cannot correct partial transfers in case a transfer was interrupted. @@ -6101,7 +6187,7 @@ interrupted. 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 only the modification time. -If \f[C]\-\-checksum\f[] is set then it only checks the checksum. +If \f[C]\-\-checksum\f[R] is set then it only checks the checksum. .PP It will also cause rclone to skip verifying the sizes are the same after transfer. @@ -6116,7 +6202,7 @@ regardless of the state of files on the destination. .PP Normally rclone would skip any files that have the same modification time and are the same size (or have the same checksum if using -\f[C]\-\-checksum\f[]). +\f[C]\-\-checksum\f[R]). .SS \[en]immutable .PP Treat source and destination files as immutable and disallow @@ -6126,15 +6212,14 @@ With this option set, files will be created and deleted as requested, but existing files will never be updated. If an existing file does not match between the source and destination, rclone will give the error -\f[C]Source\ and\ destination\ exist\ but\ do\ not\ match:\ immutable\ file\ modified\f[]. +\f[C]Source and destination exist but do not match: immutable file modified\f[R]. .PP -Note that only commands which transfer files (e.g. -\f[C]sync\f[], \f[C]copy\f[], \f[C]move\f[]) are affected by this -behavior, and only modification is disallowed. -Files may still be deleted explicitly (e.g. -\f[C]delete\f[], \f[C]purge\f[]) or implicitly (e.g. -\f[C]sync\f[], \f[C]move\f[]). -Use \f[C]copy\ \-\-immutable\f[] if it is desired to avoid deletion as +Note that only commands which transfer files (e.g.\ \f[C]sync\f[R], +\f[C]copy\f[R], \f[C]move\f[R]) are affected by this behavior, and only +modification is disallowed. +Files may still be deleted explicitly (e.g.\ \f[C]delete\f[R], +\f[C]purge\f[R]) or implicitly (e.g.\ \f[C]sync\f[R], \f[C]move\f[R]). +Use \f[C]copy \-\-immutable\f[R] if it is desired to avoid deletion as well as modification. .PP This can be useful as an additional layer of protection for immutable or @@ -6142,43 +6227,43 @@ append\-only data sets (notably backup archives), where modification implies corruption and should not be propagated. .SS \[en]leave\-root .PP -During rmdirs it will not remove root directory, even if it's empty. +During rmdirs it will not remove root directory, even if it\[cq]s empty. .SS \[en]log\-file=FILE .PP -Log all of rclone's output to FILE. +Log all of rclone\[cq]s output to FILE. This is not active by default. This can be useful for tracking down problems with syncs in combination -with the \f[C]\-v\f[] flag. +with the \f[C]\-v\f[R] flag. See the Logging section for more info. .PP -Note that if you are using the \f[C]logrotate\f[] program to manage -rclone's logs, then you should use the \f[C]copytruncate\f[] option as -rclone doesn't have a signal to rotate logs. +Note that if you are using the \f[C]logrotate\f[R] program to manage +rclone\[cq]s logs, then you should use the \f[C]copytruncate\f[R] option +as rclone doesn\[cq]t have a signal to rotate logs. .SS \[en]log\-format LIST .PP Comma separated list of log format options. -\f[C]date\f[], \f[C]time\f[], \f[C]microseconds\f[], \f[C]longfile\f[], -\f[C]shortfile\f[], \f[C]UTC\f[]. -The default is \[lq]\f[C]date\f[],\f[C]time\f[]\[rq]. +\f[C]date\f[R], \f[C]time\f[R], \f[C]microseconds\f[R], +\f[C]longfile\f[R], \f[C]shortfile\f[R], \f[C]UTC\f[R]. +The default is \[lq]\f[C]date\f[R],\f[C]time\f[R]\[rq]. .SS \[en]log\-level LEVEL .PP This sets the log level for rclone. -The default log level is \f[C]NOTICE\f[]. +The default log level is \f[C]NOTICE\f[R]. .PP -\f[C]DEBUG\f[] is equivalent to \f[C]\-vv\f[]. +\f[C]DEBUG\f[R] is equivalent to \f[C]\-vv\f[R]. It outputs lots of debug info \- useful for bug reports and really finding out what rclone is doing. .PP -\f[C]INFO\f[] is equivalent to \f[C]\-v\f[]. +\f[C]INFO\f[R] is equivalent to \f[C]\-v\f[R]. It outputs information about each transfer and prints stats once a minute by default. .PP -\f[C]NOTICE\f[] is the default log level if no logging flags are +\f[C]NOTICE\f[R] is the default log level if no logging flags are supplied. It outputs very little when things are working normally. It outputs warnings and significant events. .PP -\f[C]ERROR\f[] is equivalent to \f[C]\-q\f[]. +\f[C]ERROR\f[R] is equivalent to \f[C]\-q\f[R]. It only outputs error messages. .SS \[en]use\-json\-log .PP @@ -6191,14 +6276,15 @@ This controls the number of low level retries rclone does. A low level retry is used to retry a failing operation \- typically one HTTP request. This might be uploading a chunk of a big file for example. -You will see low level retries in the log with the \f[C]\-v\f[] flag. +You will see low level retries in the log with the \f[C]\-v\f[R] flag. .PP -This shouldn't need to be changed from the default in normal operations. +This shouldn\[cq]t need to be changed from the default in normal +operations. However, if you get a lot of low level retries you may wish to reduce the value so rclone moves on to a high level retry (see the -\f[C]\-\-retries\f[] flag) quicker. +\f[C]\-\-retries\f[R] flag) quicker. .PP -Disable low level retries with \f[C]\-\-low\-level\-retries\ 1\f[]. +Disable low level retries with \f[C]\-\-low\-level\-retries 1\f[R]. .SS \[en]max\-backlog=N .PP This is the maximum allowable backlog of files in a sync/copy/move @@ -6210,7 +6296,8 @@ Note that it will use in the order of N kB of memory when the backlog is in use. .PP Setting this large allows rclone to calculate how many files are pending -more accurately and give a more accurate estimated finish time. +more accurately, give a more accurate estimated finish time and make +\f[C]\-\-order\-by\f[R] work more accurately. .PP Setting this small will make rclone more synchronous to the listings of the remote which may be desirable. @@ -6223,23 +6310,33 @@ rclone will stop the operation in progress. .PP This modifies the recursion depth for all the commands except purge. .PP -So if you do \f[C]rclone\ \-\-max\-depth\ 1\ ls\ remote:path\f[] you -will see only the files in the top level directory. -Using \f[C]\-\-max\-depth\ 2\f[] means you will see all the files in +So if you do \f[C]rclone \-\-max\-depth 1 ls remote:path\f[R] you will +see only the files in the top level directory. +Using \f[C]\-\-max\-depth 2\f[R] means you will see all the files in first two directory levels and so on. .PP -For historical reasons the \f[C]lsd\f[] command defaults to using a -\f[C]\-\-max\-depth\f[] of 1 \- you can override this with the command +For historical reasons the \f[C]lsd\f[R] command defaults to using a +\f[C]\-\-max\-depth\f[R] of 1 \- you can override this with the command line flag. .PP You can use this command to disable recursion (with -\f[C]\-\-max\-depth\ 1\f[]). +\f[C]\-\-max\-depth 1\f[R]). .PP -Note that if you use this with \f[C]sync\f[] and -\f[C]\-\-delete\-excluded\f[] the files not recursed through are +Note that if you use this with \f[C]sync\f[R] and +\f[C]\-\-delete\-excluded\f[R] the files not recursed through are considered excluded and will be deleted on the destination. -Test first with \f[C]\-\-dry\-run\f[] if you are not sure what will +Test first with \f[C]\-\-dry\-run\f[R] if you are not sure what will happen. +.SS \[en]max\-duration=TIME +.PP +Rclone will stop scheduling new transfers when it has run for the +duration specified. +.PP +Defaults to off. +.PP +When the limit is reached any existing transfers will complete. +.PP +Rclone won\[cq]t exit with an error if the transfer limit is reached. .SS \[en]max\-transfer=SIZE .PP Rclone will stop transferring when it has reached the size specified. @@ -6254,10 +6351,10 @@ When checking whether a file has been modified, this is the maximum allowed time difference that a file can have and still be considered equivalent. .PP -The default is \f[C]1ns\f[] unless this is overridden by a remote. +The default is \f[C]1ns\f[R] unless this is overridden by a remote. For example OS X only stores modification times to the nearest second so if you are reading and writing to an OS X filing system this will be -\f[C]1s\f[] by default. +\f[C]1s\f[R] by default. .PP This command line flag allows you to override that computed default. .SS \[en]multi\-thread\-cutoff=SIZE @@ -6267,45 +6364,45 @@ use multiple threads to download the file. (default 250M) .PP Rclone preallocates the file (using -\f[C]fallocate(FALLOC_FL_KEEP_SIZE)\f[] on unix or -\f[C]NTSetInformationFile\f[] on Windows both of which takes no time) +\f[C]fallocate(FALLOC_FL_KEEP_SIZE)\f[R] on unix or +\f[C]NTSetInformationFile\f[R] on Windows both of which takes no time) then each thread writes directly into the file at the correct place. -This means that rclone won't create fragmented or sparse files and there -won't be any assembly time at the end of the transfer. +This means that rclone won\[cq]t create fragmented or sparse files and +there won\[cq]t be any assembly time at the end of the transfer. .PP The number of threads used to dowload is controlled by -\f[C]\-\-multi\-thread\-streams\f[]. +\f[C]\-\-multi\-thread\-streams\f[R]. .PP -Use \f[C]\-vv\f[] if you wish to see info about the threads. +Use \f[C]\-vv\f[R] if you wish to see info about the threads. .PP -This will work with the \f[C]sync\f[]/\f[C]copy\f[]/\f[C]move\f[] -commands and friends \f[C]copyto\f[]/\f[C]moveto\f[]. -Multi thread downloads will be used with \f[C]rclone\ mount\f[] and -\f[C]rclone\ serve\f[] if \f[C]\-\-vfs\-cache\-mode\f[] is set to -\f[C]writes\f[] or above. +This will work with the \f[C]sync\f[R]/\f[C]copy\f[R]/\f[C]move\f[R] +commands and friends \f[C]copyto\f[R]/\f[C]moveto\f[R]. +Multi thread downloads will be used with \f[C]rclone mount\f[R] and +\f[C]rclone serve\f[R] if \f[C]\-\-vfs\-cache\-mode\f[R] is set to +\f[C]writes\f[R] or above. .PP -\f[B]NB\f[] that this \f[B]only\f[] works for a local destination but +\f[B]NB\f[R] that this \f[B]only\f[R] works for a local destination but will work with any source. .PP -\f[B]NB\f[] that multi thread copies are disabled for local to local +\f[B]NB\f[R] that multi thread copies are disabled for local to local copies as they are faster without unless -\f[C]\-\-multi\-thread\-streams\f[] is set explicitly. +\f[C]\-\-multi\-thread\-streams\f[R] is set explicitly. .SS \[en]multi\-thread\-streams=N .PP When using multi thread downloads (see above -\f[C]\-\-multi\-thread\-cutoff\f[]) this sets the maximum number of +\f[C]\-\-multi\-thread\-cutoff\f[R]) this sets the maximum number of streams to use. -Set to \f[C]0\f[] to disable multi thread downloads. +Set to \f[C]0\f[R] to disable multi thread downloads. (Default 4) .PP Exactly how many streams rclone uses for the download depends on the size of the file. To calculate the number of download streams Rclone divides the size of -the file by the \f[C]\-\-multi\-thread\-cutoff\f[] and rounds up, up to -the maximum set with \f[C]\-\-multi\-thread\-streams\f[]. +the file by the \f[C]\-\-multi\-thread\-cutoff\f[R] and rounds up, up to +the maximum set with \f[C]\-\-multi\-thread\-streams\f[R]. .PP -So if \f[C]\-\-multi\-thread\-cutoff\ 250MB\f[] and -\f[C]\-\-multi\-thread\-streams\ 4\f[] are in effect (the defaults): +So if \f[C]\-\-multi\-thread\-cutoff 250MB\f[R] and +\f[C]\-\-multi\-thread\-streams 4\f[R] are in effect (the defaults): .IP \[bu] 2 0MB.250MB files will be downloaded with 1 stream .IP \[bu] 2 @@ -6314,43 +6411,144 @@ So if \f[C]\-\-multi\-thread\-cutoff\ 250MB\f[] and 500MB..750MB files will be downloaded with 3 streams .IP \[bu] 2 750MB+ files will be downloaded with 4 streams +.SS \[en]no\-check\-dest +.PP +The \f[C]\-\-no\-check\-dest\f[R] can be used with \f[C]move\f[R] or +\f[C]copy\f[R] and it causes rclone not to check the destination at all +when copying files. +.PP +This means that: +.IP \[bu] 2 +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) +.IP \[bu] 2 +\f[C]\-\-retries 1\f[R] is recommended otherwise you\[cq]ll transfer +everything again on a retry +.PP +This flag is useful to minimise the transactions if you know that none +of the files are on the destination. +.PP +This is a specialized flag which should be ignored by most users! .SS \[en]no\-gzip\-encoding .PP -Don't set \f[C]Accept\-Encoding:\ gzip\f[]. -This means that rclone won't ask the server for compressed files +Don\[cq]t set \f[C]Accept\-Encoding: gzip\f[R]. +This means that rclone won\[cq]t ask the server for compressed files automatically. -Useful if you've set the server to return files with -\f[C]Content\-Encoding:\ gzip\f[] but you uploaded compressed files. +Useful if you\[cq]ve set the server to return files with +\f[C]Content\-Encoding: gzip\f[R] but you uploaded compressed files. .PP There is no need to set this in normal operation, and doing so will decrease the network transfer efficiency of rclone. .SS \[en]no\-traverse .PP -The \f[C]\-\-no\-traverse\f[] flag controls whether the destination file -system is traversed when using the \f[C]copy\f[] or \f[C]move\f[] +The \f[C]\-\-no\-traverse\f[R] flag controls whether the destination +file system is traversed when using the \f[C]copy\f[R] or \f[C]move\f[R] commands. -\f[C]\-\-no\-traverse\f[] is not compatible with \f[C]sync\f[] and will -be ignored if you supply it with \f[C]sync\f[]. +\f[C]\-\-no\-traverse\f[R] is not compatible with \f[C]sync\f[R] and +will be ignored if you supply it with \f[C]sync\f[R]. .PP If you are only copying a small number of files (or are filtering most of the files) and/or have a large number of files on the destination -then \f[C]\-\-no\-traverse\f[] will stop rclone listing the destination +then \f[C]\-\-no\-traverse\f[R] will stop rclone listing the destination and save time. .PP However, if you are copying a large number of files, especially if you -are doing a copy where lots of the files under consideration haven't -changed and won't need copying then you shouldn't use -\f[C]\-\-no\-traverse\f[]. +are doing a copy where lots of the files under consideration haven\[cq]t +changed and won\[cq]t need copying then you shouldn\[cq]t use +\f[C]\-\-no\-traverse\f[R]. .PP See rclone copy (https://rclone.org/commands/rclone_copy/) for an example of how to use it. .SS \[en]no\-update\-modtime .PP -When using this flag, rclone won't update modification times of remote -files if they are incorrect as it would normally. +When using this flag, rclone won\[cq]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). +.SS \[en]order\-by string +.PP +The \f[C]\-\-order\-by\f[R] flag controls the order in which files in +the backlog are processed in \f[C]rclone sync\f[R], +\f[C]rclone copy\f[R] and \f[C]rclone move\f[R]. +.PP +The order by string is constructed like this. +The first part describes what aspect is being measured: +.IP \[bu] 2 +\f[C]size\f[R] \- order by the size of the files +.IP \[bu] 2 +\f[C]name\f[R] \- order by the full path of the files +.IP \[bu] 2 +\f[C]modtime\f[R] \- order by the modification date of the files +.PP +This can have a modifier appended with a comma: +.IP \[bu] 2 +\f[C]ascending\f[R] or \f[C]asc\f[R] \- order so that the smallest (or +oldest) is processed first +.IP \[bu] 2 +\f[C]descending\f[R] or \f[C]desc\f[R] \- order so that the largest (or +newest) is processed first +.PP +If no modifier is supplied then the order is \f[C]ascending\f[R]. +.PP +For example +.IP \[bu] 2 +\f[C]\-\-order\-by size,desc\f[R] \- send the largest files first +.IP \[bu] 2 +\f[C]\-\-order\-by modtime,ascending\f[R] \- send the oldest files first +.IP \[bu] 2 +\f[C]\-\-order\-by name\f[R] \- send the files with alphabetically by +path first +.PP +If the \f[C]\-\-order\-by\f[R] flag is not supplied or it is supplied +with an empty string then the default ordering will be used which is as +scanned. +With \f[C]\-\-checkers 1\f[R] this is mostly alphabetical, however with +the default \f[C]\-\-checkers 8\f[R] it is somewhat random. +.SS Limitations +.PP +The \f[C]\-\-order\-by\f[R] flag does not do a separate pass over the +data. +This means that it may transfer some files out of the order specified if +.IP \[bu] 2 +there are no files in the backlog or the source has not been fully +scanned yet +.IP \[bu] 2 +there are more than \[en]max\-backlog files in the backlog +.PP +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. +.SS \[en]password\-command SpaceSepList +.PP +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 \f[C]RCLONE_CONFIG_PASS\f[R] variable. +.PP +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 +\f[C]\[dq]\f[R], if you want a literal \f[C]\[dq]\f[R] in an argument +then enclose the argument in \f[C]\[dq]\f[R] and double the +\f[C]\[dq]\f[R]. +See CSV encoding (https://godoc.org/encoding/csv) for more info. +.PP +Eg +.IP +.nf +\f[C] +\-\-password\-command echo hello +\-\-password\-command echo \[dq]hello with space\[dq] +\-\-password\-command echo \[dq]hello with \[dq]\[dq]quotes\[dq]\[dq] and space\[dq] +\f[R] +.fi +.PP +See the Configuration Encryption for more info. .SS \-P, \[en]progress .PP This flag makes rclone update the stats in a static block in the @@ -6361,15 +6559,15 @@ Log messages will push the static block down to the bottom of the terminal where it will stay. .PP Normally this is updated every 500mS but this period can be overridden -with the \f[C]\-\-stats\f[] flag. +with the \f[C]\-\-stats\f[R] flag. .PP -This can be used with the \f[C]\-\-stats\-one\-line\f[] flag for a +This can be used with the \f[C]\-\-stats\-one\-line\f[R] flag for a simpler display. .PP -Note: On Windows untilthis +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[] when -\f[C]\-\-progress\f[] is in use. +non\-ASCII characters will be replaced with \f[C].\f[R] when +\f[C]\-\-progress\f[R] is in use. .SS \-q, \[en]quiet .PP Normally rclone outputs stats and a completion message. @@ -6379,13 +6577,13 @@ If you set this flag it will make as little output as possible. Retry the entire sync if it fails this many times it fails (default 3). .PP Some remotes can be unreliable and a few retries help pick up the files -which didn't get transferred because of errors. +which didn\[cq]t get transferred because of errors. .PP -Disable retries with \f[C]\-\-retries\ 1\f[]. +Disable retries with \f[C]\-\-retries 1\f[R]. .SS \[en]retries\-sleep=TIME .PP This sets the interval between each retry specified by -\f[C]\-\-retries\f[] +\f[C]\-\-retries\f[R] .PP The default is 0. Use 0 to disable. @@ -6396,26 +6594,26 @@ if they are equal. If you set this flag then rclone will check only the size. .PP This can be useful transferring files from Dropbox which have been -modified by the desktop sync client which doesn't set checksums of +modified by the desktop sync client which doesn\[cq]t set checksums of modification times in the same way as rclone. .SS \[en]stats=TIME .PP -Commands which transfer data (\f[C]sync\f[], \f[C]copy\f[], -\f[C]copyto\f[], \f[C]move\f[], \f[C]moveto\f[]) will print data +Commands which transfer data (\f[C]sync\f[R], \f[C]copy\f[R], +\f[C]copyto\f[R], \f[C]move\f[R], \f[C]moveto\f[R]) will print data transfer stats at regular intervals to show their progress. .PP This sets the interval. .PP -The default is \f[C]1m\f[]. +The default is \f[C]1m\f[R]. Use 0 to disable. .PP If you set the stats interval then all commands can show stats. -This can be useful when running other commands, \f[C]check\f[] or -\f[C]mount\f[] for example. +This can be useful when running other commands, \f[C]check\f[R] or +\f[C]mount\f[R] for example. .PP -Stats are logged at \f[C]INFO\f[] level by default which means they -won't show at default log level \f[C]NOTICE\f[]. -Use \f[C]\-\-stats\-log\-level\ NOTICE\f[] or \f[C]\-v\f[] to make them +Stats are logged at \f[C]INFO\f[R] level by default which means they +won\[cq]t show at default log level \f[C]NOTICE\f[R]. +Use \f[C]\-\-stats\-log\-level NOTICE\f[R] or \f[C]\-v\f[R] to make them show. See the Logging section for more info on log levels. .PP @@ -6423,21 +6621,21 @@ Note that on macOS you can send a SIGINFO (which is normally ctrl\-T in the terminal) to make the stats print immediately. .SS \[en]stats\-file\-name\-length integer .PP -By default, the \f[C]\-\-stats\f[] output will truncate file names and +By default, the \f[C]\-\-stats\f[R] output will truncate file names and paths longer than 40 characters. This is equivalent to providing -\f[C]\-\-stats\-file\-name\-length\ 40\f[]. -Use \f[C]\-\-stats\-file\-name\-length\ 0\f[] to disable any truncation +\f[C]\-\-stats\-file\-name\-length 40\f[R]. +Use \f[C]\-\-stats\-file\-name\-length 0\f[R] to disable any truncation of file names printed by stats. .SS \[en]stats\-log\-level string .PP -Log level to show \f[C]\-\-stats\f[] output at. -This can be \f[C]DEBUG\f[], \f[C]INFO\f[], \f[C]NOTICE\f[], or -\f[C]ERROR\f[]. -The default is \f[C]INFO\f[]. -This means at the default level of logging which is \f[C]NOTICE\f[] the -stats won't show \- if you want them to then use -\f[C]\-\-stats\-log\-level\ NOTICE\f[]. +Log level to show \f[C]\-\-stats\f[R] output at. +This can be \f[C]DEBUG\f[R], \f[C]INFO\f[R], \f[C]NOTICE\f[R], or +\f[C]ERROR\f[R]. +The default is \f[C]INFO\f[R]. +This means at the default level of logging which is \f[C]NOTICE\f[R] the +stats won\[cq]t show \- if you want them to then use +\f[C]\-\-stats\-log\-level NOTICE\f[R]. See the Logging section for more info on log levels. .SS \[en]stats\-one\-line .PP @@ -6447,7 +6645,7 @@ showing the most important stats only. .PP When this is specified, rclone enables the single\-line stats and prepends the display with a date string. -The default is \f[C]2006/01/02\ 15:04:05\ \-\f[] +The default is \f[C]2006/01/02 15:04:05 \-\f[R] .SS \[en]stats\-one\-line\-date\-format .PP When this is specified, rclone enables the single\-line stats and @@ -6466,12 +6664,12 @@ Data transfer volume will still be reported in bytes. The rate is reported as a binary unit, not SI unit. So 1 Mbit/s equals 1,048,576 bits/s and not 1,000,000 bits/s. .PP -The default is \f[C]bytes\f[]. +The default is \f[C]bytes\f[R]. .SS \[en]suffix=SUFFIX .PP -When using \f[C]sync\f[], \f[C]copy\f[] or \f[C]move\f[] any files which -would have been overwritten or deleted will have the suffix added to -them. +When using \f[C]sync\f[R], \f[C]copy\f[R] or \f[C]move\f[R] 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. .PP @@ -6479,86 +6677,86 @@ 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[]. -See \f[C]\-\-backup\-dir\f[] for more info. +with \f[C]\-\-backup\-dir\f[R]. +See \f[C]\-\-backup\-dir\f[R] for more info. .PP For example .IP .nf \f[C] -rclone\ sync\ /path/to/local/file\ remote:current\ \-\-suffix\ .bak -\f[] +rclone sync /path/to/local/file remote:current \-\-suffix .bak +\f[R] .fi .PP -will sync \f[C]/path/to/local\f[] to \f[C]remote:current\f[], but for +will sync \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. .SS \[en]suffix\-keep\-extension .PP -When using \f[C]\-\-suffix\f[], setting this causes rclone put the +When using \f[C]\-\-suffix\f[R], setting this causes rclone put the SUFFIX before the extension of the files that it backs up rather than after. .PP -So let's say we had \f[C]\-\-suffix\ \-2019\-01\-01\f[], without the -flag \f[C]file.txt\f[] would be backed up to -\f[C]file.txt\-2019\-01\-01\f[] and with the flag it would be backed up -to \f[C]file\-2019\-01\-01.txt\f[]. +So let\[cq]s say we had \f[C]\-\-suffix \-2019\-01\-01\f[R], without the +flag \f[C]file.txt\f[R] would be backed up to +\f[C]file.txt\-2019\-01\-01\f[R] and with the flag it would be backed up +to \f[C]file\-2019\-01\-01.txt\f[R]. This can be helpful to make sure the suffixed files can still be opened. .SS \[en]syslog .PP On capable OSes (not Windows or Plan9) send all log output to syslog. .PP This can be useful for running rclone in a script or -\f[C]rclone\ mount\f[]. +\f[C]rclone mount\f[R]. .SS \[en]syslog\-facility string .PP -If using \f[C]\-\-syslog\f[] this sets the syslog facility (eg -\f[C]KERN\f[], \f[C]USER\f[]). -See \f[C]man\ syslog\f[] for a list of possible facilities. -The default facility is \f[C]DAEMON\f[]. +If using \f[C]\-\-syslog\f[R] this sets the syslog facility (eg +\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 \[en]tpslimit float .PP Limit HTTP transactions per second to this. 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 -\f[C]\-\-tpslimit\ 10\f[], or to 1 transaction every 2 seconds use -\f[C]\-\-tpslimit\ 0.5\f[]. +\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). .PP -This can be very useful for \f[C]rclone\ mount\f[] to control the +This can be very useful for \f[C]rclone mount\f[R] to control the behaviour of applications using it. .PP -See also \f[C]\-\-tpslimit\-burst\f[]. +See also \f[C]\-\-tpslimit\-burst\f[R]. .SS \[en]tpslimit\-burst int .PP -Max burst of transactions for \f[C]\-\-tpslimit\f[]. +Max burst of transactions for \f[C]\-\-tpslimit\f[R]. (default 1) .PP -Normally \f[C]\-\-tpslimit\f[] will do exactly the number of transaction -per second specified. -However if you supply \f[C]\-\-tps\-burst\f[] then rclone can save up +Normally \f[C]\-\-tpslimit\f[R] will do exactly the number of +transaction per second specified. +However if you supply \f[C]\-\-tps\-burst\f[R] then rclone can save up some transactions from when it was idle giving a burst of up to the parameter supplied. .PP -For example if you provide \f[C]\-\-tpslimit\-burst\ 10\f[] then if -rclone has been idle for more than 10*\f[C]\-\-tpslimit\f[] then it can +For example if you provide \f[C]\-\-tpslimit\-burst 10\f[R] then if +rclone has been idle for more than 10*\f[C]\-\-tpslimit\f[R] then it can do 10 transactions very quickly before they are limited again. .PP -This may be used to increase performance of \f[C]\-\-tpslimit\f[] +This may be used to increase performance of \f[C]\-\-tpslimit\f[R] without changing the long term average number of transactions per second. .SS \[en]track\-renames .PP -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. +By default, rclone doesn\[cq]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[] operations and perform +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 @@ -6568,31 +6766,31 @@ 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. Note: Encrypted destinations are not supported by -\f[C]\-\-track\-renames\f[]. +\f[C]\-\-track\-renames\f[R]. .PP -Note that \f[C]\-\-track\-renames\f[] is incompatible with -\f[C]\-\-no\-traverse\f[] and that it uses extra memory to keep track of -all the rename candidates. +Note that \f[C]\-\-track\-renames\f[R] is incompatible with +\f[C]\-\-no\-traverse\f[R] and that it uses extra memory to keep track +of all the rename candidates. .PP -Note also that \f[C]\-\-track\-renames\f[] is incompatible with -\f[C]\-\-delete\-before\f[] and will select \f[C]\-\-delete\-after\f[] -instead of \f[C]\-\-delete\-during\f[]. +Note also that \f[C]\-\-track\-renames\f[R] is incompatible with +\f[C]\-\-delete\-before\f[R] and will select \f[C]\-\-delete\-after\f[R] +instead of \f[C]\-\-delete\-during\f[R]. .SS \[en]delete\-(before,during,after) .PP This option allows you to specify when files on your destination are deleted when you sync folders. .PP -Specifying the value \f[C]\-\-delete\-before\f[] will delete all files -present on the destination, but not on the source \f[I]before\f[] +Specifying the value \f[C]\-\-delete\-before\f[R] will delete all files +present on the destination, but not on the source \f[I]before\f[R] starting the transfer of any new or updated files. This uses two passes through the file systems, one for the deletions and one for the copies. .PP -Specifying \f[C]\-\-delete\-during\f[] will delete files while checking +Specifying \f[C]\-\-delete\-during\f[R] will delete files while checking and uploading files. This is the fastest option and uses the least memory. .PP -Specifying \f[C]\-\-delete\-after\f[] (the default value) will delay +Specifying \f[C]\-\-delete\-after\f[R] (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 @@ -6602,11 +6800,11 @@ 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 \f[C]not\ deleting\ files\ as\ there\ were\ IO\ errors\f[]. +the message \f[C]not deleting files as there were IO errors\f[R]. .SS \[en]fast\-list .PP When doing anything which involves a directory listing (eg -\f[C]sync\f[], \f[C]copy\f[], \f[C]ls\f[] \- in fact nearly every +\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. This can be parallelised and works very quickly using the least amount @@ -6617,36 +6815,36 @@ directory in one (or a small number) of transactions. These tend to be the bucket based remotes (eg S3, B2, GCS, Swift, Hubic). .PP -If you use the \f[C]\-\-fast\-list\f[] flag then rclone will use this +If you use the \f[C]\-\-fast\-list\f[R] flag then rclone will use this method for listing directories. This will have the following consequences for the listing: .IP \[bu] 2 -It \f[B]will\f[] use fewer transactions (important if you pay for them) +It \f[B]will\f[R] use fewer transactions (important if you pay for them) .IP \[bu] 2 -It \f[B]will\f[] use more memory. +It \f[B]will\f[R] use more memory. Rclone has to load the whole listing into memory. .IP \[bu] 2 -It \f[I]may\f[] be faster because it uses fewer transactions +It \f[I]may\f[R] be faster because it uses fewer transactions .IP \[bu] 2 -It \f[I]may\f[] be slower because it can't be parallelized +It \f[I]may\f[R] be slower because it can\[cq]t be parallelized .PP rclone should always give identical results with and without -\f[C]\-\-fast\-list\f[]. +\f[C]\-\-fast\-list\f[R]. .PP If you pay for transactions and can fit your entire sync listing into -memory then \f[C]\-\-fast\-list\f[] is recommended. -If you have a very big sync to do then don't use \f[C]\-\-fast\-list\f[] -otherwise you will run out of memory. +memory then \f[C]\-\-fast\-list\f[R] is recommended. +If you have a very big sync to do then don\[cq]t use +\f[C]\-\-fast\-list\f[R] otherwise you will run out of memory. .PP -If you use \f[C]\-\-fast\-list\f[] on a remote which doesn't support it, -then rclone will just ignore it. +If you use \f[C]\-\-fast\-list\f[R] on a remote which doesn\[cq]t +support it, then rclone will just ignore it. .SS \[en]timeout=TIME .PP This sets the IO idle timeout. If a transfer has started but then becomes idle for this long it is considered broken and disconnected. .PP -The default is \f[C]5m\f[]. +The default is \f[C]5m\f[R]. Set to 0 to disable. .SS \[en]transfers=N .PP @@ -6661,24 +6859,24 @@ The default is to run 4 file transfers in parallel. This forces rclone to skip any files which exist on the destination and have a modified time that is newer than the source file. .PP -This can be useful when transferring to a remote which doesn't support -mod times directly (or when using \f[C]\-\-use\-server\-modtime\f[] to -avoid extra API calls) as it is more accurate than a -\f[C]\-\-size\-only\f[] check and faster than using -\f[C]\-\-checksum\f[]. +This can be useful when transferring to a remote which doesn\[cq]t +support mod times directly (or when using +\f[C]\-\-use\-server\-modtime\f[R] to avoid extra API calls) as it is +more accurate than a \f[C]\-\-size\-only\f[R] check and faster than +using \f[C]\-\-checksum\f[R]. .PP If an existing destination file has a modification time equal (within -the computed modify window precision) to the source file's, it will be -updated if the sizes are different. -If \f[C]\-\-checksum\f[] is set then rclone will update the destination +the computed modify window precision) to the source file\[cq]s, it will +be updated if the sizes are different. +If \f[C]\-\-checksum\f[R] is set then rclone will update the destination if the checksums differ too. .PP If an existing destination file is older than the source file then it will be updated if the size or checksum differs from the source file. .PP -On remotes which don't support mod time directly (or when using -\f[C]\-\-use\-server\-modtime\f[]) the time checked will be the uploaded -time. +On remotes which don\[cq]t support mod time directly (or when using +\f[C]\-\-use\-server\-modtime\f[R]) the time checked will be the +uploaded time. This means that if uploading to one of these remotes, rclone will skip any files which exist on the destination and have an uploaded time that is newer than the modification time of the source file. @@ -6686,7 +6884,7 @@ is newer than the modification time of the source file. .PP If this flag is set then rclone will use anonymous memory allocated by mmap on Unix based platforms and VirtualAlloc on Windows for its -transfer buffers (size controlled by \f[C]\-\-buffer\-size\f[]). +transfer buffers (size controlled by \f[C]\-\-buffer\-size\f[R]). Memory allocated like this does not go on the Go heap and can be returned to the OS immediately when it is finished with. .PP @@ -6706,23 +6904,23 @@ By default it will make an API call to retrieve the metadata when the modtime is needed by an operation. .PP Use this flag to disable the extra API call and rely instead on the -server's modified time. -In cases such as a local to remote sync using \f[C]\-\-update\f[], +server\[cq]s modified time. +In cases such as a local to remote sync using \f[C]\-\-update\f[R], knowing the local file is newer than the time it was last uploaded to the remote is sufficient. In those cases, this flag can speed up the process and reduce the number of API calls necessary. .PP Using this flag on a sync operation without also using -\f[C]\-\-update\f[] would cause all files modified at any time other +\f[C]\-\-update\f[R] would cause all files modified at any time other than the last upload time to be uploaded again, which is probably not what you want. .SS \-v, \-vv, \[en]verbose .PP -With \f[C]\-v\f[] rclone will tell you about each file that is +With \f[C]\-v\f[R] rclone will tell you about each file that is transferred and a small number of significant events. .PP -With \f[C]\-vv\f[] rclone will become very verbose telling you about +With \f[C]\-vv\f[R] rclone will become very verbose telling you about every file it considers and transfers. Please send bug reports with a log with this setting. .SS \-V, \[en]version @@ -6749,78 +6947,79 @@ This loads the PEM encoded client side certificate. This is used for mutual TLS authentication (https://en.wikipedia.org/wiki/Mutual_authentication). .PP -The \f[C]\-\-client\-key\f[] flag is required too when using this. +The \f[C]\-\-client\-key\f[R] flag is required too when using this. .SS \[en]client\-key string .PP This loads the PEM encoded client side private key used for mutual TLS authentication. -Used in conjunction with \f[C]\-\-client\-cert\f[]. +Used in conjunction with \f[C]\-\-client\-cert\f[R]. .SS \[en]no\-check\-certificate=true/false .PP -\f[C]\-\-no\-check\-certificate\f[] controls whether a client verifies -the server's certificate chain and host name. -If \f[C]\-\-no\-check\-certificate\f[] is true, TLS accepts any +\f[C]\-\-no\-check\-certificate\f[R] controls whether a client verifies +the server\[cq]s certificate chain and host name. +If \f[C]\-\-no\-check\-certificate\f[R] is true, TLS accepts any certificate presented by the server and any host name in that certificate. In this mode, TLS is susceptible to man\-in\-the\-middle attacks. .PP -This option defaults to \f[C]false\f[]. +This option defaults to \f[C]false\f[R]. .PP -\f[B]This should be used only for testing.\f[] +\f[B]This should be used only for testing.\f[R] .SS Configuration Encryption .PP Your configuration file contains information for logging in to your cloud services. -This means that you should keep your \f[C]\&.rclone.conf\f[] file in a +This means that you should keep your \f[C].rclone.conf\f[R] file in a secure location. .PP -If you are in an environment where that isn't possible, you can add a -password to your configuration. -This means that you will have to enter the password every time you start -rclone. +If you are in an environment where that isn\[cq]t possible, you can add +a password to your configuration. +This means that you will have to supply the password every time you +start rclone. .PP To add a password to your rclone configuration, execute -\f[C]rclone\ config\f[]. +\f[C]rclone config\f[R]. .IP .nf \f[C] ->rclone\ config -Current\ remotes: +>rclone config +Current remotes: -e)\ Edit\ existing\ remote -n)\ New\ remote -d)\ Delete\ remote -s)\ Set\ configuration\ password -q)\ Quit\ config +e) Edit existing remote +n) New remote +d) Delete remote +s) Set configuration password +q) Quit config e/n/d/s/q> -\f[] +\f[R] .fi .PP -Go into \f[C]s\f[], Set configuration password: +Go into \f[C]s\f[R], Set configuration password: .IP .nf \f[C] -e/n/d/s/q>\ s -Your\ configuration\ is\ not\ encrypted. -If\ you\ add\ a\ password,\ you\ will\ protect\ your\ login\ information\ to\ cloud\ services. -a)\ Add\ Password -q)\ Quit\ to\ main\ menu -a/q>\ a -Enter\ NEW\ configuration\ password: +e/n/d/s/q> s +Your configuration is not encrypted. +If you add a password, you will protect your login information to cloud services. +a) Add Password +q) Quit to main menu +a/q> a +Enter NEW configuration password: password: -Confirm\ NEW\ password: +Confirm NEW password: password: -Password\ set -Your\ configuration\ is\ encrypted. -c)\ Change\ Password -u)\ Unencrypt\ configuration -q)\ Quit\ to\ main\ menu +Password set +Your configuration is encrypted. +c) Change Password +u) Unencrypt configuration +q) Quit to main menu c/u/q> -\f[] +\f[R] .fi .PP Your configuration is now encrypted, and every time you start rclone you -will now be asked for the password. +will have to supply the password. +See below for details. In the same menu, you can change the password or completely remove encryption from your configuration. .PP @@ -6838,58 +7037,96 @@ encrypted rclone configuration in public if it contains sensitive information, maybe except if you use a very strong password. .PP If it is safe in your environment, you can set the -\f[C]RCLONE_CONFIG_PASS\f[] environment variable to contain your +\f[C]RCLONE_CONFIG_PASS\f[R] environment variable to contain your password, in which case it will be used for decrypting the configuration. .PP You can set this for a session from a script. For unix like systems save this to a file called -\f[C]set\-rclone\-password\f[]: +\f[C]set\-rclone\-password\f[R]: .IP .nf \f[C] -#!/bin/echo\ Source\ this\ file\ don\[aq]t\ run\ it +#!/bin/echo Source this file don\[aq]t run it -read\ \-s\ RCLONE_CONFIG_PASS -export\ RCLONE_CONFIG_PASS -\f[] +read \-s RCLONE_CONFIG_PASS +export RCLONE_CONFIG_PASS +\f[R] .fi .PP Then source the file when you want to use it. -From the shell you would do \f[C]source\ set\-rclone\-password\f[]. +From the shell you would do \f[C]source set\-rclone\-password\f[R]. It will then ask you for the password and set it in the environment variable. .PP -If you are running rclone inside a script, you might want to disable +An alternate means of supplying the password is to provide a script +which will retrieve the password and print on standard output. +This script should have a fully specified path name and not rely on any +environment variables. +The script is supplied either via +\f[C]\-\-password\-command=\[dq]...\[dq]\f[R] command line argument or +via the \f[C]RCLONE_PASSWORD_COMMAND\f[R] environment variable. +.PP +One useful example of this is using the \f[C]passwordstore\f[R] +application to retrieve the password: +.IP +.nf +\f[C] +export RCLONE_PASSWORD_COMMAND=\[dq]pass rclone/config\[dq] +\f[R] +.fi +.PP +If the \f[C]passwordstore\f[R] password manager holds the password for +the rclone configuration, using the script method means the password is +primarily protected by the \f[C]passwordstore\f[R] system, and is never +embedded in the clear in scripts, nor available for examination using +the standard commands available. +It is quite possible with long running rclone sessions for copies of +passwords to be innocently captured in log files or terminal scroll +buffers, etc. +Using the script method of supplying the password enhances the security +of the config password considerably. +.PP +If you are running rclone inside a script, unless you are using the +\f[C]\-\-password\-command\f[R] method, you might want to disable password prompts. -To do that, pass the parameter \f[C]\-\-ask\-password=false\f[] to +To do that, pass the parameter \f[C]\-\-ask\-password=false\f[R] to rclone. This will make rclone fail instead of asking for a password if -\f[C]RCLONE_CONFIG_PASS\f[] doesn't contain a valid password. +\f[C]RCLONE_CONFIG_PASS\f[R] doesn\[cq]t contain a valid password, and +\f[C]\-\-password\-command\f[R] has not been supplied. .SS Developer options .PP 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 \f[C]\-\-drive\-test\-option\f[] \- see +There are also some more remote specific options which aren\[cq]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. .SS \[en]cpuprofile=FILE .PP Write CPU profile to file. -This can be analysed with \f[C]go\ tool\ pprof\f[]. +This can be analysed with \f[C]go tool pprof\f[R]. .SS \[en]dump flag,flag,flag .PP -The \f[C]\-\-dump\f[] flag takes a comma separated list of flags to dump -info about. -These are: +The \f[C]\-\-dump\f[R] flag takes a comma separated list of flags to +dump info about. +.PP +Note that some headers including \f[C]Accept\-Encoding\f[R] as shown may +not be correct in the request and the response may not show +\f[C]Content\-Encoding\f[R] if the go standard libraries auto gzip +encoding was in effect. +In this case the body of the request will be gunzipped before showing +it. +.PP +The available flags are: .SS \[en]dump headers .PP -Dump HTTP headers with \f[C]Authorization:\f[] lines removed. +Dump HTTP headers with \f[C]Authorization:\f[R] lines removed. May still contain sensitive info. Can be very verbose. Useful for debugging only. .PP -Use \f[C]\-\-dump\ auth\f[] if you do want the \f[C]Authorization:\f[] +Use \f[C]\-\-dump auth\f[R] if you do want the \f[C]Authorization:\f[R] headers. .SS \[en]dump bodies .PP @@ -6897,23 +7134,23 @@ Dump HTTP headers and bodies \- may contain sensitive info. Can be very verbose. Useful for debugging only. .PP -Note that the bodies are buffered in memory so don't use this for +Note that the bodies are buffered in memory so don\[cq]t use this for enormous files. .SS \[en]dump requests .PP -Like \f[C]\-\-dump\ bodies\f[] but dumps the request bodies and the +Like \f[C]\-\-dump bodies\f[R] but dumps the request bodies and the response headers. Useful for debugging download problems. .SS \[en]dump responses .PP -Like \f[C]\-\-dump\ bodies\f[] but dumps the response bodies and the +Like \f[C]\-\-dump bodies\f[R] but dumps the response bodies and the request headers. Useful for debugging upload problems. .SS \[en]dump auth .PP Dump HTTP headers \- will contain sensitive info such as -\f[C]Authorization:\f[] headers \- use \f[C]\-\-dump\ headers\f[] to -dump without \f[C]Authorization:\f[] headers. +\f[C]Authorization:\f[R] headers \- use \f[C]\-\-dump headers\f[R] to +dump without \f[C]Authorization:\f[R] headers. Can be very verbose. Useful for debugging only. .SS \[en]dump filters @@ -6927,41 +7164,41 @@ to standard output. .SS \[en]dump openfiles .PP This dumps a list of the open files at the end of the command. -It uses the \f[C]lsof\f[] command to do that so you'll need that +It uses the \f[C]lsof\f[R] command to do that so you\[cq]ll need that installed to use it. .SS \[en]memprofile=FILE .PP Write memory profile to file. -This can be analysed with \f[C]go\ tool\ pprof\f[]. +This can be analysed with \f[C]go tool pprof\f[R]. .SS Filtering .PP For the filtering options .IP \[bu] 2 -\f[C]\-\-delete\-excluded\f[] +\f[C]\-\-delete\-excluded\f[R] .IP \[bu] 2 -\f[C]\-\-filter\f[] +\f[C]\-\-filter\f[R] .IP \[bu] 2 -\f[C]\-\-filter\-from\f[] +\f[C]\-\-filter\-from\f[R] .IP \[bu] 2 -\f[C]\-\-exclude\f[] +\f[C]\-\-exclude\f[R] .IP \[bu] 2 -\f[C]\-\-exclude\-from\f[] +\f[C]\-\-exclude\-from\f[R] .IP \[bu] 2 -\f[C]\-\-include\f[] +\f[C]\-\-include\f[R] .IP \[bu] 2 -\f[C]\-\-include\-from\f[] +\f[C]\-\-include\-from\f[R] .IP \[bu] 2 -\f[C]\-\-files\-from\f[] +\f[C]\-\-files\-from\f[R] .IP \[bu] 2 -\f[C]\-\-min\-size\f[] +\f[C]\-\-min\-size\f[R] .IP \[bu] 2 -\f[C]\-\-max\-size\f[] +\f[C]\-\-max\-size\f[R] .IP \[bu] 2 -\f[C]\-\-min\-age\f[] +\f[C]\-\-min\-age\f[R] .IP \[bu] 2 -\f[C]\-\-max\-age\f[] +\f[C]\-\-max\-age\f[R] .IP \[bu] 2 -\f[C]\-\-dump\ filters\f[] +\f[C]\-\-dump filters\f[R] .PP See the filtering section (https://rclone.org/filtering/). .SS Remote control @@ -6969,41 +7206,41 @@ See the filtering section (https://rclone.org/filtering/). For the remote control options and for instructions on how to remote control rclone .IP \[bu] 2 -\f[C]\-\-rc\f[] +\f[C]\-\-rc\f[R] .IP \[bu] 2 -and anything starting with \f[C]\-\-rc\-\f[] +and anything starting with \f[C]\-\-rc\-\f[R] .PP See the remote control section (https://rclone.org/rc/). .SS Logging .PP -rclone has 4 levels of logging, \f[C]ERROR\f[], \f[C]NOTICE\f[], -\f[C]INFO\f[] and \f[C]DEBUG\f[]. +rclone has 4 levels of logging, \f[C]ERROR\f[R], \f[C]NOTICE\f[R], +\f[C]INFO\f[R] and \f[C]DEBUG\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[]). +output of rclone commands (eg \f[C]rclone ls\f[R]). .PP -By default, rclone will produce \f[C]Error\f[] and \f[C]Notice\f[] level -messages. +By default, rclone will produce \f[C]Error\f[R] and \f[C]Notice\f[R] +level messages. .PP -If you use the \f[C]\-q\f[] flag, rclone will only produce -\f[C]Error\f[] messages. +If you use the \f[C]\-q\f[R] flag, rclone will only produce +\f[C]Error\f[R] messages. .PP -If you use the \f[C]\-v\f[] flag, rclone will produce \f[C]Error\f[], -\f[C]Notice\f[] and \f[C]Info\f[] messages. +If you use the \f[C]\-v\f[R] flag, rclone will produce \f[C]Error\f[R], +\f[C]Notice\f[R] and \f[C]Info\f[R] messages. .PP -If you use the \f[C]\-vv\f[] flag, rclone will produce \f[C]Error\f[], -\f[C]Notice\f[], \f[C]Info\f[] and \f[C]Debug\f[] messages. +If you use the \f[C]\-vv\f[R] flag, rclone will produce \f[C]Error\f[R], +\f[C]Notice\f[R], \f[C]Info\f[R] and \f[C]Debug\f[R] messages. .PP -You can also control the log levels with the \f[C]\-\-log\-level\f[] +You can also control the log levels with the \f[C]\-\-log\-level\f[R] flag. .PP -If you use the \f[C]\-\-log\-file=FILE\f[] option, rclone will redirect -\f[C]Error\f[], \f[C]Info\f[] and \f[C]Debug\f[] messages along with +If you use the \f[C]\-\-log\-file=FILE\f[R] option, rclone will redirect +\f[C]Error\f[R], \f[C]Info\f[R] and \f[C]Debug\f[R] messages along with standard error to FILE. .PP -If you use the \f[C]\-\-syslog\f[] flag then rclone will log to syslog -and the \f[C]\-\-syslog\-facility\f[] control which facility it uses. +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 @@ -7022,7 +7259,7 @@ When rclone is running it will accumulate errors as it goes along, and only exit with a non\-zero exit code if (after retries) there were still failed transfers. For every error counted there will be a high priority log message -(visible with \f[C]\-q\f[]) showing the message and which file caused +(visible with \f[C]\-q\f[R]) showing the message and which file caused the problem. A high priority message is also shown when starting a retry so the user can see that any previous error messages may not be valid after the @@ -7031,26 +7268,26 @@ If rclone has done a retry it will log a high priority message if the retry was successful. .SS List of exit codes .IP \[bu] 2 -\f[C]0\f[] \- success +\f[C]0\f[R] \- success .IP \[bu] 2 -\f[C]1\f[] \- Syntax or usage error +\f[C]1\f[R] \- Syntax or usage error .IP \[bu] 2 -\f[C]2\f[] \- Error not otherwise categorised +\f[C]2\f[R] \- Error not otherwise categorised .IP \[bu] 2 -\f[C]3\f[] \- Directory not found +\f[C]3\f[R] \- Directory not found .IP \[bu] 2 -\f[C]4\f[] \- File not found +\f[C]4\f[R] \- File not found .IP \[bu] 2 -\f[C]5\f[] \- Temporary error (one that more retries might fix) (Retry +\f[C]5\f[R] \- Temporary error (one that more retries might fix) (Retry errors) .IP \[bu] 2 -\f[C]6\f[] \- Less serious errors (like 461 errors from dropbox) +\f[C]6\f[R] \- Less serious errors (like 461 errors from dropbox) (NoRetry errors) .IP \[bu] 2 -\f[C]7\f[] \- Fatal error (one that more retries won't fix, like account -suspended) (Fatal errors) +\f[C]7\f[R] \- Fatal error (one that more retries won\[cq]t fix, like +account suspended) (Fatal errors) .IP \[bu] 2 -\f[C]8\f[] \- Transfer exceeded \- limit set by \[en]max\-transfer +\f[C]8\f[R] \- Transfer exceeded \- limit set by \[en]max\-transfer reached .SS Environment Variables .PP @@ -7061,16 +7298,16 @@ These can be used to set defaults for options or config file entries. Every option in rclone can have its default set by environment variable. .PP To find the name of the environment variable, first, take the long -option name, strip the leading \f[C]\-\-\f[], change \f[C]\-\f[] to -\f[C]_\f[], make upper case and prepend \f[C]RCLONE_\f[]. +option name, strip the leading \f[C]\-\-\f[R], change \f[C]\-\f[R] to +\f[C]_\f[R], make upper case and prepend \f[C]RCLONE_\f[R]. .PP -For example, to always set \f[C]\-\-stats\ 5s\f[], set the environment -variable \f[C]RCLONE_STATS=5s\f[]. +For example, to always set \f[C]\-\-stats 5s\f[R], set the environment +variable \f[C]RCLONE_STATS=5s\f[R]. If you set stats on the command line this will override the environment variable setting. .PP -Or to always use the trash in drive \f[C]\-\-drive\-use\-trash\f[], set -\f[C]RCLONE_DRIVE_USE_TRASH=true\f[]. +Or to always use the trash in drive \f[C]\-\-drive\-use\-trash\f[R], set +\f[C]RCLONE_DRIVE_USE_TRASH=true\f[R]. .PP The same parser is used for the options and the environment variables so they take exactly the same form. @@ -7080,35 +7317,35 @@ You can set defaults for values in the config file on an individual remote basis. If you want to use this feature, you will need to discover the name of the config items that you want. -The easiest way is to run through \f[C]rclone\ config\f[] by hand, then +The easiest way is to run through \f[C]rclone config\f[R] by hand, then look in the config file to see what the values are (the config file can -be found by looking at the help for \f[C]\-\-config\f[] in -\f[C]rclone\ help\f[]). +be found by looking at the help for \f[C]\-\-config\f[R] in +\f[C]rclone help\f[R]). .PP To find the name of the environment variable, you need to set, take -\f[C]RCLONE_CONFIG_\f[] + name of remote + \f[C]_\f[] + name of config +\f[C]RCLONE_CONFIG_\f[R] + name of remote + \f[C]_\f[R] + name of config file option and make it all uppercase. .PP -For example, to configure an S3 remote named \f[C]mys3:\f[] without a +For example, to configure an S3 remote named \f[C]mys3:\f[R] without a config file (using unix ways of setting environment variables): .IP .nf \f[C] -$\ export\ RCLONE_CONFIG_MYS3_TYPE=s3 -$\ export\ RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX -$\ export\ RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX -$\ rclone\ lsd\ MYS3: -\ \ \ \ \ \ \ \ \ \ \-1\ 2016\-09\-21\ 12:54:21\ \ \ \ \ \ \ \ \-1\ my\-bucket -$\ rclone\ listremotes\ |\ grep\ mys3 +$ export RCLONE_CONFIG_MYS3_TYPE=s3 +$ export RCLONE_CONFIG_MYS3_ACCESS_KEY_ID=XXX +$ export RCLONE_CONFIG_MYS3_SECRET_ACCESS_KEY=XXX +$ rclone lsd MYS3: + \-1 2016\-09\-21 12:54:21 \-1 my\-bucket +$ rclone listremotes | grep mys3 mys3: -\f[] +\f[R] .fi .PP Note that if you want to create a remote using environment variables you -must create the \f[C]\&..._TYPE\f[] variable as above. +must create the \f[C]..._TYPE\f[R] variable as above. .SS Other environment variables .IP \[bu] 2 -RCLONE_CONFIG_PASS` set to contain your config file password (see +RCLONE_CONFIG_PASS\[ga] set to contain your config file password (see Configuration Encryption section) .IP \[bu] 2 HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions @@ -7137,52 +7374,52 @@ On the headless box .nf \f[C] \&... -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>\ n -For\ this\ to\ work,\ you\ will\ need\ rclone\ available\ on\ a\ machine\ that\ has\ a\ web\ browser\ available. -Execute\ the\ following\ on\ your\ machine: -\ \ \ \ rclone\ authorize\ "amazon\ cloud\ drive" -Then\ paste\ the\ result\ below: +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> n +For this to work, you will need rclone available on a machine that has a web browser available. +Execute the following on your machine: + rclone authorize \[dq]amazon cloud drive\[dq] +Then paste the result below: result> -\f[] +\f[R] .fi .PP Then on your main desktop machine .IP .nf \f[C] -rclone\ authorize\ "amazon\ cloud\ drive" -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 -Paste\ the\ following\ into\ your\ remote\ machine\ \-\-\-> +rclone authorize \[dq]amazon cloud drive\[dq] +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 +Paste the following into your remote machine \-\-\-> SECRET_TOKEN -<\-\-\-End\ paste -\f[] +<\-\-\-End paste +\f[R] .fi .PP Then back to the headless box, paste in the code .IP .nf \f[C] -result>\ SECRET_TOKEN +result> SECRET_TOKEN \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [acd12] -client_id\ =\ -client_secret\ =\ -token\ =\ SECRET_TOKEN +client_id = +client_secret = +token = SECRET_TOKEN \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote +y) Yes this is OK +e) Edit this remote +d) Delete this remote y/e/d> -\f[] +\f[R] .fi .SS Configuring by copying the config file .PP @@ -7193,25 +7430,25 @@ So first configure rclone on your desktop machine .IP .nf \f[C] -rclone\ config -\f[] +rclone config +\f[R] .fi .PP to set up the config file. .PP -Find the config file by running \f[C]rclone\ config\ file\f[], for +Find the config file by running \f[C]rclone config file\f[R], for example .IP .nf \f[C] -$\ rclone\ config\ file -Configuration\ file\ is\ stored\ at: +$ rclone config file +Configuration file is stored at: /home/user/.rclone.conf -\f[] +\f[R] .fi .PP 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[] on the +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 @@ -7219,139 +7456,139 @@ 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[], \f[C]sync\f[], -\f[C]move\f[], \f[C]ls\f[], \f[C]lsl\f[], \f[C]md5sum\f[], -\f[C]sha1sum\f[], \f[C]size\f[], \f[C]delete\f[] and \f[C]check\f[] +The filters are applied for the \f[C]copy\f[R], \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[] does not obey the filters. +Note that \f[C]purge\f[R] does not obey the filters. .PP Each path as it passes through rclone is matched against the include and -exclude rules like \f[C]\-\-include\f[], \f[C]\-\-exclude\f[], -\f[C]\-\-include\-from\f[], \f[C]\-\-exclude\-from\f[], -\f[C]\-\-filter\f[], or \f[C]\-\-filter\-from\f[]. -The simplest way to try them out is using the \f[C]ls\f[] command, or -\f[C]\-\-dry\-run\f[] together with \f[C]\-v\f[]. +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]. .SS Patterns .PP The patterns used to match files for inclusion or exclusion are based on \[lq]file globs\[rq] as used by the unix shell. .PP -If the pattern starts with a \f[C]/\f[] then it only matches at the top -level of the directory tree, \f[B]relative to the root of the remote\f[] -(not necessarily the root of the local drive). -If it doesn't start with \f[C]/\f[] then it is matched starting at the -\f[B]end of the path\f[], but it will only match a complete path +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\[cq]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: .IP .nf \f[C] -file.jpg\ \ \-\ matches\ "file.jpg" -\ \ \ \ \ \ \ \ \ \ \-\ matches\ "directory/file.jpg" -\ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "afile.jpg" -\ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "directory/afile.jpg" -/file.jpg\ \-\ matches\ "file.jpg"\ in\ the\ root\ directory\ of\ the\ remote -\ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "afile.jpg" -\ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "directory/file.jpg" -\f[] +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 -\f[B]Important\f[] Note that you must use \f[C]/\f[] in patterns and not -\f[C]\\\f[] even if running on Windows. +\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[] matches anything but not a \f[C]/\f[]. +A \f[C]*\f[R] matches anything but not a \f[C]/\f[R]. .IP .nf \f[C] -*.jpg\ \ \-\ matches\ "file.jpg" -\ \ \ \ \ \ \ \-\ matches\ "directory/file.jpg" -\ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "file.jpg/something" -\f[] +*.jpg \- matches \[dq]file.jpg\[dq] + \- matches \[dq]directory/file.jpg\[dq] + \- doesn\[aq]t match \[dq]file.jpg/something\[dq] +\f[R] .fi .PP -Use \f[C]**\f[] to match anything, including slashes (\f[C]/\f[]). +Use \f[C]**\f[R] to match anything, including slashes (\f[C]/\f[R]). .IP .nf \f[C] -dir/**\ \-\ matches\ "dir/file.jpg" -\ \ \ \ \ \ \ \-\ matches\ "dir/dir1/dir2/file.jpg" -\ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "directory/file.jpg" -\ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "adir/file.jpg" -\f[] +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] +\f[R] .fi .PP -A \f[C]?\f[] matches any character except a slash \f[C]/\f[]. +A \f[C]?\f[R] matches any character except a slash \f[C]/\f[R]. .IP .nf \f[C] -l?ss\ \ \-\ matches\ "less" -\ \ \ \ \ \ \-\ matches\ "lass" -\ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "floss" -\f[] +l?ss \- matches \[dq]less\[dq] + \- matches \[dq]lass\[dq] + \- doesn\[aq]t match \[dq]floss\[dq] +\f[R] .fi .PP -A \f[C][\f[] and \f[C]]\f[] together make a character class, such as -\f[C][a\-z]\f[] or \f[C][aeiou]\f[] or \f[C][[:alpha:]]\f[]. +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. .IP .nf \f[C] -h[ae]llo\ \-\ matches\ "hello" -\ \ \ \ \ \ \ \ \ \-\ matches\ "hallo" -\ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "hullo" -\f[] +h[ae]llo \- matches \[dq]hello\[dq] + \- matches \[dq]hallo\[dq] + \- doesn\[aq]t match \[dq]hullo\[dq] +\f[R] .fi .PP -A \f[C]{\f[] and \f[C]}\f[] define a choice between elements. +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\ "one_potato" -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \-\ matches\ "two_potato" -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "three_potato" -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "_potato" -\f[] +{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 .PP -Special characters can be escaped with a \f[C]\\\f[] before them. +Special characters can be escaped with a \f[C]\[rs]\f[R] before them. .IP .nf \f[C] -\\*.jpg\ \ \ \ \ \ \ \-\ matches\ "*.jpg" -\\\\.jpg\ \ \ \ \ \ \ \-\ matches\ "\\.jpg" -\\[one\\].jpg\ \ \-\ matches\ "[one].jpg" -\f[] +\[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[] flag is -used. +Patterns are case sensitive unless the \f[C]\-\-ignore\-case\f[R] flag +is used. .PP -Without \f[C]\-\-ignore\-case\f[] (default) +Without \f[C]\-\-ignore\-case\f[R] (default) .IP .nf \f[C] -potato\ \-\ matches\ "potato" -\ \ \ \ \ \ \ \-\ doesn\[aq]t\ match\ "POTATO" -\f[] +potato \- matches \[dq]potato\[dq] + \- doesn\[aq]t match \[dq]POTATO\[dq] +\f[R] .fi .PP -With \f[C]\-\-ignore\-case\f[] +With \f[C]\-\-ignore\-case\f[R] .IP .nf \f[C] -potato\ \-\ matches\ "potato" -\ \ \ \ \ \ \ \-\ matches\ "POTATO" -\f[] +potato \- matches \[dq]potato\[dq] + \- matches \[dq]POTATO\[dq] +\f[R] .fi .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\ "remote:dir*.jpg"\ /path/to/dir\f[] won't work \- -what is required is -\f[C]rclone\ \-\-include\ "*.jpg"\ copy\ remote:dir\ /path/to/dir\f[] +\f[C]rclone copy \[dq]remote:dir*.jpg\[dq] /path/to/dir\f[R] won\[cq]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. @@ -7361,7 +7598,7 @@ Eg if you add the include rule .nf \f[C] /a/*.jpg -\f[] +\f[R] .fi .PP Rclone will synthesize the directory include rule @@ -7369,24 +7606,24 @@ Rclone will synthesize the directory include rule .nf \f[C] /a/ -\f[] +\f[R] .fi .PP -If you put any rules which end in \f[C]/\f[] then it will only match +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[] used to optimise directory access +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't optimise anything on bucket based remotes (eg -s3, swift, google compute storage, b2) which don't have a concept of -directory. +Directory matches won\[cq]t optimise anything on bucket based remotes +(eg s3, swift, google compute storage, b2) which don\[cq]t have a +concept of directory. .SS Differences between rsync and rclone patterns .PP -Rclone implements bash style \f[C]{a,b,c}\f[] glob matching which rsync -doesn't. +Rclone implements bash style \f[C]{a,b,c}\f[R] glob matching which rsync +doesn\[cq]t. .PP -Rclone always does a wildcard match so \f[C]\\\f[] must always escape a -\f[C]\\\f[]. +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. @@ -7398,32 +7635,32 @@ 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. .PP -For example given the following rules, \f[C]+\f[] being include, -\f[C]\-\f[] being exclude, +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[] +\- secret*.jpg ++ *.jpg ++ *.png ++ file2.avi +\- * +\f[R] .fi .PP This would include .IP \[bu] 2 -\f[C]file1.jpg\f[] +\f[C]file1.jpg\f[R] .IP \[bu] 2 -\f[C]file3.png\f[] +\f[C]file3.png\f[R] .IP \[bu] 2 -\f[C]file2.avi\f[] +\f[C]file2.avi\f[R] .PP This would exclude .IP \[bu] 2 -\f[C]secret17.jpg\f[] +\f[C]secret17.jpg\f[R] .IP \[bu] 2 -non \f[C]*.jpg\f[] and \f[C]*.png\f[] +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. @@ -7438,396 +7675,401 @@ Filtering rules are added with the following command line flags. You can repeat the following options to add more than one rule of that type. .IP \[bu] 2 -\f[C]\-\-include\f[] +\f[C]\-\-include\f[R] .IP \[bu] 2 -\f[C]\-\-include\-from\f[] +\f[C]\-\-include\-from\f[R] .IP \[bu] 2 -\f[C]\-\-exclude\f[] +\f[C]\-\-exclude\f[R] .IP \[bu] 2 -\f[C]\-\-exclude\-from\f[] +\f[C]\-\-exclude\-from\f[R] .IP \[bu] 2 -\f[C]\-\-filter\f[] +\f[C]\-\-filter\f[R] .IP \[bu] 2 -\f[C]\-\-filter\-from\f[] +\f[C]\-\-filter\-from\f[R] .PP -\f[B]Important\f[] You should not use \f[C]\-\-include*\f[] together -with \f[C]\-\-exclude*\f[]. +\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[]. +In that case try to use: \f[C]\-\-filter*\f[R]. .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. .PP -So all \f[C]\-\-include\f[] options are processed first in the order -they appeared on the command line, then all \f[C]\-\-include\-from\f[] +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. .PP -To mix up the order includes and excludes, the \f[C]\-\-filter\f[] flag +To mix up the order includes and excludes, the \f[C]\-\-filter\f[R] flag can be used. -.SS \f[C]\-\-exclude\f[] \- Exclude files matching pattern +.SS \f[C]\-\-exclude\f[R] \- Exclude files matching pattern .PP -Add a single exclude rule with \f[C]\-\-exclude\f[]. +Add a single exclude rule with \f[C]\-\-exclude\f[R]. .PP This flag can be repeated. See above for the order the flags are processed in. .PP -Eg \f[C]\-\-exclude\ *.bak\f[] to exclude all bak files from the sync. -.SS \f[C]\-\-exclude\-from\f[] \- Read exclude patterns from file +Eg \f[C]\-\-exclude *.bak\f[R] to exclude all bak files from the sync. +.SS \f[C]\-\-exclude\-from\f[R] \- Read exclude patterns from file .PP Add exclude rules from a file. .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[] +Prepare a file like this \f[C]exclude\-file.txt\f[R] .IP .nf \f[C] -#\ a\ sample\ exclude\ rule\ file +# a sample exclude rule file *.bak file2.jpg -\f[] +\f[R] .fi .PP -Then use as \f[C]\-\-exclude\-from\ exclude\-file.txt\f[]. -This will sync all files except those ending in \f[C]bak\f[] and -\f[C]file2.jpg\f[]. +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]. .PP This is useful if you have a lot of rules. -.SS \f[C]\-\-include\f[] \- Include files matching pattern +.SS \f[C]\-\-include\f[R] \- Include files matching pattern .PP -Add a single include rule with \f[C]\-\-include\f[]. +Add a single include rule with \f[C]\-\-include\f[R]. .PP This flag can be repeated. See above for the order the flags are processed in. .PP -Eg \f[C]\-\-include\ *.{png,jpg}\f[] to include all \f[C]png\f[] and -\f[C]jpg\f[] files in the backup and no others. +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. .PP -This adds an implicit \f[C]\-\-exclude\ *\f[] at the very end of the +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[] and -\f[C]\-\-include\-from\f[] with the other filters (eg -\f[C]\-\-exclude\f[]) but you must include all the files you want in the -include statement. -If this doesn't provide enough flexibility then you must use -\f[C]\-\-filter\-from\f[]. -.SS \f[C]\-\-include\-from\f[] \- Read include patterns from file +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\[cq]t provide enough flexibility then you must use +\f[C]\-\-filter\-from\f[R]. +.SS \f[C]\-\-include\-from\f[R] \- Read include patterns from file .PP Add include rules from a file. .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[] +Prepare a file like this \f[C]include\-file.txt\f[R] .IP .nf \f[C] -#\ a\ sample\ include\ rule\ file +# a sample include rule file *.jpg *.png file2.avi -\f[] +\f[R] .fi .PP -Then use as \f[C]\-\-include\-from\ include\-file.txt\f[]. -This will sync all \f[C]jpg\f[], \f[C]png\f[] files and -\f[C]file2.avi\f[]. +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]. .PP This is useful if you have a lot of rules. .PP -This adds an implicit \f[C]\-\-exclude\ *\f[] at the very end of the +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[] and -\f[C]\-\-include\-from\f[] with the other filters (eg -\f[C]\-\-exclude\f[]) but you must include all the files you want in the -include statement. -If this doesn't provide enough flexibility then you must use -\f[C]\-\-filter\-from\f[]. -.SS \f[C]\-\-filter\f[] \- Add a file\-filtering rule +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\[cq]t provide enough flexibility then you must use +\f[C]\-\-filter\-from\f[R]. +.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[] and exclude rules start with -\f[C]\-\f[]. -A special rule called \f[C]!\f[] can be used to clear the existing +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. .PP This flag can be repeated. See above for the order the flags are processed in. .PP -Eg \f[C]\-\-filter\ "\-\ *.bak"\f[] to exclude all bak files from the -sync. -.SS \f[C]\-\-filter\-from\f[] \- Read filtering patterns from a file +Eg \f[C]\-\-filter \[dq]\- *.bak\[dq]\f[R] to exclude all bak files from +the sync. +.SS \f[C]\-\-filter\-from\f[R] \- Read filtering patterns from a file .PP Add include/exclude rules from a file. .PP This flag can be repeated. See above for the order the flags are processed in. .PP -Prepare a file like this \f[C]filter\-file.txt\f[] +Prepare a file like this \f[C]filter\-file.txt\f[R] .IP .nf \f[C] -#\ a\ sample\ filter\ rule\ file -\-\ secret*.jpg -+\ *.jpg -+\ *.png -+\ file2.avi -\-\ /dir/Trash/** -+\ /dir/** -#\ exclude\ everything\ else -\-\ * -\f[] +# a sample filter rule file +\- secret*.jpg ++ *.jpg ++ *.png ++ file2.avi +\- /dir/Trash/** ++ /dir/** +# exclude everything else +\- * +\f[R] .fi .PP -Then use as \f[C]\-\-filter\-from\ filter\-file.txt\f[]. +Then use as \f[C]\-\-filter\-from filter\-file.txt\f[R]. The rules are processed in the order that they are defined. .PP -This example will include all \f[C]jpg\f[] and \f[C]png\f[] files, -exclude any files matching \f[C]secret*.jpg\f[] and include -\f[C]file2.avi\f[]. -It will also include everything in the directory \f[C]dir\f[] at the -root of the sync, except \f[C]dir/Trash\f[] which it will exclude. +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. -.SS \f[C]\-\-files\-from\f[] \- Read list of source\-file names +.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[] these files are transferred. -The \f[B]filtering rules are ignored\f[] completely if you use this +\f[B]only\f[R] these files are transferred. +The \f[B]filtering rules are ignored\f[R] completely if you use this option. .PP +\f[C]\-\-files\-from\f[R] expects a list of files as it\[cq]s input. +rclone lsf (https://rclone.org/commands/rclone_lsf/) has a compatible +format that can be used to export file lists from remotes. +.PP Rclone will traverse the file system if you use -\f[C]\-\-files\-from\f[], effectively using the files in -\f[C]\-\-files\-from\f[] as a set of filters. +\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. .PP -If you use \f[C]\-\-no\-traverse\f[] as well as \f[C]\-\-files\-from\f[] -then rclone will not traverse the destination file system, it will find -each file individually using approximately 1 API call. +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. .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. .PP -Paths within the \f[C]\-\-files\-from\f[] file will be interpreted as +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[] characters are ignored. +Leading \f[C]/\f[R] characters are ignored. .PP -For example, suppose you had \f[C]files\-from.txt\f[] with this content: +For example, suppose you had \f[C]files\-from.txt\f[R] with this +content: .IP .nf \f[C] -#\ comment +# comment file1.jpg subdir/file2.jpg -\f[] +\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[] +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) .IP .nf \f[C] -/home/me/pics/file1.jpg\ \ \ \ \ \ \ \ →\ remote:pics/file1.jpg -/home/me/pics/subdir/file2.jpg\ →\ remote:pics/subdir/file2.jpg -\f[] +/home/me/pics/file1.jpg \[->] remote:pics/file1.jpg +/home/me/pics/subdir/file2.jpg \[->] remote:pics/subdir/file2.jpg +\f[R] .fi .PP -To take a more complicated example, let's say you had a few files you -want to back up regularly with these absolute paths: +To take a more complicated example, let\[cq]s say you had a few files +you want to back up regularly with these absolute paths: .IP .nf \f[C] /home/user1/important /home/user1/dir/file /home/user2/stuff -\f[] +\f[R] .fi .PP -To copy these you'd find a common subdirectory \- in this case -\f[C]/home\f[] and put the remaining files in \f[C]files\-from.txt\f[] -with or without leading \f[C]/\f[], eg +To copy these you\[cq]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 .IP .nf \f[C] user1/important user1/dir/file user2/stuff -\f[] +\f[R] .fi .PP You could then copy these to a remote like this .IP .nf \f[C] -rclone\ copy\ \-\-files\-from\ files\-from.txt\ /home\ remote:backup -\f[] +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[] with the paths as in -the \f[C]files\-from.txt\f[] like this: +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: .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 -\f[] +/home/user1/important \[->] remote:backup/user1/important +/home/user1/dir/file \[->] remote:backup/user1/dir/file +/home/user2/stuff \[->] remote:backup/user2/stuff +\f[R] .fi .PP -You could of course choose \f[C]/\f[] as the root too in which case your -\f[C]files\-from.txt\f[] might look like this. +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. .IP .nf \f[C] /home/user1/important /home/user1/dir/file /home/user2/stuff -\f[] +\f[R] .fi .PP And you would transfer it like this .IP .nf \f[C] -rclone\ copy\ \-\-files\-from\ files\-from.txt\ /\ remote:backup -\f[] +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[] directory on the +In this case 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 -\f[] +/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 +\f[R] .fi -.SS \f[C]\-\-min\-size\f[] \- Don't transfer any file smaller than this +.SS \f[C]\-\-min\-size\f[R] \- Don\[cq]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[] but a suffix of \f[C]k\f[], \f[C]M\f[], -or \f[C]G\f[] can be used. +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. .PP -For example \f[C]\-\-min\-size\ 50k\f[] means no files smaller than +For example \f[C]\-\-min\-size 50k\f[R] means no files smaller than 50kByte will be transferred. -.SS \f[C]\-\-max\-size\f[] \- Don't transfer any file larger than this +.SS \f[C]\-\-max\-size\f[R] \- Don\[cq]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[] but a suffix of \f[C]k\f[], \f[C]M\f[], -or \f[C]G\f[] can be used. +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. .PP -For example \f[C]\-\-max\-size\ 1G\f[] means no files larger than 1GByte +For example \f[C]\-\-max\-size 1G\f[R] means no files larger than 1GByte will be transferred. -.SS \f[C]\-\-max\-age\f[] \- Don't transfer any file older than this +.SS \f[C]\-\-max\-age\f[R] \- Don\[cq]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: .IP \[bu] 2 -\f[C]ms\f[] \- Milliseconds +\f[C]ms\f[R] \- Milliseconds .IP \[bu] 2 -\f[C]s\f[] \- Seconds +\f[C]s\f[R] \- Seconds .IP \[bu] 2 -\f[C]m\f[] \- Minutes +\f[C]m\f[R] \- Minutes .IP \[bu] 2 -\f[C]h\f[] \- Hours +\f[C]h\f[R] \- Hours .IP \[bu] 2 -\f[C]d\f[] \- Days +\f[C]d\f[R] \- Days .IP \[bu] 2 -\f[C]w\f[] \- Weeks +\f[C]w\f[R] \- Weeks .IP \[bu] 2 -\f[C]M\f[] \- Months +\f[C]M\f[R] \- Months .IP \[bu] 2 -\f[C]y\f[] \- Years +\f[C]y\f[R] \- Years .PP -For example \f[C]\-\-max\-age\ 2d\f[] means no files older than 2 days +For example \f[C]\-\-max\-age 2d\f[R] means no files older than 2 days will be transferred. -.SS \f[C]\-\-min\-age\f[] \- Don't transfer any file younger than this +.SS \f[C]\-\-min\-age\f[R] \- Don\[cq]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[] for list of +Give in seconds or with a suffix (see \f[C]\-\-max\-age\f[R] for list of suffixes) .PP -For example \f[C]\-\-min\-age\ 2d\f[] means no files younger than 2 days +For example \f[C]\-\-min\-age 2d\f[R] means no files younger than 2 days will be transferred. -.SS \f[C]\-\-delete\-excluded\f[] \- Delete files on dest excluded from -sync +.SS \f[C]\-\-delete\-excluded\f[R] \- Delete files on dest excluded from sync .PP -\f[B]Important\f[] this flag is dangerous \- use with -\f[C]\-\-dry\-run\f[] and \f[C]\-v\f[] first. +\f[B]Important\f[R] this flag is dangerous \- use with +\f[C]\-\-dry\-run\f[R] and \f[C]\-v\f[R] first. .PP -When doing \f[C]rclone\ sync\f[] this will delete any files which are +When doing \f[C]rclone sync\f[R] this will delete any files which are excluded from the sync on the destination. .PP -If for example you did a sync from \f[C]A\f[] to \f[C]B\f[] without the -\f[C]\-\-min\-size\ 50k\f[] flag +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\ A:\ B: -\f[] +rclone sync A: B: +\f[R] .fi .PP -Then you repeated it like this with the \f[C]\-\-delete\-excluded\f[] +Then you repeated it like this with the \f[C]\-\-delete\-excluded\f[R] .IP .nf \f[C] -rclone\ \-\-min\-size\ 50k\ \-\-delete\-excluded\ sync\ A:\ B: -\f[] +rclone \-\-min\-size 50k \-\-delete\-excluded sync A: B: +\f[R] .fi .PP -This would delete all files on \f[C]B\f[] which are less than 50 kBytes +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[] and \f[C]\-v\f[] before +Always test first with \f[C]\-\-dry\-run\f[R] and \f[C]\-v\f[R] before using this flag. -.SS \f[C]\-\-dump\ filters\f[] \- dump the filters to the output +.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. .PP Useful for debugging. -.SS \f[C]\-\-ignore\-case\f[] \- make searches case insensitive +.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\ "file.txt"\f[] will not match a file called -\f[C]FILE.txt\f[]. -However if you use the \f[C]\-\-ignore\-case\f[] flag then -\f[C]\-\-include\ "file.txt"\f[] this will match a file called -\f[C]FILE.txt\f[]. +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[]), and may require quoting. +shell metacharacters in them (eg \f[C]*\f[R]), and may require quoting. .PP Eg linux, OSX .IP \[bu] 2 -\f[C]\-\-include\ \\*.jpg\f[] +\f[C]\-\-include \[rs]*.jpg\f[R] .IP \[bu] 2 -\f[C]\-\-include\ \[aq]*.jpg\[aq]\f[] +\f[C]\-\-include \[aq]*.jpg\[aq]\f[R] .IP \[bu] 2 -\f[C]\-\-include=\[aq]*.jpg\[aq]\f[] +\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[] +\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[] -flag. +Filename should be specified using the +\f[C]\-\-exclude\-if\-present\f[R] flag. This flag has a priority over the other filtering flags. .PP Imagine, you have the following directory structure: @@ -7838,20 +8080,21 @@ dir1/file1 dir1/dir2/file2 dir1/dir2/dir3/file3 dir1/dir2/dir3/.ignore -\f[] +\f[R] .fi .PP -You can exclude \f[C]dir3\f[] from sync by running the following +You can exclude \f[C]dir3\f[R] from sync by running the following command: .IP .nf \f[C] -rclone\ sync\ \-\-exclude\-if\-present\ .ignore\ dir1\ remote:backup -\f[] +rclone sync \-\-exclude\-if\-present .ignore dir1 remote:backup +\f[R] .fi .PP -Currently only one filename is supported, i.e. -\f[C]\-\-exclude\-if\-present\f[] should not be used multiple times. +Currently only one filename is supported, +i.e.\ \f[C]\-\-exclude\-if\-present\f[R] should not be used multiple +times. .SH GUI (Experimental) .PP Rclone can serve a web based GUI (graphical user interface). @@ -7863,8 +8106,8 @@ the GUI in a web browser. .IP .nf \f[C] -rclone\ rcd\ \-\-rc\-web\-gui -\f[] +rclone rcd \-\-rc\-web\-gui +\f[R] .fi .PP This will produce logs like this and rclone needs to continue to run to @@ -7872,19 +8115,26 @@ serve the GUI: .IP .nf \f[C] -2019/08/25\ 11:40:14\ NOTICE:\ A\ new\ release\ for\ gui\ is\ present\ at\ https://github.com/rclone/rclone\-webui\-react/releases/download/v0.0.6/currentbuild.zip -2019/08/25\ 11:40:14\ NOTICE:\ Downloading\ webgui\ binary.\ Please\ wait.\ [Size:\ 3813937,\ Path\ :\ \ /home/USER/.cache/rclone/webgui/v0.0.6.zip] -2019/08/25\ 11:40:16\ NOTICE:\ Unzipping -2019/08/25\ 11:40:16\ NOTICE:\ Serving\ remote\ control\ on\ http://127.0.0.1:5572/ -\f[] +2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/rclone/rclone\-webui\-react/releases/download/v0.0.6/currentbuild.zip +2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path : /home/USER/.cache/rclone/webgui/v0.0.6.zip] +2019/08/25 11:40:16 NOTICE: Unzipping +2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/ +\f[R] .fi .PP This assumes you are running rclone locally on your machine. It is possible to separate the rclone and the GUI \- see below for details. .PP -If you wish to update to the latest API version then you can add -\f[C]\-\-rc\-web\-gui\-update\f[] to the command line. +If you wish to check for updates then you can add +\f[C]\-\-rc\-web\-gui\-update\f[R] to the command line. +.PP +If you find your GUI broken, you may force it to update by add +\f[C]\-\-rc\-web\-gui\-force\-update\f[R]. +.PP +By default, rclone will open your browser. +Add \f[C]\-\-rc\-web\-gui\-no\-open\-browser\f[R] to disable this +feature. .SS Using the GUI .PP Once the GUI opens, you will be looking at the dashboard which has an @@ -7906,7 +8156,7 @@ Log out (More docs and walkthrough video to come!) .SS How it works .PP -When you run the \f[C]rclone\ rcd\ \-\-rc\-web\-gui\f[] this is what +When you run the \f[C]rclone rcd \-\-rc\-web\-gui\f[R] this is what happens .IP \[bu] 2 Rclone starts but only runs the remote control API (\[lq]rc\[rq]). @@ -7919,24 +8169,24 @@ If the API bundle is missing then rclone will download it. rclone will start serving the files from the API bundle over the same port as the API .IP \[bu] 2 -rclone will open the browser with a \f[C]login_token\f[] so it can log +rclone will open the browser with a \f[C]login_token\f[R] so it can log straight in. .SS Advanced use .PP -The \f[C]rclone\ rcd\f[] may use any of the flags documented on the rc +The \f[C]rclone rcd\f[R] may use any of the flags documented on the rc page (https://rclone.org/rc/#supported-parameters). .PP -The flag \f[C]\-\-rc\-web\-gui\f[] is shorthand for +The flag \f[C]\-\-rc\-web\-gui\f[R] is shorthand for .IP \[bu] 2 Download the web GUI if necessary .IP \[bu] 2 Check we are using some authentication .IP \[bu] 2 -\f[C]\-\-rc\-user\ gui\f[] +\f[C]\-\-rc\-user gui\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-pass\ \f[] +\f[C]\-\-rc\-pass \f[R] .IP \[bu] 2 -\f[C]\-\-rc\-serve\f[] +\f[C]\-\-rc\-serve\f[R] .PP These flags can be overidden as desired. .PP @@ -7947,49 +8197,49 @@ documentation (https://rclone.org/commands/rclone_rcd/). For example the GUI could be served on a public port over SSL using an htpasswd file using the following flags: .IP \[bu] 2 -\f[C]\-\-rc\-web\-gui\f[] +\f[C]\-\-rc\-web\-gui\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-addr\ :443\f[] +\f[C]\-\-rc\-addr :443\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-htpasswd\ /path/to/htpasswd\f[] +\f[C]\-\-rc\-htpasswd /path/to/htpasswd\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-cert\ /path/to/ssl.crt\f[] +\f[C]\-\-rc\-cert /path/to/ssl.crt\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-key\ /path/to/ssl.key\f[] +\f[C]\-\-rc\-key /path/to/ssl.key\f[R] .SS Example: Running a GUI behind a proxy .PP -If you want to run the GUI behind a proxy at \f[C]/rclone\f[] you could +If you want to run the GUI behind a proxy at \f[C]/rclone\f[R] you could use these flags: .IP \[bu] 2 -\f[C]\-\-rc\-web\-gui\f[] +\f[C]\-\-rc\-web\-gui\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-baseurl\ rclone\f[] +\f[C]\-\-rc\-baseurl rclone\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-htpasswd\ /path/to/htpasswd\f[] +\f[C]\-\-rc\-htpasswd /path/to/htpasswd\f[R] .PP Or instead of htpassword if you just want a single user and password: .IP \[bu] 2 -\f[C]\-\-rc\-user\ me\f[] +\f[C]\-\-rc\-user me\f[R] .IP \[bu] 2 -\f[C]\-\-rc\-pass\ mypassword\f[] +\f[C]\-\-rc\-pass mypassword\f[R] .SS Project .PP The GUI is being developed in the: rclone/rclone\-webui\-react respository (https://github.com/rclone/rclone-webui-react). .PP -Bug reports and contributions very welcome welcome :\-) +Bug reports and contributions are very welcome :\-) .PP If you have questions then please ask them on the rclone forum (https://forum.rclone.org/). .SH Remote controlling rclone .PP -If rclone is run with the \f[C]\-\-rc\f[] 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. .PP If you just want to run a remote control then see the rcd command (https://rclone.org/commands/rclone_rcd/). .PP -\f[B]NB\f[] this is experimental and everything here is subject to +\f[B]NB\f[R] this is experimental and everything here is subject to change! .SS Supported parameters .SS \[en]rc @@ -8047,9 +8297,9 @@ If this is set then rclone will serve the files in that directory. It will also open the root in the web browser if specified. This is for implementing browser based GUIs for rclone functions. .PP -If \f[C]\-\-rc\-user\f[] or \f[C]\-\-rc\-pass\f[] is set then the URL +If \f[C]\-\-rc\-user\f[R] or \f[C]\-\-rc\-pass\f[R] is set then the URL that is opened will have the authorization in the URL in the -\f[C]http://user:pass\@localhost/\f[] style. +\f[C]http://user:pass\[at]localhost/\f[R] style. .PP Default Off. .SS \[en]rc\-web\-gui @@ -8073,10 +8323,22 @@ Default https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest. .SS \[en]rc\-web\-gui\-update .PP -Set this flag to Download / Force update rclone\-webui\-react from the +Set this flag to check and update rclone\-webui\-react from the rc\-web\-fetch\-url. .PP Default Off. +.SS \[en]rc\-web\-gui\-force\-update +.PP +Set this flag to force update rclone\-webui\-react from the +rc\-web\-fetch\-url. +.PP +Default Off. +.SS \[en]rc\-web\-gui\-no\-open\-browser +.PP +Set this flag to disable opening browser automatically when using +web\-gui. +.PP +Default Off. .SS \[en]rc\-job\-expire\-duration=DURATION .PP Expire finished async jobs older than DURATION (default 60s). @@ -8088,155 +8350,156 @@ Interval duration to check for expired async jobs (default 10s). By default rclone will require authorisation to have been set up on the rc interface in order to use any methods which access any rclone remotes. -Eg \f[C]operations/list\f[] is denied as it involved creating a remote -as is \f[C]sync/copy\f[]. +Eg \f[C]operations/list\f[R] is denied as it involved creating a remote +as is \f[C]sync/copy\f[R]. .PP If this is set then no authorisation will be required on the server to use these methods. -The alternative is to use \f[C]\-\-rc\-user\f[] and -\f[C]\-\-rc\-pass\f[] and use these credentials in the request. +The alternative is to use \f[C]\-\-rc\-user\f[R] and +\f[C]\-\-rc\-pass\f[R] and use these credentials in the request. .PP Default Off. .SS Accessing the remote control via the rclone rc command .PP Rclone itself implements the remote control protocol in its -\f[C]rclone\ rc\f[] command. +\f[C]rclone rc\f[R] command. .PP You can use it like this .IP .nf \f[C] -$\ rclone\ rc\ rc/noop\ param1=one\ param2=two +$ rclone rc rc/noop param1=one param2=two { -\ \ \ \ "param1":\ "one", -\ \ \ \ "param2":\ "two" + \[dq]param1\[dq]: \[dq]one\[dq], + \[dq]param2\[dq]: \[dq]two\[dq] } -\f[] +\f[R] .fi .PP -Run \f[C]rclone\ rc\f[] on its own to see the help for the installed +Run \f[C]rclone rc\f[R] on its own to see the help for the installed remote control commands. .PP -\f[C]rclone\ rc\f[] also supports a \f[C]\-\-json\f[] flag which can be +\f[C]rclone rc\f[R] also supports a \f[C]\-\-json\f[R] flag which can be used to send more complicated input parameters. .IP .nf \f[C] -$\ rclone\ rc\ \-\-json\ \[aq]{\ "p1":\ [1,"2",null,4],\ "p2":\ {\ "a":1,\ "b":2\ }\ }\[aq]\ rc/noop +$ rclone rc \-\-json \[aq]{ \[dq]p1\[dq]: [1,\[dq]2\[dq],null,4], \[dq]p2\[dq]: { \[dq]a\[dq]:1, \[dq]b\[dq]:2 } }\[aq] rc/noop { -\ \ \ \ "p1":\ [ -\ \ \ \ \ \ \ \ 1, -\ \ \ \ \ \ \ \ "2", -\ \ \ \ \ \ \ \ null, -\ \ \ \ \ \ \ \ 4 -\ \ \ \ ], -\ \ \ \ "p2":\ { -\ \ \ \ \ \ \ \ "a":\ 1, -\ \ \ \ \ \ \ \ "b":\ 2 -\ \ \ \ } + \[dq]p1\[dq]: [ + 1, + \[dq]2\[dq], + null, + 4 + ], + \[dq]p2\[dq]: { + \[dq]a\[dq]: 1, + \[dq]b\[dq]: 2 + } } -\f[] +\f[R] .fi .SS Special parameters .PP The rc interface supports some special parameters which apply to -\f[B]all\f[] commands. -These start with \f[C]_\f[] to show they are different. +\f[B]all\f[R] commands. +These start with \f[C]_\f[R] to show they are different. .SS Running asynchronous jobs with _async = true .PP Each rc call is classified as a job and it is assigned its own id. By default jobs are executed immediately as they are created or synchronously. .PP -If \f[C]_async\f[] has a true value when supplied to an rc call then it +If \f[C]_async\f[R] has a true value when supplied to an rc call then it will return immediately with a job id and the task will be run in the background. -The \f[C]job/status\f[] call can be used to get information of the +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 -\f[C]sync/sync\f[], \f[C]sync/copy\f[], \f[C]sync/move\f[], -\f[C]operations/purge\f[] are run with the \f[C]_async\f[] flag to avoid -any potential problems with the HTTP request and response timing out. +\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 +out. .PP -Starting a job with the \f[C]_async\f[] flag: +Starting a job with the \f[C]_async\f[R] flag: .IP .nf \f[C] -$\ rclone\ rc\ \-\-json\ \[aq]{\ "p1":\ [1,"2",null,4],\ "p2":\ {\ "a":1,\ "b":2\ },\ "_async":\ true\ }\[aq]\ rc/noop +$ rclone rc \-\-json \[aq]{ \[dq]p1\[dq]: [1,\[dq]2\[dq],null,4], \[dq]p2\[dq]: { \[dq]a\[dq]:1, \[dq]b\[dq]:2 }, \[dq]_async\[dq]: true }\[aq] rc/noop { -\ \ \ \ "jobid":\ 2 + \[dq]jobid\[dq]: 2 } -\f[] +\f[R] .fi .PP Query the status to see if the job has finished. For more information on the meaning of these return parameters see the -\f[C]job/status\f[] call. +\f[C]job/status\f[R] call. .IP .nf \f[C] -$\ rclone\ rc\ \-\-json\ \[aq]{\ "jobid":2\ }\[aq]\ job/status +$ rclone rc \-\-json \[aq]{ \[dq]jobid\[dq]:2 }\[aq] job/status { -\ \ \ \ "duration":\ 0.000124163, -\ \ \ \ "endTime":\ "2018\-10\-27T11:38:07.911245881+01:00", -\ \ \ \ "error":\ "", -\ \ \ \ "finished":\ true, -\ \ \ \ "id":\ 2, -\ \ \ \ "output":\ { -\ \ \ \ \ \ \ \ "_async":\ true, -\ \ \ \ \ \ \ \ "p1":\ [ -\ \ \ \ \ \ \ \ \ \ \ \ 1, -\ \ \ \ \ \ \ \ \ \ \ \ "2", -\ \ \ \ \ \ \ \ \ \ \ \ null, -\ \ \ \ \ \ \ \ \ \ \ \ 4 -\ \ \ \ \ \ \ \ ], -\ \ \ \ \ \ \ \ "p2":\ { -\ \ \ \ \ \ \ \ \ \ \ \ "a":\ 1, -\ \ \ \ \ \ \ \ \ \ \ \ "b":\ 2 -\ \ \ \ \ \ \ \ } -\ \ \ \ }, -\ \ \ \ "startTime":\ "2018\-10\-27T11:38:07.911121728+01:00", -\ \ \ \ "success":\ true + \[dq]duration\[dq]: 0.000124163, + \[dq]endTime\[dq]: \[dq]2018\-10\-27T11:38:07.911245881+01:00\[dq], + \[dq]error\[dq]: \[dq]\[dq], + \[dq]finished\[dq]: true, + \[dq]id\[dq]: 2, + \[dq]output\[dq]: { + \[dq]_async\[dq]: true, + \[dq]p1\[dq]: [ + 1, + \[dq]2\[dq], + null, + 4 + ], + \[dq]p2\[dq]: { + \[dq]a\[dq]: 1, + \[dq]b\[dq]: 2 + } + }, + \[dq]startTime\[dq]: \[dq]2018\-10\-27T11:38:07.911121728+01:00\[dq], + \[dq]success\[dq]: true } -\f[] +\f[R] .fi .PP -\f[C]job/list\f[] can be used to show the running or recently completed +\f[C]job/list\f[R] can be used to show the running or recently completed jobs .IP .nf \f[C] -$\ rclone\ rc\ job/list +$ rclone rc job/list { -\ \ \ \ "jobids":\ [ -\ \ \ \ \ \ \ \ 2 -\ \ \ \ ] + \[dq]jobids\[dq]: [ + 2 + ] } -\f[] +\f[R] .fi -.SS Assigning operations to groups with _group = +.SS Assigning operations to groups with _group = .PP -Each rc call has it's own stats group for tracking it's metrics. +Each rc call has it\[cq]s own stats group for tracking it\[cq]s metrics. By default grouping is done by the composite group name from prefix -\f[C]job/\f[] and id of the job like so \f[C]job/1\f[]. +\f[C]job/\f[R] and id of the job like so \f[C]job/1\f[R]. .PP -If \f[C]_group\f[] has a value then stats for that request will be +If \f[C]_group\f[R] has a value then stats for that request will be grouped under that value. This allows caller to group stats under their own name. .PP -Stats for specific group can be accessed by passing \f[C]group\f[] to -\f[C]core/stats\f[]: +Stats for specific group can be accessed by passing \f[C]group\f[R] to +\f[C]core/stats\f[R]: .IP .nf \f[C] -$\ rclone\ rc\ \-\-json\ \[aq]{\ "group":\ "job/1"\ }\[aq]\ core/stats +$ rclone rc \-\-json \[aq]{ \[dq]group\[dq]: \[dq]job/1\[dq] }\[aq] core/stats { -\ \ \ \ "speed":\ 12345 -\ \ \ \ ... + \[dq]speed\[dq]: 12345 + ... } -\f[] +\f[R] .fi .SS Supported commands .SS cache/expire: Purge a remote from cache {#cache/expire} @@ -8250,9 +8513,9 @@ Eg .IP .nf \f[C] -rclone\ rc\ cache/expire\ remote=path/to/sub/folder/ -rclone\ rc\ cache/expire\ remote=/\ withData=true -\f[] +rclone rc cache/expire remote=path/to/sub/folder/ +rclone rc cache/expire remote=/ withData=true +\f[R] .fi .SS cache/fetch: Fetch file chunks {#cache/fetch} .PP @@ -8279,8 +8542,8 @@ specify files to fetch, eg .IP .nf \f[C] -rclone\ rc\ cache/fetch\ chunks=0\ file=hello\ file2=home/goodbye -\f[] +rclone rc cache/fetch chunks=0 file=hello file2=home/goodbye +\f[R] .fi .PP File names will automatically be encrypted when the a crypt remote is @@ -8327,15 +8590,16 @@ more information on the above. Authentication is required for this call. .SS config/get: Get a remote in the config file. {#config/get} .PP -Parameters: \- name \- name of remote to get +Parameters: +.IP \[bu] 2 +name \- name of remote to get .PP See the config dump command (https://rclone.org/commands/rclone_config_dump/) command for more information on the above. .PP Authentication is required for this call. -.SS config/listremotes: Lists the remotes in the config file. -{#config/listremotes} +.SS config/listremotes: Lists the remotes in the config file. {#config/listremotes} .PP Returns \- remotes \- array of remote names .PP @@ -8344,8 +8608,7 @@ command (https://rclone.org/commands/rclone_listremotes/) command for more information on the above. .PP Authentication is required for this call. -.SS config/password: password the config for a remote. -{#config/password} +.SS config/password: password the config for a remote. {#config/password} .PP This takes the following parameters .IP \[bu] 2 @@ -8358,8 +8621,7 @@ command (https://rclone.org/commands/rclone_config_password/) command for more information on the above. .PP Authentication is required for this call. -.SS config/providers: Shows how providers are configured in the config -file. {#config/providers} +.SS config/providers: Shows how providers are configured in the config file. {#config/providers} .PP Returns a JSON object: \- providers \- array of objects .PP @@ -8389,29 +8651,29 @@ Eg .IP .nf \f[C] -rclone\ rc\ core/bwlimit\ rate=off +rclone rc core/bwlimit rate=off { -\ \ \ \ "bytesPerSecond":\ \-1, -\ \ \ \ "rate":\ "off" + \[dq]bytesPerSecond\[dq]: \-1, + \[dq]rate\[dq]: \[dq]off\[dq] } -rclone\ rc\ core/bwlimit\ rate=1M +rclone rc core/bwlimit rate=1M { -\ \ \ \ "bytesPerSecond":\ 1048576, -\ \ \ \ "rate":\ "1M" + \[dq]bytesPerSecond\[dq]: 1048576, + \[dq]rate\[dq]: \[dq]1M\[dq] } -\f[] +\f[R] .fi .PP If the rate parameter is not suppied then the bandwidth is queried .IP .nf \f[C] -rclone\ rc\ core/bwlimit +rclone rc core/bwlimit { -\ \ \ \ "bytesPerSecond":\ 1048576, -\ \ \ \ "rate":\ "1M" + \[dq]bytesPerSecond\[dq]: 1048576, + \[dq]rate\[dq]: \[dq]1M\[dq] } -\f[] +\f[R] .fi .PP The format of the parameter is exactly the same as passed to @@ -8422,7 +8684,7 @@ and \[lq]bytesPerSecond\[rq] is returned as a number. .SS core/gc: Runs a garbage collection. {#core/gc} .PP 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 +It isn\[cq]t necessary to call this normally, but it can be useful for debugging memory problems. .SS core/group\-list: Returns list of stats. {#core/group\-list} .PP @@ -8433,14 +8695,14 @@ Returns the following values: .nf \f[C] { -\ \ \ \ "groups":\ \ an\ array\ of\ group\ names: -\ \ \ \ \ \ \ \ [ -\ \ \ \ \ \ \ \ \ \ \ \ "group1", -\ \ \ \ \ \ \ \ \ \ \ \ "group2", -\ \ \ \ \ \ \ \ \ \ \ \ ... -\ \ \ \ \ \ \ \ ] + \[dq]groups\[dq]: an array of group names: + [ + \[dq]group1\[dq], + \[dq]group2\[dq], + ... + ] } -\f[] +\f[R] .fi .SS core/memstats: Returns the memory statistics {#core/memstats} .PP @@ -8479,8251 +8741,13196 @@ This returns all available stats: .IP .nf \f[C] -rclone\ rc\ core/stats -\f[] +rclone rc core/stats +\f[R] .fi .PP If group is not provided then summed up stats for all groups will be returned. .PP -Parameters \- group \- name of the stats group (string) +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) .PP Returns the following values: .IP .nf \f[C] { -\ \ \ \ "speed":\ average\ speed\ in\ bytes/sec\ since\ start\ of\ the\ process, -\ \ \ \ "bytes":\ total\ transferred\ bytes\ since\ the\ start\ of\ the\ process, -\ \ \ \ "errors":\ number\ of\ errors, -\ \ \ \ "fatalError":\ whether\ there\ has\ been\ at\ least\ one\ FatalError, -\ \ \ \ "retryError":\ whether\ there\ has\ been\ at\ least\ one\ non\-NoRetryError, -\ \ \ \ "checks":\ number\ of\ checked\ files, -\ \ \ \ "transfers":\ number\ of\ transferred\ files, -\ \ \ \ "deletes"\ :\ number\ of\ deleted\ files, -\ \ \ \ "elapsedTime":\ time\ in\ seconds\ since\ the\ start\ of\ the\ process, -\ \ \ \ "lastError":\ last\ occurred\ error, -\ \ \ \ "transferring":\ an\ array\ of\ currently\ active\ file\ transfers: -\ \ \ \ \ \ \ \ [ -\ \ \ \ \ \ \ \ \ \ \ \ { -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "bytes":\ total\ transferred\ bytes\ for\ this\ file, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "eta":\ estimated\ time\ in\ seconds\ until\ file\ transfer\ completion -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "name":\ name\ of\ the\ file, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "percentage":\ progress\ of\ the\ file\ transfer\ in\ percent, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "speed":\ speed\ in\ bytes/sec, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "speedAvg":\ speed\ in\ bytes/sec\ as\ an\ exponentially\ weighted\ moving\ average, -\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ "size":\ size\ of\ the\ file\ in\ bytes -\ \ \ \ \ \ \ \ \ \ \ \ } -\ \ \ \ \ \ \ \ ], -\ \ \ \ "checking":\ an\ array\ of\ names\ of\ currently\ active\ file\ checks -\ \ \ \ \ \ \ \ [] + \[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]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]: speed in bytes/sec, + \[dq]speedAvg\[dq]: 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[] +\f[R] .fi .PP Values for \[lq]transferring\[rq], \[lq]checking\[rq] and \[lq]lastError\[rq] are only assigned if data is available. The value for \[lq]eta\[rq] is null if an eta cannot be determined. +.SS core/stats\-delete: Delete stats group. {#core/stats\-delete} +.PP +This deletes entire stats group +.PP +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) .SS core/stats\-reset: Reset stats. {#core/stats\-reset} .PP -This clears counters and errors for all stats or specific stats group if -group is provided. +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) +Parameters +.IP \[bu] 2 +group \- name of the stats group (string) +.SS core/transferred: Returns stats about completed transfers. {#core/transferred} +.PP +This returns stats about completed transfers: .IP .nf \f[C] - -###\ 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 +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[] -.fi .PP -{ \[lq]transferred\[rq]: an array of completed transfers (including -failed ones): [ { \[lq]name\[rq]: name of the file, \[lq]size\[rq]: size -of the file in bytes, \[lq]bytes\[rq]: total transferred bytes for this -file, \[lq]checked\[rq]: if the transfer is only checked (skipped, -deleted), \[lq]timestamp\[rq]: integer representing millisecond unix -epoch, \[lq]error\[rq]: string description of the error (empty if -successfull), \[lq]jobid\[rq]: id of the job that this transfer belongs -to } ] } +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} - -This\ shows\ the\ current\ version\ of\ go\ and\ the\ go\ runtime -\-\ version\ \-\ rclone\ version,\ eg\ "v1.44" -\-\ decomposed\ \-\ version\ number\ as\ [major,\ minor,\ patch,\ subpatch] -\ \ \ \ \-\ note\ patch\ and\ subpatch\ will\ be\ 999\ for\ a\ git\ compiled\ version -\-\ isGit\ \-\ boolean\ \-\ true\ if\ this\ was\ compiled\ from\ the\ git\ version -\-\ os\ \-\ OS\ in\ use\ as\ according\ to\ Go -\-\ arch\ \-\ cpu\ architecture\ in\ use\ according\ to\ Go -\-\ goVersion\ \-\ version\ of\ Go\ runtime\ in\ use - -###\ job/list:\ Lists\ the\ IDs\ of\ the\ running\ jobs\ {#job/list} - -Parameters\ \-\ None - +{ + \[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 successfull), + \[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. {#core/version} +.PP +This shows the current version of go and the go runtime +.IP \[bu] 2 +version \- rclone version, eg \[lq]v1.44\[rq] +.IP \[bu] 2 +decomposed \- version number as [major, minor, patch, subpatch] +.RS 2 +.IP \[bu] 2 +note patch and subpatch will be 999 for a git compiled version +.RE +.IP \[bu] 2 +isGit \- boolean \- true if this was compiled from the git 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. {#debug/set\-block\-profile\-rate} +.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. +.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: +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/block +\f[R] +.fi +.PP +Parameters +.IP \[bu] 2 +rate \- int +.SS debug/set\-mutex\-profile\-fraction: Set runtime.SetMutexProfileFraction for mutex profiling. {#debug/set\-mutex\-profile\-fraction} +.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: +.IP +.nf +\f[C] +go tool pprof http://localhost:5572/debug/pprof/mutex +\f[R] +.fi +.PP +Parameters +.IP \[bu] 2 +rate \- int +.PP 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) - +.IP \[bu] 2 +previousRate \- int +.SS job/list: Lists the IDs of the running jobs {#job/list} +.PP +Parameters \- None +.PP 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} - +.IP \[bu] 2 +jobids \- array of integer job ids +.SS job/status: Reads the status of the job ID {#job/status} +.PP Parameters -\-\ jobid\ \-\ id\ of\ the\ job\ (integer) - -###\ operations/about:\ Return\ the\ space\ used\ on\ the\ remote\ {#operations/about} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" - -The\ result\ is\ as\ returned\ from\ rclone\ about\ \-\-json - -See\ the\ [about\ command](https://rclone.org/commands/rclone_size/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/cleanup:\ Remove\ trashed\ files\ in\ the\ remote\ or\ path\ {#operations/cleanup} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" - -See\ the\ [cleanup\ command](https://rclone.org/commands/rclone_cleanup/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/copyfile:\ Copy\ a\ file\ from\ source\ remote\ to\ destination\ remote\ {#operations/copyfile} - -This\ takes\ the\ following\ parameters - -\-\ srcFs\ \-\ a\ remote\ name\ string\ eg\ "drive:"\ for\ the\ source -\-\ srcRemote\ \-\ a\ path\ within\ that\ remote\ eg\ "file.txt"\ for\ the\ source -\-\ dstFs\ \-\ a\ remote\ name\ string\ eg\ "drive2:"\ for\ the\ destination -\-\ dstRemote\ \-\ a\ path\ within\ that\ remote\ eg\ "file2.txt"\ for\ the\ destination - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/copyurl:\ Copy\ the\ URL\ to\ the\ object\ {#operations/copyurl} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" -\-\ url\ \-\ string,\ URL\ to\ read\ from -\ \-\ autoFilename\ \-\ boolean,\ set\ to\ true\ to\ retrieve\ destination\ file\ name\ from\ url -See\ the\ [copyurl\ command](https://rclone.org/commands/rclone_copyurl/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/delete:\ Remove\ files\ in\ the\ path\ {#operations/delete} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" - -See\ the\ [delete\ command](https://rclone.org/commands/rclone_delete/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/deletefile:\ Remove\ the\ single\ file\ pointed\ to\ {#operations/deletefile} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" - -See\ the\ [deletefile\ command](https://rclone.org/commands/rclone_deletefile/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/fsinfo:\ Return\ information\ about\ the\ remote\ {#operations/fsinfo} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" - -This\ returns\ info\ about\ the\ remote\ passed\ in; -\f[] -.fi +.IP \[bu] 2 +jobid \- id of the job (integer) +.PP +Results +.IP \[bu] 2 +finished \- boolean +.IP \[bu] 2 +duration \- time in seconds that the job ran for +.IP \[bu] 2 +endTime \- time the job finished (eg +\[lq]2018\-10\-26T18:50:20.528746884+01:00\[rq]) +.IP \[bu] 2 +error \- error from the job or empty string for no error +.IP \[bu] 2 +finished \- boolean whether the job has finished or not +.IP \[bu] 2 +id \- as passed in above +.IP \[bu] 2 +startTime \- time the job started (eg +\[lq]2018\-10\-26T18:50:20.528336039+01:00\[rq]) +.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 {#job/stop} .PP -{ // optional features and whether they are available or not -\[lq]Features\[rq]: { \[lq]About\[rq]: true, \[lq]BucketBased\[rq]: -false, \[lq]CanHaveEmptyDirectories\[rq]: true, -\[lq]CaseInsensitive\[rq]: false, \[lq]ChangeNotify\[rq]: false, -\[lq]CleanUp\[rq]: false, \[lq]Copy\[rq]: false, -\[lq]DirCacheFlush\[rq]: false, \[lq]DirMove\[rq]: true, -\[lq]DuplicateFiles\[rq]: false, \[lq]GetTier\[rq]: false, -\[lq]ListR\[rq]: false, \[lq]MergeDirs\[rq]: false, \[lq]Move\[rq]: -true, \[lq]OpenWriterAt\[rq]: true, \[lq]PublicLink\[rq]: false, -\[lq]Purge\[rq]: true, \[lq]PutStream\[rq]: true, -\[lq]PutUnchecked\[rq]: false, \[lq]ReadMimeType\[rq]: false, -\[lq]ServerSideAcrossConfigs\[rq]: false, \[lq]SetTier\[rq]: false, -\[lq]SetWrapper\[rq]: false, \[lq]UnWrap\[rq]: false, \[lq]WrapFs\[rq]: -false, \[lq]WriteMimeType\[rq]: false }, // Names of hashes available -\[lq]Hashes\[rq]: [ \[lq]MD5\[rq], \[lq]SHA\-1\[rq], -\[lq]DropboxHash\[rq], \[lq]QuickXorHash\[rq] ], \[lq]Name\[rq]: -\[lq]local\[rq], // Name as created \[lq]Precision\[rq]: 1, // Precision -of timestamps in ns \[lq]Root\[rq]: \[lq]/\[rq], // Path as created -\[lq]String\[rq]: \[lq]Local file system at /\[rq] // how the remote -will appear in logs } -.IP -.nf -\f[C] - -This\ command\ does\ not\ have\ a\ command\ line\ equivalent\ so\ use\ this\ instead: - -\ \ \ \ rclone\ rc\ \-\-loopback\ operations/fsinfo\ fs=remote: - -###\ operations/list:\ List\ the\ given\ remote\ and\ path\ in\ JSON\ format\ {#operations/list} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" -\-\ opt\ \-\ a\ dictionary\ of\ options\ to\ control\ the\ listing\ (optional) -\ \ \ \ \-\ recurse\ \-\ If\ set\ recurse\ directories -\ \ \ \ \-\ noModTime\ \-\ If\ set\ return\ modification\ time -\ \ \ \ \-\ showEncrypted\ \-\ \ If\ set\ show\ decrypted\ names -\ \ \ \ \-\ showOrigIDs\ \-\ If\ set\ show\ the\ IDs\ for\ each\ item\ if\ known -\ \ \ \ \-\ showHash\ \-\ If\ set\ return\ a\ dictionary\ of\ hashes - -The\ result\ is - -\-\ list -\ \ \ \ \-\ This\ is\ an\ array\ of\ objects\ as\ described\ in\ the\ lsjson\ command - -See\ the\ [lsjson\ command](https://rclone.org/commands/rclone_lsjson/)\ for\ more\ information\ on\ the\ above\ and\ examples. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/mkdir:\ Make\ a\ destination\ directory\ or\ container\ {#operations/mkdir} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" - -See\ the\ [mkdir\ command](https://rclone.org/commands/rclone_mkdir/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/movefile:\ Move\ a\ file\ from\ source\ remote\ to\ destination\ remote\ {#operations/movefile} - -This\ takes\ the\ following\ parameters - -\-\ srcFs\ \-\ a\ remote\ name\ string\ eg\ "drive:"\ for\ the\ source -\-\ srcRemote\ \-\ a\ path\ within\ that\ remote\ eg\ "file.txt"\ for\ the\ source -\-\ dstFs\ \-\ a\ remote\ name\ string\ eg\ "drive2:"\ for\ the\ destination -\-\ dstRemote\ \-\ a\ path\ within\ that\ remote\ eg\ "file2.txt"\ for\ the\ destination - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/publiclink:\ Create\ or\ retrieve\ a\ public\ link\ to\ the\ given\ file\ or\ folder.\ {#operations/publiclink} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" - -Returns - -\-\ url\ \-\ URL\ of\ the\ resource - -See\ the\ [link\ command](https://rclone.org/commands/rclone_link/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/purge:\ Remove\ a\ directory\ or\ container\ and\ all\ of\ its\ contents\ {#operations/purge} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" - -See\ the\ [purge\ command](https://rclone.org/commands/rclone_purge/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/rmdir:\ Remove\ an\ empty\ directory\ or\ container\ {#operations/rmdir} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" - -See\ the\ [rmdir\ command](https://rclone.org/commands/rclone_rmdir/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/rmdirs:\ Remove\ all\ the\ empty\ directories\ in\ the\ path\ {#operations/rmdirs} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:" -\-\ remote\ \-\ a\ path\ within\ that\ remote\ eg\ "dir" -\-\ leaveRoot\ \-\ boolean,\ set\ to\ true\ not\ to\ delete\ the\ root - -See\ the\ [rmdirs\ command](https://rclone.org/commands/rclone_rmdirs/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ operations/size:\ Count\ the\ number\ of\ bytes\ and\ files\ in\ remote\ {#operations/size} - -This\ takes\ the\ following\ parameters - -\-\ fs\ \-\ a\ remote\ name\ string\ eg\ "drive:path/to/dir" - -Returns - -\-\ count\ \-\ number\ of\ files -\-\ bytes\ \-\ number\ of\ bytes\ in\ those\ files - -See\ the\ [size\ command](https://rclone.org/commands/rclone_size/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ options/blocks:\ List\ all\ the\ option\ blocks\ {#options/blocks} - -Returns -\-\ options\ \-\ a\ list\ of\ the\ options\ block\ names - -###\ options/get:\ Get\ all\ the\ options\ {#options/get} - -Returns\ an\ object\ where\ keys\ are\ option\ block\ names\ and\ values\ are\ an -object\ with\ the\ current\ option\ values\ in. - -This\ shows\ the\ internal\ names\ of\ the\ option\ within\ rclone\ which\ should -map\ to\ the\ external\ options\ very\ easily\ with\ a\ few\ exceptions. - -###\ options/set:\ Set\ an\ option\ {#options/set} - Parameters - -\-\ option\ block\ name\ containing\ an\ object\ with -\ \ \-\ key:\ value - -Repeated\ as\ often\ as\ required. - -Only\ supply\ the\ options\ you\ wish\ to\ change.\ \ If\ an\ option\ is\ unknown -it\ will\ be\ silently\ ignored.\ \ Not\ all\ options\ will\ have\ an\ effect\ when -changed\ like\ this. - -For\ example: - -This\ sets\ DEBUG\ level\ logs\ (\-vv) - -\ \ \ \ rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 8}}\[aq] - -And\ this\ sets\ INFO\ level\ logs\ (\-v) - -\ \ \ \ rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 7}}\[aq] - -And\ this\ sets\ NOTICE\ level\ logs\ (normal\ without\ \-v) - -\ \ \ \ rclone\ rc\ options/set\ \-\-json\ \[aq]{"main":\ {"LogLevel":\ 6}}\[aq] - -###\ rc/error:\ This\ returns\ an\ error\ {#rc/error} - -This\ returns\ an\ error\ with\ the\ input\ as\ part\ of\ its\ error\ string. -Useful\ for\ testing\ error\ handling. - -###\ rc/list:\ List\ all\ the\ registered\ remote\ control\ commands\ {#rc/list} - -This\ lists\ all\ the\ registered\ remote\ control\ commands\ as\ a\ JSON\ map\ in -the\ commands\ response. - -###\ rc/noop:\ Echo\ the\ input\ to\ the\ output\ parameters\ {#rc/noop} - -This\ echoes\ the\ input\ parameters\ to\ the\ output\ parameters\ for\ testing -purposes.\ \ It\ can\ be\ used\ to\ check\ that\ rclone\ is\ still\ alive\ and\ to -check\ that\ parameter\ passing\ is\ working\ properly. - -###\ rc/noopauth:\ Echo\ the\ input\ to\ the\ output\ parameters\ requiring\ auth\ {#rc/noopauth} - -This\ echoes\ the\ input\ parameters\ to\ the\ output\ parameters\ for\ testing -purposes.\ \ It\ can\ be\ used\ to\ check\ that\ rclone\ is\ still\ alive\ and\ to -check\ that\ parameter\ passing\ is\ working\ properly. - -Authentication\ is\ required\ for\ this\ call. - -###\ sync/copy:\ copy\ a\ directory\ from\ source\ remote\ to\ destination\ remote\ {#sync/copy} - -This\ takes\ the\ following\ parameters - -\-\ srcFs\ \-\ a\ remote\ name\ string\ eg\ "drive:src"\ for\ the\ source -\-\ dstFs\ \-\ a\ remote\ name\ string\ eg\ "drive:dst"\ for\ the\ destination - - -See\ the\ [copy\ command](https://rclone.org/commands/rclone_copy/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ sync/move:\ move\ a\ directory\ from\ source\ remote\ to\ destination\ remote\ {#sync/move} - -This\ takes\ the\ following\ parameters - -\-\ srcFs\ \-\ a\ remote\ name\ string\ eg\ "drive:src"\ for\ the\ source -\-\ dstFs\ \-\ a\ remote\ name\ string\ eg\ "drive:dst"\ for\ the\ destination -\-\ deleteEmptySrcDirs\ \-\ delete\ empty\ src\ directories\ if\ set - - -See\ the\ [move\ command](https://rclone.org/commands/rclone_move/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ sync/sync:\ sync\ a\ directory\ from\ source\ remote\ to\ destination\ remote\ {#sync/sync} - -This\ takes\ the\ following\ parameters - -\-\ srcFs\ \-\ a\ remote\ name\ string\ eg\ "drive:src"\ for\ the\ source -\-\ dstFs\ \-\ a\ remote\ name\ string\ eg\ "drive:dst"\ for\ the\ destination - - -See\ the\ [sync\ command](https://rclone.org/commands/rclone_sync/)\ command\ for\ more\ information\ on\ the\ above. - -Authentication\ is\ required\ for\ this\ call. - -###\ vfs/forget:\ Forget\ files\ or\ directories\ in\ the\ directory\ cache.\ {#vfs/forget} - -This\ forgets\ the\ paths\ in\ the\ directory\ cache\ causing\ them\ to\ be -re\-read\ from\ the\ remote\ when\ needed. - -If\ no\ paths\ are\ passed\ in\ then\ it\ will\ forget\ all\ the\ paths\ in\ the -directory\ cache. - -\ \ \ \ rclone\ rc\ vfs/forget - -Otherwise\ pass\ files\ or\ dirs\ in\ as\ file=path\ or\ dir=path.\ \ Any -parameter\ key\ starting\ with\ file\ will\ forget\ that\ file\ and\ any -starting\ with\ dir\ will\ forget\ that\ dir,\ eg - -\ \ \ \ rclone\ rc\ vfs/forget\ file=hello\ file2=goodbye\ dir=home/junk - -###\ vfs/poll\-interval:\ Get\ the\ status\ or\ update\ the\ value\ of\ the\ poll\-interval\ option.\ {#vfs/poll\-interval} - -Without\ any\ parameter\ given\ this\ returns\ the\ current\ status\ of\ the -poll\-interval\ setting. - -When\ the\ interval=duration\ parameter\ is\ set,\ the\ poll\-interval\ value -is\ updated\ and\ the\ polling\ function\ is\ notified. -Setting\ interval=0\ disables\ poll\-interval. - -\ \ \ \ rclone\ rc\ vfs/poll\-interval\ interval=5m - -The\ timeout=duration\ parameter\ can\ be\ used\ to\ specify\ a\ time\ to\ wait -for\ the\ current\ poll\ function\ to\ apply\ the\ new\ value. -If\ timeout\ is\ less\ or\ equal\ 0,\ which\ is\ the\ default,\ wait\ indefinitely. - -The\ new\ poll\-interval\ value\ will\ only\ be\ active\ when\ the\ timeout\ is -not\ reached. - -If\ poll\-interval\ is\ updated\ or\ disabled\ temporarily,\ some\ changes -might\ not\ get\ picked\ up\ by\ the\ polling\ function,\ depending\ on\ the -used\ remote. - -###\ vfs/refresh:\ Refresh\ the\ directory\ cache.\ {#vfs/refresh} - -This\ reads\ the\ directories\ for\ the\ specified\ paths\ and\ freshens\ the -directory\ cache. - -If\ no\ paths\ are\ passed\ in\ then\ it\ will\ refresh\ the\ root\ directory. - -\ \ \ \ rclone\ rc\ vfs/refresh - -Otherwise\ pass\ directories\ in\ as\ dir=path.\ Any\ parameter\ key -starting\ with\ dir\ will\ refresh\ that\ directory,\ eg - -\ \ \ \ rclone\ rc\ vfs/refresh\ dir=home/junk\ dir2=data/misc - -If\ the\ parameter\ recursive=true\ is\ given\ the\ whole\ directory\ tree -will\ get\ refreshed.\ This\ refresh\ will\ use\ \-\-fast\-list\ if\ enabled. - - - -##\ Accessing\ the\ remote\ control\ via\ HTTP - -Rclone\ implements\ a\ simple\ HTTP\ based\ protocol. - -Each\ endpoint\ takes\ an\ JSON\ object\ and\ returns\ a\ JSON\ object\ or\ an -error.\ \ The\ JSON\ objects\ are\ essentially\ a\ map\ of\ string\ names\ to -values. - -All\ calls\ must\ made\ using\ POST. - -The\ input\ objects\ can\ be\ supplied\ using\ URL\ parameters,\ POST -parameters\ or\ by\ supplying\ "Content\-Type:\ application/json"\ and\ a\ JSON -blob\ in\ the\ body.\ \ There\ are\ examples\ of\ these\ below\ using\ `curl`. - -The\ response\ will\ be\ a\ JSON\ blob\ in\ the\ body\ of\ the\ response.\ \ This\ is -formatted\ to\ be\ reasonably\ human\ readable. - -###\ Error\ returns - -If\ an\ error\ occurs\ then\ there\ will\ be\ an\ HTTP\ error\ status\ (eg\ 500) -and\ the\ body\ of\ the\ response\ will\ contain\ a\ JSON\ encoded\ error\ object, -eg -\f[] -.fi +.IP \[bu] 2 +jobid \- id of the job (integer) +.SS operations/about: Return the space used on the remote {#operations/about} .PP -{ \[lq]error\[rq]: \[lq]Expecting string value for key "remote" (was -float64)\[rq], \[lq]input\[rq]: { \[lq]fs\[rq]: \[lq]/tmp\[rq], -\[lq]remote\[rq]: 3 }, \[lq]status\[rq]: 400 \[lq]path\[rq]: -\[lq]operations/rmdir\[rq], } +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.PP +The result is as returned from rclone about \[en]json +.PP +See the about command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS operations/cleanup: Remove trashed files in the remote or path {#operations/cleanup} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.PP +See the cleanup command (https://rclone.org/commands/rclone_cleanup/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/copyfile: Copy a file from source remote to destination remote {#operations/copyfile} +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[lq]drive:\[rq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote eg \[lq]file.txt\[rq] for the +source +.IP \[bu] 2 +dstFs \- a remote name string eg \[lq]drive2:\[rq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote eg \[lq]file2.txt\[rq] for the +destination +.PP +Authentication is required for this call. +.SS operations/copyurl: Copy the URL to the object {#operations/copyurl} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.IP \[bu] 2 +url \- string, URL to read from +.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 +Authentication is required for this call. +.SS operations/delete: Remove files in the path {#operations/delete} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.PP +See the delete command (https://rclone.org/commands/rclone_delete/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/deletefile: Remove the single file pointed to {#operations/deletefile} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.PP +See the deletefile +command (https://rclone.org/commands/rclone_deletefile/) command for +more information on the above. +.PP +Authentication is required for this call. +.SS operations/fsinfo: Return information about the remote {#operations/fsinfo} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.PP +This returns info about the remote passed in; .IP .nf \f[C] - -The\ keys\ in\ the\ error\ response\ are -\-\ error\ \-\ error\ string -\-\ input\ \-\ the\ input\ parameters\ to\ the\ call -\-\ status\ \-\ the\ HTTP\ status\ code -\-\ path\ \-\ the\ path\ of\ the\ call - -###\ CORS - -The\ sever\ implements\ basic\ CORS\ support\ and\ allows\ all\ origins\ for\ that. -The\ response\ to\ a\ preflight\ OPTIONS\ request\ will\ echo\ the\ requested\ "Access\-Control\-Request\-Headers"\ back. - -###\ Using\ POST\ with\ URL\ parameters\ only -\f[] +{ + // 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 -curl \-X POST `http://localhost:5572/rc/noop?potato=1&sausage=2' +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 {#operations/list} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.IP \[bu] 2 +opt \- a dictionary of options to control the listing (optional) +.RS 2 +.IP \[bu] 2 +recurse \- If set recurse directories +.IP \[bu] 2 +noModTime \- If set return modification time +.IP \[bu] 2 +showEncrypted \- If set show decrypted names +.IP \[bu] 2 +showOrigIDs \- If set show the IDs for each item if known +.IP \[bu] 2 +showHash \- If set return a dictionary of hashes +.RE +.PP +The result is +.IP \[bu] 2 +list +.RS 2 +.IP \[bu] 2 +This is an array of objects as described in the lsjson command +.RE +.PP +See the lsjson command (https://rclone.org/commands/rclone_lsjson/) for +more information on the above and examples. +.PP +Authentication is required for this call. +.SS operations/mkdir: Make a destination directory or container {#operations/mkdir} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.PP +See the mkdir command (https://rclone.org/commands/rclone_mkdir/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/movefile: Move a file from source remote to destination remote {#operations/movefile} +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[lq]drive:\[rq] for the source +.IP \[bu] 2 +srcRemote \- a path within that remote eg \[lq]file.txt\[rq] for the +source +.IP \[bu] 2 +dstFs \- a remote name string eg \[lq]drive2:\[rq] for the destination +.IP \[bu] 2 +dstRemote \- a path within that remote eg \[lq]file2.txt\[rq] for the +destination +.PP +Authentication is required for this call. +.SS operations/publiclink: Create or retrieve a public link to the given file or folder. {#operations/publiclink} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.PP +Returns +.IP \[bu] 2 +url \- URL of the resource +.PP +See the link command (https://rclone.org/commands/rclone_link/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS operations/purge: Remove a directory or container and all of its contents {#operations/purge} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.PP +See the purge command (https://rclone.org/commands/rclone_purge/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/rmdir: Remove an empty directory or container {#operations/rmdir} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.PP +See the rmdir command (https://rclone.org/commands/rclone_rmdir/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/rmdirs: Remove all the empty directories in the path {#operations/rmdirs} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:\[rq] +.IP \[bu] 2 +remote \- a path within that remote eg \[lq]dir\[rq] +.IP \[bu] 2 +leaveRoot \- boolean, set to true not to delete the root +.PP +See the rmdirs command (https://rclone.org/commands/rclone_rmdirs/) +command for more information on the above. +.PP +Authentication is required for this call. +.SS operations/size: Count the number of bytes and files in remote {#operations/size} +.PP +This takes the following parameters +.IP \[bu] 2 +fs \- a remote name string eg \[lq]drive:path/to/dir\[rq] +.PP +Returns +.IP \[bu] 2 +count \- number of files +.IP \[bu] 2 +bytes \- number of bytes in those files +.PP +See the size command (https://rclone.org/commands/rclone_size/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS options/blocks: List all the option blocks {#options/blocks} +.PP +Returns \- options \- a list of the options block names +.SS options/get: Get all the options {#options/get} +.PP +Returns an object where keys are option block names and values are an +object with the current option values in. +.PP +This shows the internal names of the option within rclone which should +map to the external options very easily with a few exceptions. +.SS options/set: Set an option {#options/set} +.PP +Parameters +.IP \[bu] 2 +option block name containing an object with +.RS 2 +.IP \[bu] 2 +key: value +.RE +.PP +Repeated as often as required. +.PP +Only supply the options you wish to change. +If an option is unknown it will be silently ignored. +Not all options will have an effect when changed like this. +.PP +For example: +.PP +This sets DEBUG level logs (\-vv) +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 8}}\[aq] +\f[R] +.fi +.PP +And this sets INFO level logs (\-v) +.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) +.IP +.nf +\f[C] +rclone rc options/set \-\-json \[aq]{\[dq]main\[dq]: {\[dq]LogLevel\[dq]: 6}}\[aq] +\f[R] +.fi +.SS rc/error: This returns an error {#rc/error} +.PP +This returns an error with the input as part of its error string. +Useful for testing error handling. +.SS rc/list: List all the registered remote control commands {#rc/list} +.PP +This lists all the registered remote control commands as a JSON map in +the commands response. +.SS rc/noop: Echo the input to the output parameters {#rc/noop} +.PP +This echoes the input parameters to the output parameters for testing +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.SS rc/noopauth: Echo the input to the output parameters requiring auth {#rc/noopauth} +.PP +This echoes the input parameters to the output parameters for testing +purposes. +It can be used to check that rclone is still alive and to check that +parameter passing is working properly. +.PP +Authentication is required for this call. +.SS sync/copy: copy a directory from source remote to destination remote {#sync/copy} +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[lq]drive:dst\[rq] for the destination +.PP +See the copy command (https://rclone.org/commands/rclone_copy/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS sync/move: move a directory from source remote to destination remote {#sync/move} +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[lq]drive:dst\[rq] for the destination +.IP \[bu] 2 +deleteEmptySrcDirs \- delete empty src directories if set +.PP +See the move command (https://rclone.org/commands/rclone_move/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS sync/sync: sync a directory from source remote to destination remote {#sync/sync} +.PP +This takes the following parameters +.IP \[bu] 2 +srcFs \- a remote name string eg \[lq]drive:src\[rq] for the source +.IP \[bu] 2 +dstFs \- a remote name string eg \[lq]drive:dst\[rq] for the destination +.PP +See the sync command (https://rclone.org/commands/rclone_sync/) command +for more information on the above. +.PP +Authentication is required for this call. +.SS vfs/forget: Forget files or directories in the directory cache. {#vfs/forget} +.PP +This forgets the paths in the directory cache causing them to be +re\-read from the remote when needed. +.PP +If no paths are passed in then it will forget all the paths in the +directory cache. +.IP +.nf +\f[C] +rclone rc vfs/forget +\f[R] +.fi +.PP +Otherwise pass files or dirs in as file=path or dir=path. +Any parameter key starting with file will forget that file and any +starting with dir will forget that dir, eg +.IP +.nf +\f[C] +rclone rc vfs/forget file=hello file2=goodbye dir=home/junk +\f[R] +.fi +.SS vfs/poll\-interval: Get the status or update the value of the poll\-interval option. {#vfs/poll\-interval} +.PP +Without any parameter given this returns the current status of the +poll\-interval setting. +.PP +When the interval=duration parameter is set, the poll\-interval value is +updated and the polling function is notified. +Setting interval=0 disables poll\-interval. +.IP +.nf +\f[C] +rclone rc vfs/poll\-interval interval=5m +\f[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. +.PP +The new poll\-interval value will only be active when the timeout is not +reached. +.PP +If poll\-interval is updated or disabled temporarily, some changes might +not get picked up by the polling function, depending on the used remote. +.SS vfs/refresh: Refresh the directory cache. {#vfs/refresh} +.PP +This reads the directories for the specified paths and freshens the +directory cache. +.PP +If no paths are passed in then it will refresh the root directory. +.IP +.nf +\f[C] +rclone rc vfs/refresh +\f[R] +.fi +.PP +Otherwise pass directories in as dir=path. +Any parameter key starting with dir will refresh that directory, eg +.IP +.nf +\f[C] +rclone rc vfs/refresh dir=home/junk dir2=data/misc +\f[R] +.fi +.PP +If the parameter recursive=true is given the whole directory tree will +get refreshed. +This refresh will use \[en]fast\-list if enabled. +.SS Accessing the remote control via HTTP +.PP +Rclone implements a simple HTTP based protocol. +.PP +Each endpoint takes an JSON object and returns a JSON object or an +error. +The JSON objects are essentially a map of string names to values. +.PP +All calls must made using POST. +.PP +The input objects can be supplied using URL parameters, POST parameters +or by supplying \[lq]Content\-Type: application/json\[rq] and a JSON +blob in the body. +There are examples of these below using \f[C]curl\f[R]. +.PP +The response will be a JSON blob in the body of the response. +This is formatted to be reasonably human readable. +.SS Error returns +.PP +If an error occurs then there will be an HTTP error status (eg 500) and +the body of the response will contain a JSON encoded error object, eg +.IP +.nf +\f[C] +{ + \[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 +\[lq]Access\-Control\-Request\-Headers\[rq] back. +.SS Using POST with URL parameters only +.IP +.nf +\f[C] +curl \-X POST \[aq]http://localhost:5572/rc/noop?potato=1&sausage=2\[aq] +\f[R] +.fi +.PP Response -\f[] -.fi -.PP -{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]sausage\[rq]: \[lq]2\[rq] } .IP .nf \f[C] - -Here\ is\ what\ an\ error\ response\ looks\ like: -\f[] +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] .fi .PP -curl \-X POST `http://localhost:5572/rc/error?potato=1&sausage=2' +Here is what an error response looks like: .IP .nf \f[C] -\f[] +curl \-X POST \[aq]http://localhost:5572/rc/error?potato=1&sausage=2\[aq] +\f[R] .fi -.PP -{ \[lq]error\[rq]: \[lq]arbitrary error on input map[potato:1 -sausage:2]\[rq], \[lq]input\[rq]: { \[lq]potato\[rq]: \[lq]1\[rq], -\[lq]sausage\[rq]: \[lq]2\[rq] } } .IP .nf \f[C] - -Note\ that\ curl\ doesn\[aq]t\ return\ errors\ to\ the\ shell\ unless\ you\ use\ the\ `\-f`\ option -\f[] +{ + \[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 `http://localhost:5572/rc/error?potato=1&sausage=2' -curl: (22) The requested URL returned error: 400 Bad Request $ echo $? +Note that curl doesn\[cq]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 -\f[] +curl \-\-data \[dq]potato=1\[dq] \-\-data \[dq]sausage=2\[dq] http://localhost:5572/rc/noop +\f[R] .fi .PP -curl \[en]data \[lq]potato=1\[rq] \[en]data \[lq]sausage=2\[rq] -http://localhost:5572/rc/noop -.IP -.nf -\f[C] - Response -\f[] -.fi -.PP -{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]sausage\[rq]: \[lq]2\[rq] } .IP .nf \f[C] - -Note\ that\ you\ can\ combine\ these\ with\ URL\ parameters\ too\ with\ the\ POST -parameters\ taking\ precedence. -\f[] +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]sausage\[dq]: \[dq]2\[dq] +} +\f[R] .fi .PP -curl \[en]data \[lq]potato=1\[rq] \[en]data \[lq]sausage=2\[rq] -\[lq]http://localhost:5572/rc/noop?rutabaga=3&sausage=4\[rq] +Note that you can combine these with URL parameters too with the POST +parameters taking precedence. .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[] -.fi -.PP -{ \[lq]potato\[rq]: \[lq]1\[rq], \[lq]rutabaga\[rq]: \[lq]3\[rq], -\[lq]sausage\[rq]: \[lq]4\[rq] } .IP .nf \f[C] - -###\ Using\ POST\ with\ a\ JSON\ blob -\f[] +{ + \[dq]potato\[dq]: \[dq]1\[dq], + \[dq]rutabaga\[dq]: \[dq]3\[dq], + \[dq]sausage\[dq]: \[dq]4\[dq] +} +\f[R] .fi -.PP -curl \-H \[lq]Content\-Type: application/json\[rq] \-X POST \-d -`{\[lq]potato\[rq]:2,\[lq]sausage\[rq]:1}' http://localhost:5572/rc/noop +.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[] -.fi -.PP -{ \[lq]password\[rq]: \[lq]xyz\[rq], \[lq]username\[rq]: \[lq]xyz\[rq] } .IP .nf \f[C] - -This\ can\ be\ combined\ with\ URL\ parameters\ too\ if\ required.\ \ The\ JSON -blob\ takes\ precedence. -\f[] +{ + \[dq]password\[dq]: \[dq]xyz\[dq], + \[dq]username\[dq]: \[dq]xyz\[dq] +} +\f[R] .fi .PP -curl \-H \[lq]Content\-Type: application/json\[rq] \-X POST \-d -`{\[lq]potato\[rq]:2,\[lq]sausage\[rq]:1}' -`http://localhost:5572/rc/noop?rutabaga=3&potato=4' +This can be combined with URL parameters too if required. +The JSON blob takes precedence. .IP .nf \f[C] -\f[] +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 -{ \[lq]potato\[rq]: 2, \[lq]rutabaga\[rq]: \[lq]3\[rq], -\[lq]sausage\[rq]: 1 } .IP .nf \f[C] - -##\ Debugging\ rclone\ with\ pprof\ ## - -If\ you\ use\ the\ `\-\-rc`\ flag\ this\ will\ also\ enable\ the\ use\ of\ the\ go -profiling\ tools\ on\ the\ same\ port. - -To\ use\ these,\ first\ [install\ go](https://golang.org/doc/install). - -###\ Debugging\ memory\ use - -To\ profile\ rclone\[aq]s\ memory\ use\ you\ can\ run: - -\ \ \ \ go\ tool\ pprof\ \-web\ http://localhost:5572/debug/pprof/heap - -This\ should\ open\ a\ page\ in\ your\ browser\ showing\ what\ is\ using\ what +{ + \[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\[cq]s memory use you can run: +.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\ `\-text`\ flag\ to\ produce\ a\ textual\ summary -\f[] -.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[]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 - -Memory\ leaks\ are\ most\ often\ caused\ by\ go\ routine\ leaks\ keeping\ memory -alive\ which\ should\ have\ been\ garbage\ collected. - -See\ all\ active\ go\ routines\ using - -\ \ \ \ curl\ http://localhost:5572/debug/pprof/goroutine?debug=1 - -Or\ go\ to\ http://localhost:5572/debug/pprof/goroutine?debug=1\ in\ your\ browser. - -###\ Other\ profiles\ to\ look\ at - -You\ can\ see\ a\ summary\ of\ profiles\ available\ at\ http://localhost:5572/debug/pprof/ - -Here\ is\ how\ to\ use\ some\ of\ them: - -\ \ *\ Memory:\ `go\ tool\ pprof\ http://localhost:5572/debug/pprof/heap` -\ \ *\ Go\ routines:\ `curl\ http://localhost:5572/debug/pprof/goroutine?debug=1` -\ \ *\ 30\-second\ CPU\ profile:\ `go\ tool\ pprof\ http://localhost:5572/debug/pprof/profile` -\ \ *\ 5\-second\ execution\ trace:\ `wget\ http://localhost:5572/debug/pprof/trace?seconds=5` - -See\ the\ [net/http/pprof\ docs](https://golang.org/pkg/net/http/pprof/) -for\ more\ info\ on\ how\ to\ use\ the\ profiling\ and\ for\ a\ general\ overview -see\ [the\ Go\ team\[aq]s\ blog\ post\ on\ profiling\ go\ programs](https://blog.golang.org/profiling\-go\-programs). - -The\ profiling\ hook\ is\ [zero\ overhead\ unless\ it\ is\ used](https://stackoverflow.com/q/26545159/164234). - -#\ Overview\ of\ cloud\ storage\ systems\ # - -Each\ cloud\ storage\ system\ is\ slightly\ different.\ \ Rclone\ attempts\ to -provide\ a\ unified\ interface\ to\ them,\ but\ some\ underlying\ differences -show\ through. - -##\ Features\ ## - -Here\ is\ an\ overview\ of\ the\ major\ features\ of\ each\ cloud\ storage\ system. - -|\ Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Hash\ \ \ \ \ \ \ \ |\ ModTime\ |\ Case\ Insensitive\ |\ Duplicate\ Files\ |\ MIME\ Type\ | -|\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-:| -|\ 1Fichier\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Whirlpool\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ Amazon\ Drive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ Amazon\ S3\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Backblaze\ B2\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ SHA1\ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Box\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ SHA1\ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Citrix\ ShareFile\ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Dropbox\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ DBHASH\ †\ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ FTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Google\ Cloud\ Storage\ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Google\ Drive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Google\ Photos\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ HTTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ Hubic\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Jottacloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Koofr\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Mail.ru\ Cloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Mailru\ ‡‡‡\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Mega\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Microsoft\ Azure\ Blob\ Storage\ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ Microsoft\ OneDrive\ \ \ \ \ \ \ \ \ \ \ |\ SHA1\ ‡‡\ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ OpenDrive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Openstack\ Swift\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ pCloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5,\ SHA1\ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ W\ \ \ \ \ \ \ \ \ | -|\ premiumize.me\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ put.io\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ CRC\-32\ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ |\ R\ \ \ \ \ \ \ \ \ | -|\ QingStor\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ SFTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5,\ SHA1\ ‡\ |\ Yes\ \ \ \ \ |\ Depends\ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ WebDAV\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5,\ SHA1\ ††|\ Yes\ †††\ |\ Depends\ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | -|\ Yandex\ Disk\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ MD5\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ R/W\ \ \ \ \ \ \ | -|\ The\ local\ filesystem\ \ \ \ \ \ \ \ \ |\ All\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Depends\ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ \-\ \ \ \ \ \ \ \ \ | - -###\ Hash\ ### - -The\ cloud\ storage\ system\ supports\ various\ hash\ types\ of\ the\ objects. -The\ hashes\ are\ used\ when\ transferring\ data\ as\ an\ integrity\ check\ and -can\ be\ specifically\ used\ with\ the\ `\-\-checksum`\ flag\ in\ syncs\ and\ in -the\ `check`\ command. - -To\ use\ the\ verify\ checksums\ when\ transferring\ between\ cloud\ storage -systems\ they\ must\ support\ a\ common\ hash\ type. - -†\ Note\ that\ Dropbox\ supports\ [its\ own\ custom -hash](https://www.dropbox.com/developers/reference/content\-hash). -This\ is\ an\ SHA256\ sum\ of\ all\ the\ 4MB\ block\ SHA256s. - -‡\ SFTP\ supports\ checksums\ if\ the\ same\ login\ has\ shell\ access\ and\ `md5sum` -or\ `sha1sum`\ as\ well\ as\ `echo`\ are\ in\ the\ remote\[aq]s\ PATH. - -††\ WebDAV\ supports\ hashes\ when\ used\ with\ Owncloud\ and\ Nextcloud\ only. - -†††\ WebDAV\ supports\ modtimes\ when\ used\ with\ Owncloud\ and\ Nextcloud\ only. - -‡‡\ Microsoft\ OneDrive\ Personal\ supports\ SHA1\ hashes,\ whereas\ OneDrive -for\ business\ and\ SharePoint\ server\ support\ Microsoft\[aq]s\ own -[QuickXorHash](https://docs.microsoft.com/en\-us/onedrive/developer/code\-snippets/quickxorhash). - -‡‡‡\ Mail.ru\ uses\ its\ own\ modified\ SHA1\ hash - -###\ ModTime\ ### - -The\ cloud\ storage\ system\ supports\ setting\ modification\ times\ on -objects.\ \ If\ it\ does\ then\ this\ enables\ a\ using\ the\ modification\ times -as\ part\ of\ the\ sync.\ \ If\ not\ then\ only\ the\ size\ will\ be\ checked\ by -default,\ though\ the\ MD5SUM\ can\ be\ checked\ with\ the\ `\-\-checksum`\ flag. - -All\ cloud\ storage\ systems\ support\ some\ kind\ of\ date\ on\ the\ object\ and -these\ will\ be\ set\ when\ transferring\ from\ the\ cloud\ storage\ system. - -###\ Case\ Insensitive\ ### - -If\ a\ cloud\ storage\ systems\ is\ case\ sensitive\ then\ it\ is\ possible\ to -have\ two\ files\ which\ differ\ only\ in\ case,\ eg\ `file.txt`\ and -`FILE.txt`.\ \ If\ a\ cloud\ storage\ system\ is\ case\ insensitive\ then\ that -isn\[aq]t\ possible. - -This\ can\ cause\ problems\ when\ syncing\ between\ a\ case\ insensitive -system\ and\ a\ case\ sensitive\ system.\ \ The\ symptom\ of\ this\ is\ that\ no -matter\ how\ many\ times\ you\ run\ the\ sync\ it\ never\ completes\ fully. - -The\ local\ filesystem\ and\ SFTP\ may\ or\ may\ not\ be\ case\ sensitive -depending\ on\ OS. - -\ \ *\ Windows\ \-\ usually\ case\ insensitive,\ though\ case\ is\ preserved -\ \ *\ OSX\ \-\ usually\ case\ insensitive,\ though\ it\ is\ possible\ to\ format\ case\ sensitive -\ \ *\ Linux\ \-\ usually\ case\ sensitive,\ but\ there\ are\ case\ insensitive\ file\ systems\ (eg\ FAT\ formatted\ USB\ keys) - -Most\ of\ the\ time\ this\ doesn\[aq]t\ cause\ any\ problems\ as\ people\ tend\ to -avoid\ files\ whose\ name\ differs\ only\ by\ case\ even\ on\ case\ sensitive -systems. - -###\ Duplicate\ files\ ### - -If\ a\ cloud\ storage\ system\ allows\ duplicate\ files\ then\ it\ can\ have\ two -objects\ with\ the\ same\ name. - -This\ confuses\ rclone\ greatly\ when\ syncing\ \-\ use\ the\ `rclone\ dedupe` -command\ to\ rename\ or\ remove\ duplicates. - -###\ Restricted\ filenames\ ### - -Some\ cloud\ storage\ systems\ might\ have\ restrictions\ on\ the\ characters -that\ are\ usable\ in\ file\ or\ directory\ names. -When\ `rclone`\ detects\ such\ a\ name\ during\ a\ file\ upload,\ it\ will -transparently\ replace\ the\ restricted\ characters\ with\ similar\ looking -Unicode\ characters. - -This\ process\ is\ designed\ to\ avoid\ ambiguous\ file\ names\ as\ much\ as -possible\ and\ allow\ to\ move\ files\ between\ many\ cloud\ storage\ systems -transparently. - -The\ name\ shown\ by\ `rclone`\ to\ the\ user\ or\ during\ log\ output\ will\ only -contain\ a\ minimal\ set\ of\ [replaced\ characters](#restricted\-characters) -to\ ensure\ correct\ formatting\ and\ not\ necessarily\ the\ actual\ name\ used -on\ the\ cloud\ storage. - -This\ transformation\ is\ reversed\ when\ downloading\ a\ file\ or\ parsing -`rclone`\ arguments. -For\ example,\ when\ uploading\ a\ file\ named\ `my\ file?.txt`\ to\ Onedrive -will\ be\ displayed\ as\ `my\ file?.txt`\ on\ the\ console,\ but\ stored\ as -`my\ file？.txt`\ (the\ `?`\ gets\ replaced\ by\ the\ similar\ looking\ `？` -character)\ to\ Onedrive. -The\ reverse\ transformation\ allows\ to\ read\ a\ file`unusual/name.txt` -from\ Google\ Drive,\ by\ passing\ the\ name\ `unusual／name.txt`\ (the\ `/`\ needs -to\ be\ replaced\ by\ the\ similar\ looking\ `／`\ character)\ on\ the\ command\ line. - -####\ Default\ restricted\ characters\ {#restricted\-characters} - -The\ table\ below\ shows\ the\ characters\ that\ are\ replaced\ by\ default. - -When\ a\ replacement\ character\ is\ found\ in\ a\ filename,\ this\ character -will\ be\ escaped\ with\ the\ `‛`\ character\ to\ avoid\ ambiguous\ file\ names. -(e.g.\ a\ file\ named\ `␀.txt`\ would\ shown\ as\ `‛␀.txt`) - -Each\ cloud\ storage\ backend\ can\ use\ a\ different\ set\ of\ characters, -which\ will\ be\ specified\ in\ the\ documentation\ for\ each\ backend. - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ NUL\ \ \ \ \ \ \ |\ 0x00\ \ |\ ␀\ \ \ \ \ \ \ \ \ \ \ | -|\ SOH\ \ \ \ \ \ \ |\ 0x01\ \ |\ ␁\ \ \ \ \ \ \ \ \ \ \ | -|\ STX\ \ \ \ \ \ \ |\ 0x02\ \ |\ ␂\ \ \ \ \ \ \ \ \ \ \ | -|\ ETX\ \ \ \ \ \ \ |\ 0x03\ \ |\ ␃\ \ \ \ \ \ \ \ \ \ \ | -|\ EOT\ \ \ \ \ \ \ |\ 0x04\ \ |\ ␄\ \ \ \ \ \ \ \ \ \ \ | -|\ ENQ\ \ \ \ \ \ \ |\ 0x05\ \ |\ ␅\ \ \ \ \ \ \ \ \ \ \ | -|\ ACK\ \ \ \ \ \ \ |\ 0x06\ \ |\ ␆\ \ \ \ \ \ \ \ \ \ \ | -|\ BEL\ \ \ \ \ \ \ |\ 0x07\ \ |\ ␇\ \ \ \ \ \ \ \ \ \ \ | -|\ BS\ \ \ \ \ \ \ \ |\ 0x08\ \ |\ ␈\ \ \ \ \ \ \ \ \ \ \ | -|\ HT\ \ \ \ \ \ \ \ |\ 0x09\ \ |\ ␉\ \ \ \ \ \ \ \ \ \ \ | -|\ LF\ \ \ \ \ \ \ \ |\ 0x0A\ \ |\ ␊\ \ \ \ \ \ \ \ \ \ \ | -|\ VT\ \ \ \ \ \ \ \ |\ 0x0B\ \ |\ ␋\ \ \ \ \ \ \ \ \ \ \ | -|\ FF\ \ \ \ \ \ \ \ |\ 0x0C\ \ |\ ␌\ \ \ \ \ \ \ \ \ \ \ | -|\ CR\ \ \ \ \ \ \ \ |\ 0x0D\ \ |\ ␍\ \ \ \ \ \ \ \ \ \ \ | -|\ SO\ \ \ \ \ \ \ \ |\ 0x0E\ \ |\ ␎\ \ \ \ \ \ \ \ \ \ \ | -|\ SI\ \ \ \ \ \ \ \ |\ 0x0F\ \ |\ ␏\ \ \ \ \ \ \ \ \ \ \ | -|\ DLE\ \ \ \ \ \ \ |\ 0x10\ \ |\ ␐\ \ \ \ \ \ \ \ \ \ \ | -|\ DC1\ \ \ \ \ \ \ |\ 0x11\ \ |\ ␑\ \ \ \ \ \ \ \ \ \ \ | -|\ DC2\ \ \ \ \ \ \ |\ 0x12\ \ |\ ␒\ \ \ \ \ \ \ \ \ \ \ | -|\ DC3\ \ \ \ \ \ \ |\ 0x13\ \ |\ ␓\ \ \ \ \ \ \ \ \ \ \ | -|\ DC4\ \ \ \ \ \ \ |\ 0x14\ \ |\ ␔\ \ \ \ \ \ \ \ \ \ \ | -|\ NAK\ \ \ \ \ \ \ |\ 0x15\ \ |\ ␕\ \ \ \ \ \ \ \ \ \ \ | -|\ SYN\ \ \ \ \ \ \ |\ 0x16\ \ |\ ␖\ \ \ \ \ \ \ \ \ \ \ | -|\ ETB\ \ \ \ \ \ \ |\ 0x17\ \ |\ ␗\ \ \ \ \ \ \ \ \ \ \ | -|\ CAN\ \ \ \ \ \ \ |\ 0x18\ \ |\ ␘\ \ \ \ \ \ \ \ \ \ \ | -|\ EM\ \ \ \ \ \ \ \ |\ 0x19\ \ |\ ␙\ \ \ \ \ \ \ \ \ \ \ | -|\ SUB\ \ \ \ \ \ \ |\ 0x1A\ \ |\ ␚\ \ \ \ \ \ \ \ \ \ \ | -|\ ESC\ \ \ \ \ \ \ |\ 0x1B\ \ |\ ␛\ \ \ \ \ \ \ \ \ \ \ | -|\ FS\ \ \ \ \ \ \ \ |\ 0x1C\ \ |\ ␜\ \ \ \ \ \ \ \ \ \ \ | -|\ GS\ \ \ \ \ \ \ \ |\ 0x1D\ \ |\ ␝\ \ \ \ \ \ \ \ \ \ \ | -|\ RS\ \ \ \ \ \ \ \ |\ 0x1E\ \ |\ ␞\ \ \ \ \ \ \ \ \ \ \ | -|\ US\ \ \ \ \ \ \ \ |\ 0x1F\ \ |\ ␟\ \ \ \ \ \ \ \ \ \ \ | -|\ /\ \ \ \ \ \ \ \ \ |\ 0x2F\ \ |\ ／\ \ \ \ \ \ \ \ \ \ \ | -|\ DEL\ \ \ \ \ \ \ |\ 0x7F\ \ |\ ␡\ \ \ \ \ \ \ \ \ \ \ | - -The\ default\ encoding\ will\ also\ encode\ these\ file\ names\ as\ they\ are -problematic\ with\ many\ cloud\ storage\ systems. - -|\ File\ name\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-\-\-\-\-\-\-:| -|\ .\ \ \ \ \ \ \ \ \ |\ ．\ \ \ \ \ \ \ \ \ \ | -|\ ..\ \ \ \ \ \ \ \ |\ ．．\ \ \ \ \ \ \ \ \ | - -####\ Invalid\ UTF\-8\ bytes\ {#invalid\-utf8} - -Some\ backends\ only\ support\ a\ sequence\ of\ well\ formed\ UTF\-8\ bytes -as\ file\ or\ directory\ names. - -In\ this\ case\ all\ invalid\ UTF\-8\ bytes\ will\ be\ replaced\ with\ a\ quoted -representation\ of\ the\ byte\ value\ to\ allow\ uploading\ a\ file\ to\ such\ a -backend.\ For\ example,\ the\ invalid\ byte\ `0xFE`\ will\ be\ encoded\ as\ `‛FE`. - -A\ common\ source\ of\ invalid\ UTF\-8\ bytes\ are\ local\ filesystems,\ that\ store -names\ in\ a\ different\ encoding\ than\ UTF\-8\ or\ UTF\-16,\ like\ latin1.\ See\ the -[local\ filenames](/local/#filenames)\ section\ for\ details. - -###\ MIME\ Type\ ### - -MIME\ types\ (also\ known\ as\ media\ types)\ classify\ types\ of\ documents -using\ a\ simple\ text\ classification,\ eg\ `text/html`\ or -`application/pdf`. - -Some\ cloud\ storage\ systems\ support\ reading\ (`R`)\ the\ MIME\ type\ of -objects\ and\ some\ support\ writing\ (`W`)\ the\ MIME\ type\ of\ objects. - -The\ MIME\ type\ can\ be\ important\ if\ you\ are\ serving\ files\ directly\ to -HTTP\ from\ the\ storage\ system. - -If\ you\ are\ copying\ from\ a\ remote\ which\ supports\ reading\ (`R`)\ to\ a -remote\ which\ supports\ writing\ (`W`)\ then\ rclone\ will\ preserve\ the\ MIME -types.\ \ Otherwise\ they\ will\ be\ guessed\ from\ the\ extension,\ or\ the -remote\ itself\ may\ assign\ the\ MIME\ type. - -##\ Optional\ Features\ ## - -All\ the\ remotes\ support\ a\ basic\ set\ of\ features,\ but\ there\ are\ some -optional\ features\ supported\ by\ some\ remotes\ used\ to\ make\ some -operations\ more\ efficient. - -|\ Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Purge\ |\ Copy\ |\ Move\ |\ DirMove\ |\ CleanUp\ |\ ListR\ |\ StreamUpload\ |\ LinkSharing\ |\ About\ |\ EmptyDir\ | -|\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-:|:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-\-:|:\-\-\-\-\-:|\ :\-\-\-\-\-\-:\ | -|\ 1Fichier\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ \ \ No\ \ |\ \ Yes\ | -|\ Amazon\ Drive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ No\ \ |\ No\ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ Yes\ | -|\ Amazon\ S3\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | -|\ Backblaze\ B2\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ Yes\ |\ No\ \ |\ No\ | -|\ Box\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ No\ \ |\ Yes\ |\ Yes\ |\ No\ \ |\ Yes\ | -|\ Citrix\ ShareFile\ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ |\ No\ \ |\ Yes\ | -|\ Dropbox\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ No\ \ |\ Yes\ |\ Yes\ |\ Yes\ |\ Yes\ | -|\ FTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ Yes\ | -|\ Google\ Cloud\ Storage\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | -|\ Google\ Drive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | -|\ Google\ Photos\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ |\ No\ |\ No\ | -|\ HTTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ Yes\ | -|\ Hubic\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ †\ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ |\ No\ | -|\ Jottacloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | -|\ Mail.ru\ Cloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | -|\ Mega\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ |\ Yes\ | -|\ Microsoft\ Azure\ Blob\ Storage\ |\ Yes\ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | -|\ Microsoft\ OneDrive\ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ [#575](https://github.com/rclone/rclone/issues/575)\ |\ No\ |\ No\ |\ Yes\ |\ Yes\ |\ Yes\ | -|\ OpenDrive\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ |\ Yes\ | -|\ Openstack\ Swift\ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ †\ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ |\ No\ | -|\ pCloud\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ |\ Yes\ | -|\ premiumize.me\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | -|\ put.io\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ |\ Yes\ | -|\ QingStor\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ |\ No\ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ No\ \ |\ No\ | -|\ SFTP\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ \ |\ Yes\ | -|\ WebDAV\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ ‡\ \ \ \ \ \ \ \ |\ No\ [#2178](https://github.com/rclone/rclone/issues/2178)\ |\ Yes\ \ |\ Yes\ | -|\ Yandex\ Disk\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ Yes\ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | -|\ The\ local\ filesystem\ \ \ \ \ \ \ \ \ |\ Yes\ \ \ |\ No\ \ \ |\ Yes\ \ |\ Yes\ \ \ \ \ |\ No\ \ \ \ \ \ |\ No\ \ \ \ |\ Yes\ \ \ \ \ \ \ \ \ \ |\ No\ \ \ \ \ \ \ \ \ \ |\ Yes\ |\ Yes\ | - -###\ Purge\ ### - -This\ deletes\ a\ directory\ quicker\ than\ just\ deleting\ all\ the\ files\ in -the\ directory. - -†\ Note\ Swift\ and\ Hubic\ implement\ this\ in\ order\ to\ delete\ directory -markers\ but\ they\ don\[aq]t\ actually\ have\ a\ quicker\ way\ of\ deleting\ files -other\ than\ deleting\ them\ individually. - -‡\ StreamUpload\ is\ not\ supported\ with\ Nextcloud - -###\ Copy\ ### - -Used\ when\ copying\ an\ object\ to\ and\ from\ the\ same\ remote.\ \ This\ known -as\ a\ server\ side\ copy\ so\ you\ can\ copy\ a\ file\ without\ downloading\ it -and\ uploading\ it\ again.\ \ It\ is\ used\ if\ you\ use\ `rclone\ copy`\ or -`rclone\ move`\ if\ the\ remote\ doesn\[aq]t\ support\ `Move`\ directly. - -If\ the\ server\ doesn\[aq]t\ support\ `Copy`\ directly\ then\ for\ copy\ operations -the\ file\ is\ downloaded\ then\ re\-uploaded. - -###\ Move\ ### - -Used\ when\ moving/renaming\ an\ object\ on\ the\ same\ remote.\ \ This\ is\ known -as\ a\ server\ side\ move\ of\ a\ file.\ \ This\ is\ used\ in\ `rclone\ move`\ if\ the -server\ doesn\[aq]t\ support\ `DirMove`. - -If\ the\ server\ isn\[aq]t\ capable\ of\ `Move`\ then\ rclone\ simulates\ it\ with -`Copy`\ then\ delete.\ \ If\ the\ server\ doesn\[aq]t\ support\ `Copy`\ then\ rclone -will\ download\ the\ file\ and\ re\-upload\ it. - -###\ DirMove\ ### - -This\ is\ used\ to\ implement\ `rclone\ move`\ to\ move\ a\ directory\ if -possible.\ \ If\ it\ isn\[aq]t\ then\ it\ will\ use\ `Move`\ on\ each\ file\ (which -falls\ back\ to\ `Copy`\ then\ download\ and\ upload\ \-\ see\ `Move`\ section). - -###\ CleanUp\ ### - -This\ is\ used\ for\ emptying\ the\ trash\ for\ a\ remote\ by\ `rclone\ cleanup`. - -If\ the\ server\ can\[aq]t\ do\ `CleanUp`\ then\ `rclone\ cleanup`\ will\ return\ an -error. - -###\ ListR\ ### - -The\ remote\ supports\ a\ recursive\ list\ to\ list\ all\ the\ contents\ beneath -a\ directory\ quickly.\ \ This\ enables\ the\ `\-\-fast\-list`\ flag\ to\ work. -See\ the\ [rclone\ docs](/docs/#fast\-list)\ for\ more\ details. - -###\ StreamUpload\ ### - -Some\ remotes\ allow\ files\ to\ be\ uploaded\ without\ knowing\ the\ file\ size -in\ advance.\ This\ allows\ certain\ operations\ to\ work\ without\ spooling\ the -file\ to\ local\ disk\ first,\ e.g.\ `rclone\ rcat`. - -###\ LinkSharing\ ### - -Sets\ the\ necessary\ permissions\ on\ a\ file\ or\ folder\ and\ prints\ a\ link -that\ allows\ others\ to\ access\ them,\ even\ if\ they\ don\[aq]t\ have\ an\ account -on\ the\ particular\ cloud\ provider. - -###\ About\ ### - -This\ is\ used\ to\ fetch\ quota\ information\ from\ the\ remote,\ like\ bytes -used/free/quota\ and\ bytes\ used\ in\ the\ trash. - -This\ is\ also\ used\ to\ return\ the\ space\ used,\ available\ for\ `rclone\ mount`. - -If\ the\ server\ can\[aq]t\ do\ `About`\ then\ `rclone\ about`\ will\ return\ an -error. - -###\ EmptyDir\ ### - -The\ remote\ supports\ empty\ directories.\ See\ [Limitations](/bugs/#limitations) -\ for\ details.\ Most\ Object/Bucket\ based\ remotes\ do\ not\ support\ this. - -#\ Global\ Flags - -This\ describes\ the\ global\ flags\ available\ to\ every\ rclone\ command -split\ into\ two\ groups,\ non\ backend\ and\ backend\ flags. - -##\ Non\ Backend\ Flags - -These\ flags\ are\ available\ for\ every\ command. -\f[] +$ 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 .IP .nf \f[C] -\ \ \-\-ask\-password\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Allow\ prompt\ for\ password\ for\ encrypted\ configuration.\ (default\ true) -\ \ \-\-auto\-confirm\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ enabled,\ do\ not\ request\ console\ confirmation. -\ \ \-\-backup\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Make\ backups\ into\ hierarchy\ based\ in\ DIR. -\ \ \-\-bind\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Local\ address\ to\ bind\ to\ for\ outgoing\ connections,\ IPv4,\ IPv6\ or\ name. -\ \ \-\-buffer\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ In\ memory\ buffer\ size\ when\ reading\ files\ for\ each\ \-\-transfer.\ (default\ 16M) -\ \ \-\-bwlimit\ BwTimetable\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Bandwidth\ limit\ in\ kBytes/s,\ or\ use\ suffix\ b|k|M|G\ or\ a\ full\ timetable. -\ \ \-\-ca\-cert\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ CA\ certificate\ used\ to\ verify\ servers -\ \ \-\-cache\-dir\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ rclone\ will\ use\ for\ caching.\ (default\ "$HOME/.cache/rclone") -\ \ \-\-checkers\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Number\ of\ checkers\ to\ run\ in\ parallel.\ (default\ 8) -\f[] +curl http://localhost:5572/debug/pprof/goroutine?debug=1 +\f[R] .fi .PP -\-c, \[en]checksum Skip based on checksum (if available) & size, not -mod\-time & size \[en]client\-cert string Client SSL certificate (PEM) -for mutual TLS auth \[en]client\-key string Client SSL private key (PEM) -for mutual TLS auth \[en]compare\-dest string use DIR to server side -copy flies from. -\[en]config string Config file. -(default \[lq]$HOME/.config/rclone/rclone.conf\[rq]) \[en]contimeout -duration Connect timeout (default 1m0s) \[en]copy\-dest string Compare -dest to DIR also. -\[en]cpuprofile string Write cpu profile to file \[en]delete\-after When -synchronizing, delete files on destination after transferring (default) -\[en]delete\-before When synchronizing, delete files on destination -before transferring \[en]delete\-during When synchronizing, delete files -during transfer \[en]delete\-excluded Delete files on dest excluded from -sync \[en]disable string Disable a comma separated list of features. -Use help to see a list. -\-n, \[en]dry\-run Do a trial run with no permanent changes \[en]dump -DumpFlags List of items to dump from: -headers,bodies,requests,responses,auth,filters,goroutines,openfiles -\[en]dump\-bodies Dump HTTP headers and bodies \- may contain sensitive -info \[en]dump\-headers Dump HTTP headers \- may contain sensitive info -\[en]exclude stringArray Exclude files matching pattern -\[en]exclude\-from stringArray Read exclude patterns from file -\[en]exclude\-if\-present string Exclude directories if filename is -present \[en]fast\-list Use recursive list if available. -Uses more memory but fewer transactions. -\[en]files\-from stringArray Read list of source\-file names from file -\-f, \[en]filter stringArray Add a file\-filtering rule -\[en]filter\-from stringArray Read filtering patterns from a file -\[en]ignore\-case Ignore case in filters (case insensitive) -\[en]ignore\-case\-sync Ignore case when synchronizing -\[en]ignore\-checksum Skip post copy check of checksums. -\[en]ignore\-errors delete even if there are I/O errors -\[en]ignore\-existing Skip all files that exist on destination -\[en]ignore\-size Ignore size when skipping use mod\-time or checksum. -\-I, \[en]ignore\-times Don't skip files that match size and time \- -transfer all files \[en]immutable Do not modify files. -Fail if existing files have been modified. -\[en]include stringArray Include files matching pattern -\[en]include\-from stringArray Read include patterns from file -\[en]log\-file string Log everything to this file \[en]log\-format -string Comma separated list of log format options (default -\[lq]date,time\[rq]) \[en]log\-level string Log level -DEBUG|INFO|NOTICE|ERROR (default \[lq]NOTICE\[rq]) -\[en]low\-level\-retries int Number of low level retries to do. -(default 10) \[en]max\-age Duration Only transfer files younger than -this in s or suffix ms|s|m|h|d|w|M|y (default off) \[en]max\-backlog int -Maximum number of objects in sync or check backlog. -(default 10000) \[en]max\-delete int When synchronizing, limit the -number of deletes (default \-1) \[en]max\-depth int If set limits the -recursion depth to this. -(default \-1) \[en]max\-size SizeSuffix Only transfer files smaller than -this in k or suffix b|k|M|G (default off) \[en]max\-stats\-groups int -Maximum number of stats groups to keep in memory. -On max oldest is discarded. -(default 1000) \[en]max\-transfer SizeSuffix Maximum size of data to -transfer. -(default off) \[en]memprofile string Write memory profile to file -\[en]min\-age Duration Only transfer files older than this in s or -suffix ms|s|m|h|d|w|M|y (default off) \[en]min\-size SizeSuffix Only -transfer files bigger than this in k or suffix b|k|M|G (default off) -\[en]modify\-window duration Max time diff to be considered the same -(default 1ns) \[en]multi\-thread\-cutoff SizeSuffix Use multi\-thread -downloads for files above this size. -(default 250M) \[en]multi\-thread\-streams int Max number of streams to -use for multi\-thread downloads. -(default 4) \[en]no\-check\-certificate Do not verify the server SSL -certificate. -Insecure. -\[en]no\-gzip\-encoding Don't set Accept\-Encoding: gzip. -\[en]no\-traverse Don't traverse destination file system on copy. -\[en]no\-update\-modtime Don't update destination mod\-time if files -identical. -\-P, \[en]progress Show progress during transfer. -\-q, \[en]quiet Print as little stuff as possible \[en]rc Enable the -remote control server. -\[en]rc\-addr string IPaddress:Port or :Port to bind server to. -(default \[lq]localhost:5572\[rq]) \[en]rc\-allow\-origin string Set the -allowed origin for CORS. -\[en]rc\-baseurl string Prefix for URLs \- leave blank for root. -\[en]rc\-cert string SSL PEM key (concatenation of certificate and CA -certificate) \[en]rc\-client\-ca string Client certificate authority to -verify clients with \[en]rc\-files string Path to local files to serve -on the HTTP server. -\[en]rc\-htpasswd string htpasswd file \- if not provided no -authentication is done \[en]rc\-job\-expire\-duration duration expire -finished async jobs older than this value (default 1m0s) -\[en]rc\-job\-expire\-interval duration interval to check for expired -async jobs (default 10s) \[en]rc\-key string SSL PEM Private key -\[en]rc\-max\-header\-bytes int Maximum size of request header (default -4096) \[en]rc\-no\-auth Don't require auth for certain methods. -\[en]rc\-pass string Password for authentication. -\[en]rc\-realm string realm for authentication (default -\[lq]rclone\[rq]) \[en]rc\-serve Enable the serving of remote objects. -\[en]rc\-server\-read\-timeout duration Timeout for server reading data -(default 1h0m0s) \[en]rc\-server\-write\-timeout duration Timeout for -server writing data (default 1h0m0s) \[en]rc\-user string User name for -authentication. -\[en]rc\-web\-fetch\-url string URL to fetch the releases for webgui. -(default -\[lq]https://api.github.com/repos/rclone/rclone\-webui\-react/releases/latest\[rq]) -\[en]rc\-web\-gui Launch WebGUI on localhost \[en]rc\-web\-gui\-update -Update / Force update to latest version of web gui \[en]retries int -Retry operations this many times if they fail (default 3) -\[en]retries\-sleep duration Interval between retrying operations if -they fail, e.g 500ms, 60s, 5m. -(0 to disable) \[en]size\-only Skip based on size only, not mod\-time or -checksum \[en]stats duration Interval between printing stats, e.g 500ms, -60s, 5m. -(0 to disable) (default 1m0s) \[en]stats\-file\-name\-length int Max -file name length in stats. -0 for no limit (default 45) \[en]stats\-log\-level string Log level to -show \[en]stats output DEBUG|INFO|NOTICE|ERROR (default \[lq]INFO\[rq]) -\[en]stats\-one\-line Make the stats fit on one line. -\[en]stats\-one\-line\-date Enables \[en]stats\-one\-line and add -current date/time prefix. -\[en]stats\-one\-line\-date\-format string Enables -\[en]stats\-one\-line\-date and uses custom formatted date. -Enclose date string in double quotes (\[lq]). See -https://golang.org/pkg/time/#Time.Format \[en]stats\-unit string Show -data rate in stats as either `bits' or `bytes'/s -(default\[rq]bytes\[lq]) \[en]streaming\-upload\-cutoff SizeSuffix -Cutoff for switching to chunked upload if file size is unknown. Upload -starts after reaching cutoff or when file ends. (default 100k) -\[en]suffix string Suffix to add to changed files. -\[en]suffix\-keep\-extension Preserve the extension when using -\[en]suffix. \[en]syslog Use Syslog for logging \[en]syslog\-facility -string Facility for syslog, eg KERN,USER,\&... (default\[rq]DAEMON\[lq]) -\[en]timeout duration IO idle timeout (default 5m0s) \[en]tpslimit float -Limit HTTP transactions per second to this. \[en]tpslimit\-burst int Max -burst of transactions for \[en]tpslimit. (default 1) \[en]track\-renames -When synchronizing, track file renames and do a server side move if -possible \[en]transfers int Number of file transfers to run in parallel. -(default 4) \-u, \[en]update Skip files that are newer on the -destination. \[en]use\-cookies Enable session cookiejar. -\[en]use\-json\-log Use json log format. \[en]use\-mmap Use mmap -allocator (see docs). \[en]use\-server\-modtime Use server modified time -instead of object metadata \[en]user\-agent string Set the user\-agent -to a specified string. The default is rclone/ version -(default\[rq]rclone/v1.50.0") \-v, \[en]verbose count Print lots more -stuff (repeat for more) -.IP -.nf -\f[C] - -##\ Backend\ Flags - -These\ flags\ are\ available\ for\ every\ command.\ They\ control\ the\ backends -and\ may\ be\ set\ in\ the\ config\ file. -\f[] -.fi -.IP -.nf -\f[C] -\ \ \-\-acd\-auth\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Auth\ server\ URL. -\ \ \-\-acd\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ ID. -\ \ \-\-acd\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Amazon\ Application\ Client\ Secret. -\ \ \-\-acd\-templink\-threshold\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ Files\ >=\ this\ size\ will\ be\ downloaded\ via\ their\ tempLink.\ (default\ 9G) -\ \ \-\-acd\-token\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Token\ server\ url. -\ \ \-\-acd\-upload\-wait\-per\-gb\ Duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ Additional\ time\ per\ GB\ to\ wait\ after\ a\ failed\ complete\ upload\ to\ see\ if\ it\ appears.\ (default\ 3m0s) -\ \ \-\-alias\-remote\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remote\ or\ path\ to\ alias. -\ \ \-\-azureblob\-access\-tier\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Access\ tier\ of\ blob:\ hot,\ cool\ or\ archive. -\ \ \-\-azureblob\-account\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Storage\ Account\ Name\ (leave\ blank\ to\ use\ SAS\ URL\ or\ Emulator) -\ \ \-\-azureblob\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ Upload\ chunk\ size\ (<=\ 100MB).\ (default\ 4M) -\ \ \-\-azureblob\-endpoint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Endpoint\ for\ the\ service -\ \ \-\-azureblob\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Storage\ Account\ Key\ (leave\ blank\ to\ use\ SAS\ URL\ or\ Emulator) -\ \ \-\-azureblob\-list\-chunk\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Size\ of\ blob\ list.\ (default\ 5000) -\ \ \-\-azureblob\-sas\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ SAS\ URL\ for\ container\ level\ access\ only -\ \ \-\-azureblob\-upload\-cutoff\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ Cutoff\ for\ switching\ to\ chunked\ upload\ (<=\ 256MB).\ (default\ 256M) -\ \ \-\-azureblob\-use\-emulator\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Uses\ local\ storage\ emulator\ if\ provided\ as\ \[aq]true\[aq]\ (leave\ blank\ if\ using\ real\ azure\ storage\ endpoint) -\ \ \-\-b2\-account\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Account\ ID\ or\ Application\ Key\ ID -\ \ \-\-b2\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Upload\ chunk\ size.\ Must\ fit\ in\ memory.\ (default\ 96M) -\ \ \-\-b2\-disable\-checksum\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Disable\ checksums\ for\ large\ (>\ upload\ cutoff)\ files -\ \ \-\-b2\-download\-auth\-duration\ Duration\ \ \ \ \ \ \ \ \ \ \ Time\ before\ the\ authorization\ token\ will\ expire\ in\ s\ or\ suffix\ ms|s|m|h|d.\ (default\ 1w) -\ \ \-\-b2\-download\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Custom\ endpoint\ for\ downloads. -\ \ \-\-b2\-endpoint\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Endpoint\ for\ the\ service. -\ \ \-\-b2\-hard\-delete\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Permanently\ delete\ files\ on\ remote\ removal,\ otherwise\ hide\ files. -\ \ \-\-b2\-key\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Application\ Key -\ \ \-\-b2\-test\-mode\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ A\ flag\ string\ for\ X\-Bz\-Test\-Mode\ header\ for\ debugging. -\ \ \-\-b2\-upload\-cutoff\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cutoff\ for\ switching\ to\ chunked\ upload.\ (default\ 200M) -\ \ \-\-b2\-versions\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Include\ old\ versions\ in\ directory\ listings. -\ \ \-\-box\-box\-config\-file\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ config.json\ location -\ \ \-\-box\-box\-sub\-type\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ (default\ "user") -\ \ \-\-box\-client\-id\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Id. -\ \ \-\-box\-client\-secret\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Box\ App\ Client\ Secret -\ \ \-\-box\-commit\-retries\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Max\ number\ of\ times\ to\ try\ committing\ a\ multipart\ file.\ (default\ 100) -\ \ \-\-box\-upload\-cutoff\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cutoff\ for\ switching\ to\ multipart\ upload\ (>=\ 50MB).\ (default\ 50M) -\ \ \-\-cache\-chunk\-clean\-interval\ Duration\ \ \ \ \ \ \ \ \ \ How\ often\ should\ the\ cache\ perform\ cleanups\ of\ the\ chunk\ storage.\ (default\ 1m0s) -\ \ \-\-cache\-chunk\-no\-memory\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Disable\ the\ in\-memory\ cache\ for\ storing\ chunks\ during\ streaming. -\ \ \-\-cache\-chunk\-path\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ to\ cache\ chunk\ files.\ (default\ "$HOME/.cache/rclone/cache\-backend") -\ \ \-\-cache\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ size\ of\ a\ chunk\ (partial\ file\ data).\ (default\ 5M) -\ \ \-\-cache\-chunk\-total\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ The\ total\ size\ that\ the\ chunks\ can\ take\ up\ on\ the\ local\ disk.\ (default\ 10G) -\ \ \-\-cache\-db\-path\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ to\ store\ file\ structure\ metadata\ DB.\ (default\ "$HOME/.cache/rclone/cache\-backend") -\ \ \-\-cache\-db\-purge\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Clear\ all\ the\ cached\ data\ for\ this\ remote\ on\ start. -\ \ \-\-cache\-db\-wait\-time\ Duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ How\ long\ to\ wait\ for\ the\ DB\ to\ be\ available\ \-\ 0\ is\ unlimited\ (default\ 1s) -\ \ \-\-cache\-info\-age\ Duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ How\ long\ to\ cache\ file\ structure\ information\ (directory\ listings,\ file\ size,\ times\ etc).\ (default\ 6h0m0s) -\ \ \-\-cache\-plex\-insecure\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Skip\ all\ certificate\ verifications\ when\ connecting\ to\ the\ Plex\ server -\ \ \-\-cache\-plex\-password\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ password\ of\ the\ Plex\ user -\ \ \-\-cache\-plex\-url\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ URL\ of\ the\ Plex\ server -\ \ \-\-cache\-plex\-username\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ username\ of\ the\ Plex\ user -\ \ \-\-cache\-read\-retries\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ How\ many\ times\ to\ retry\ a\ read\ from\ a\ cache\ storage.\ (default\ 10) -\ \ \-\-cache\-remote\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remote\ to\ cache. -\ \ \-\-cache\-rps\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Limits\ the\ number\ of\ requests\ per\ second\ to\ the\ source\ FS\ (\-1\ to\ disable)\ (default\ \-1) -\ \ \-\-cache\-tmp\-upload\-path\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Directory\ to\ keep\ temporary\ files\ until\ they\ are\ uploaded. -\ \ \-\-cache\-tmp\-wait\-time\ Duration\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ How\ long\ should\ files\ be\ stored\ in\ local\ cache\ before\ being\ uploaded\ (default\ 15s) -\ \ \-\-cache\-workers\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ How\ many\ workers\ should\ run\ in\ parallel\ to\ download\ chunks.\ (default\ 4) -\ \ \-\-cache\-writes\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Cache\ file\ data\ on\ writes\ through\ the\ FS -\ \ \-\-chunker\-chunk\-size\ SizeSuffix\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Files\ larger\ than\ chunk\ size\ will\ be\ split\ in\ chunks.\ (default\ 2G) -\ \ \-\-chunker\-fail\-hard\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Choose\ how\ chunker\ should\ handle\ files\ with\ missing\ or\ invalid\ chunks. -\ \ \-\-chunker\-hash\-type\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Choose\ how\ chunker\ handles\ hash\ sums.\ All\ modes\ but\ "none"\ require\ metadata.\ (default\ "md5") -\ \ \-\-chunker\-meta\-format\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Format\ of\ the\ metadata\ object\ or\ "none".\ By\ default\ "simplejson".\ (default\ "simplejson") -\ \ \-\-chunker\-name\-format\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ String\ format\ of\ chunk\ file\ names.\ (default\ "*.rclone_chunk.###") -\ \ \-\-chunker\-remote\ string\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Remote\ to\ chunk/unchunk. -\ \ \-\-chunker\-start\-from\ int\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Minimum\ valid\ chunk\ number.\ Usually\ 0\ or\ 1.\ (default\ 1) -\f[] -.fi +Or go to http://localhost:5572/debug/pprof/goroutine?debug=1 in your +browser. +.SS Other profiles to look at .PP -\-L, \[en]copy\-links Follow symlinks and copy the pointed to item. -\[en]crypt\-directory\-name\-encryption Option to either encrypt -directory names or leave them intact. -(default true) \[en]crypt\-filename\-encryption string How to encrypt -the filenames. -(default \[lq]standard\[rq]) \[en]crypt\-password string Password or -pass phrase for encryption. -\[en]crypt\-password2 string Password or pass phrase for salt. -Optional but recommended. -\[en]crypt\-remote string Remote to encrypt/decrypt. -\[en]crypt\-show\-mapping For all files listed show how the names -encrypt. -\[en]drive\-acknowledge\-abuse Set to allow files which return -cannotDownloadAbusiveFile to be downloaded. -\[en]drive\-allow\-import\-name\-change Allow the filetype to change -when uploading Google docs (e.g.\ file.doc to file.docx). -This will confuse sync and reupload every time. -\[en]drive\-alternate\-export Use alternate export URLs for google -documents export., \[en]drive\-auth\-owner\-only Only consider files -owned by the authenticated user. -\[en]drive\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 8M) \[en]drive\-client\-id string Google Application Client Id -\[en]drive\-client\-secret string Google Application Client Secret -\[en]drive\-disable\-http2 Disable drive using http2 (default true) -\[en]drive\-export\-formats string Comma separated list of preferred -formats for downloading Google docs. -(default \[lq]docx,xlsx,pptx,svg\[rq]) \[en]drive\-formats string -Deprecated: see export_formats \[en]drive\-impersonate string -Impersonate this user when using a service account. -\[en]drive\-import\-formats string Comma separated list of preferred -formats for uploading Google docs. -\[en]drive\-keep\-revision\-forever Keep new head revision of each file -forever. -\[en]drive\-list\-chunk int Size of listing chunk 100\-1000. -0 to disable. -(default 1000) \[en]drive\-pacer\-burst int Number of API calls to allow -without sleeping. -(default 100) \[en]drive\-pacer\-min\-sleep Duration Minimum time to -sleep between API calls. -(default 100ms) \[en]drive\-root\-folder\-id string ID of the root -folder \[en]drive\-scope string Scope that rclone should use when -requesting access from drive. -\[en]drive\-server\-side\-across\-configs Allow server side operations -(eg copy) to work across different drive configs. -\[en]drive\-service\-account\-credentials string Service Account -Credentials JSON blob \[en]drive\-service\-account\-file string Service -Account Credentials JSON file path \[en]drive\-shared\-with\-me Only -show files that are shared with me. -\[en]drive\-size\-as\-quota Show storage quota usage for file size. -\[en]drive\-skip\-checksum\-gphotos Skip MD5 checksum on Google photos -and videos only. -\[en]drive\-skip\-gdocs Skip google documents in all listings. -\[en]drive\-team\-drive string ID of the Team Drive -\[en]drive\-trashed\-only Only show files that are in the trash. -\[en]drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked -upload (default 8M) \[en]drive\-use\-created\-date Use file created date -instead of modified date., \[en]drive\-use\-trash Send files to the -trash instead of deleting permanently. -(default true) \[en]drive\-v2\-download\-min\-size SizeSuffix If -Object's are greater, use drive v2 API to download. -(default off) \[en]dropbox\-chunk\-size SizeSuffix Upload chunk size. -(< 150M). -(default 48M) \[en]dropbox\-client\-id string Dropbox App Client Id -\[en]dropbox\-client\-secret string Dropbox App Client Secret -\[en]dropbox\-impersonate string Impersonate this user when using a -business account. -\[en]fichier\-api\-key string Your API Key, get it from -https://1fichier.com/console/params.pl \[en]fichier\-shared\-folder -string If you want to download a shared folder, add this parameter -\[en]ftp\-concurrency int Maximum number of FTP simultaneous -connections, 0 for unlimited \[en]ftp\-disable\-epsv Disable using EPSV -even if server advertises support \[en]ftp\-host string FTP host to -connect to \[en]ftp\-no\-check\-certificate Do not verify the TLS -certificate of the server \[en]ftp\-pass string FTP password -\[en]ftp\-port string FTP port, leave blank to use default (21) -\[en]ftp\-tls Use FTP over TLS (Implicit) \[en]ftp\-user string FTP -username, leave blank for current username, $USER \[en]gcs\-bucket\-acl -string Access Control List for new buckets. -\[en]gcs\-bucket\-policy\-only Access checks should use bucket\-level -IAM policies. -\[en]gcs\-client\-id string Google Application Client Id -\[en]gcs\-client\-secret string Google Application Client Secret -\[en]gcs\-location string Location for the newly created buckets. -\[en]gcs\-object\-acl string Access Control List for new objects. -\[en]gcs\-project\-number string Project number. -\[en]gcs\-service\-account\-file string Service Account Credentials JSON -file path \[en]gcs\-storage\-class string The storage class to use when -storing objects in Google Cloud Storage. -\[en]gphotos\-client\-id string Google Application Client Id -\[en]gphotos\-client\-secret string Google Application Client Secret -\[en]gphotos\-read\-only Set to make the Google Photos backend read -only. -\[en]gphotos\-read\-size Set to read the size of media items. -\[en]http\-headers CommaSepList Set HTTP headers for all transactions -\[en]http\-no\-head Don't use HEAD requests to find file sizes in dir -listing \[en]http\-no\-slash Set this if the site doesn't end -directories with / \[en]http\-url string URL of http host to connect to -\[en]hubic\-chunk\-size SizeSuffix Above this size files will be chunked -into a _segments container. -(default 5G) \[en]hubic\-client\-id string Hubic Client Id -\[en]hubic\-client\-secret string Hubic Client Secret -\[en]hubic\-no\-chunk Don't chunk files during streaming upload. -\[en]jottacloud\-hard\-delete Delete files permanently rather than -putting them into the trash. -\[en]jottacloud\-md5\-memory\-limit SizeSuffix Files bigger than this -will be cached on disk to calculate the MD5 if required. -(default 10M) \[en]jottacloud\-unlink Remove existing public link to -file/folder with link command rather than creating. -\[en]jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this -can be resumed if the upload fail's. -(default 10M) \[en]koofr\-endpoint string The Koofr API endpoint to use -(default \[lq]https://app.koofr.net\[rq]) \[en]koofr\-mountid string -Mount ID of the mount to use. -If omitted, the primary mount is used. -\[en]koofr\-password string Your Koofr password for rclone (generate one -at https://app.koofr.net/app/admin/preferences/password) -\[en]koofr\-setmtime Does the backend support setting modification time. -Set this to false if you use a mount ID that points to a Dropbox or -Amazon Drive backend. -(default true) \[en]koofr\-user string Your Koofr user name \-l, -\[en]links Translate symlinks to/from regular files with a `.rclonelink' -extension \[en]local\-case\-insensitive Force the filesystem to report -itself as case insensitive \[en]local\-case\-sensitive Force the -filesystem to report itself as case sensitive. -\[en]local\-no\-check\-updated Don't check to see if the files change -during upload \[en]local\-no\-unicode\-normalization Don't apply unicode -normalization to paths and filenames (Deprecated) \[en]local\-nounc -string Disable UNC (long path names) conversion on Windows -\[en]mailru\-check\-hash What should copy do if file checksum is -mismatched or invalid (default true) \[en]mailru\-pass string Password -\[en]mailru\-speedup\-enable Skip full upload if there is another file -with same data hash. -(default true) \[en]mailru\-speedup\-file\-patterns string Comma -separated list of file name patterns eligible for speedup (put by hash). -(default -\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3,\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq]) -\[en]mailru\-speedup\-max\-disk SizeSuffix This option allows you to -disable speedup (put by hash) for large files (default 3G) -\[en]mailru\-speedup\-max\-memory SizeSuffix Files larger than the size -given below will always be hashed on disk. -(default 32M) \[en]mailru\-user string User name (usually email) -\[en]mega\-debug Output more debug from Mega. -\[en]mega\-hard\-delete Delete files permanently rather than putting -them into the trash. -\[en]mega\-pass string Password. -\[en]mega\-user string User name \-x, \[en]one\-file\-system Don't cross -filesystem boundaries (unix/macOS only). -\[en]onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- -must be multiple of 320k (327,680 bytes). -(default 10M) \[en]onedrive\-client\-id string Microsoft App Client Id -\[en]onedrive\-client\-secret string Microsoft App Client Secret -\[en]onedrive\-drive\-id string The ID of the drive to use -\[en]onedrive\-drive\-type string The type of the drive ( personal | -business | documentLibrary ) \[en]onedrive\-expose\-onenote\-files Set -to make OneNote files show up in directory listings. -\[en]opendrive\-password string Password. -\[en]opendrive\-username string Username \[en]pcloud\-client\-id string -Pcloud App Client Id \[en]pcloud\-client\-secret string Pcloud App -Client Secret \[en]qingstor\-access\-key\-id string QingStor Access Key -ID \[en]qingstor\-chunk\-size SizeSuffix Chunk size to use for -uploading. -(default 4M) \[en]qingstor\-connection\-retries int Number of connection -retries. -(default 3) \[en]qingstor\-endpoint string Enter a endpoint URL to -connection QingStor API. -\[en]qingstor\-env\-auth Get QingStor credentials from runtime. -Only applies if access_key_id and secret_access_key is blank. -\[en]qingstor\-secret\-access\-key string QingStor Secret Access Key -(password) \[en]qingstor\-upload\-concurrency int Concurrency for -multipart uploads. -(default 1) \[en]qingstor\-upload\-cutoff SizeSuffix Cutoff for -switching to chunked upload (default 200M) \[en]qingstor\-zone string -Zone to connect to. -\[en]s3\-access\-key\-id string AWS Access Key ID. -\[en]s3\-acl string Canned ACL used when creating buckets and storing or -copying objects. -\[en]s3\-bucket\-acl string Canned ACL used when creating buckets. -\[en]s3\-chunk\-size SizeSuffix Chunk size to use for uploading. -(default 5M) \[en]s3\-disable\-checksum Don't store MD5 checksum with -object metadata \[en]s3\-endpoint string Endpoint for S3 API. -\[en]s3\-env\-auth Get AWS credentials from runtime (environment -variables or EC2/ECS meta data if no env vars). -\[en]s3\-force\-path\-style If true use path style access if false use -virtual hosted style. -(default true) \[en]s3\-leave\-parts\-on\-error If true avoid calling -abort upload on a failure, leaving all successfully uploaded parts on S3 -for manual recovery. -\[en]s3\-location\-constraint string Location constraint \- must be set -to match the Region. -\[en]s3\-provider string Choose your S3 provider. -\[en]s3\-region string Region to connect to. -\[en]s3\-secret\-access\-key string AWS Secret Access Key (password) -\[en]s3\-server\-side\-encryption string The server\-side encryption -algorithm used when storing this object in S3. -\[en]s3\-session\-token string An AWS session token -\[en]s3\-sse\-kms\-key\-id string If using KMS ID you must provide the -ARN of Key. -\[en]s3\-storage\-class string The storage class to use when storing new -objects in S3. -\[en]s3\-upload\-concurrency int Concurrency for multipart uploads. -(default 4) \[en]s3\-upload\-cutoff SizeSuffix Cutoff for switching to -chunked upload (default 200M) \[en]s3\-use\-accelerate\-endpoint If true -use the AWS S3 accelerated endpoint. -\[en]s3\-v2\-auth If true use v2 authentication. -\[en]sftp\-ask\-password Allow asking for SFTP password when needed. -\[en]sftp\-disable\-hashcheck Disable the execution of SSH commands to -determine if remote file hashing is available. -\[en]sftp\-host string SSH host to connect to \[en]sftp\-key\-file -string Path to PEM\-encoded private key file, leave blank or set -key\-use\-agent to use ssh\-agent. -\[en]sftp\-key\-file\-pass string The passphrase to decrypt the -PEM\-encoded private key file. -\[en]sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. -\[en]sftp\-md5sum\-command string The command used to read md5 hashes. -Leave blank for autodetect. -\[en]sftp\-pass string SSH password, leave blank to use ssh\-agent. -\[en]sftp\-path\-override string Override path used by SSH connection. -\[en]sftp\-port string SSH port, leave blank to use default (22) -\[en]sftp\-set\-modtime Set the modified time on the remote if set. -(default true) \[en]sftp\-sha1sum\-command string The command used to -read sha1 hashes. -Leave blank for autodetect. -\[en]sftp\-use\-insecure\-cipher Enable the use of insecure ciphers and -key exchange methods. -\[en]sftp\-user string SSH username, leave blank for current username, -ncw \[en]sharefile\-chunk\-size SizeSuffix Upload chunk size. -Must a power of 2 >= 256k. -(default 64M) \[en]sharefile\-endpoint string Endpoint for API calls. -\[en]sharefile\-root\-folder\-id string ID of the root folder -\[en]sharefile\-upload\-cutoff SizeSuffix Cutoff for switching to -multipart upload. -(default 128M) \[en]skip\-links Don't warn about skipped symlinks. -\[en]swift\-application\-credential\-id string Application Credential ID -(OS_APPLICATION_CREDENTIAL_ID) \[en]swift\-application\-credential\-name -string Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) -\[en]swift\-application\-credential\-secret string Application -Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) \[en]swift\-auth -string Authentication URL for server (OS_AUTH_URL). -\[en]swift\-auth\-token string Auth Token from alternate authentication -\- optional (OS_AUTH_TOKEN) \[en]swift\-auth\-version int AuthVersion \- -optional \- set to (1,2,3) if your auth URL has no version -(ST_AUTH_VERSION) \[en]swift\-chunk\-size SizeSuffix Above this size -files will be chunked into a _segments container. -(default 5G) \[en]swift\-domain string User domain \- optional (v3 auth) -(OS_USER_DOMAIN_NAME) \[en]swift\-endpoint\-type string Endpoint type to -choose from the service catalogue (OS_ENDPOINT_TYPE) (default -\[lq]public\[rq]) \[en]swift\-env\-auth Get swift credentials from -environment variables in standard OpenStack form. -\[en]swift\-key string API key or password (OS_PASSWORD). -\[en]swift\-no\-chunk Don't chunk files during streaming upload. -\[en]swift\-region string Region name \- optional (OS_REGION_NAME) -\[en]swift\-storage\-policy string The storage policy to use when -creating a new container \[en]swift\-storage\-url string Storage URL \- -optional (OS_STORAGE_URL) \[en]swift\-tenant string Tenant name \- -optional for v1 auth, this or tenant_id required otherwise -(OS_TENANT_NAME or OS_PROJECT_NAME) \[en]swift\-tenant\-domain string -Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) -\[en]swift\-tenant\-id string Tenant ID \- optional for v1 auth, this or -tenant required otherwise (OS_TENANT_ID) \[en]swift\-user string User -name to log in (OS_USERNAME). -\[en]swift\-user\-id string User ID to log in \- optional \- most swift -systems use user and leave this blank (v3 auth) (OS_USER_ID). -\[en]union\-remotes string List of space separated remotes. -\[en]webdav\-bearer\-token string Bearer token instead of user/pass (eg -a Macaroon) \[en]webdav\-bearer\-token\-command string Command to run to -get a bearer token \[en]webdav\-pass string Password. -\[en]webdav\-url string URL of http host to connect to \[en]webdav\-user -string User name \[en]webdav\-vendor string Name of the Webdav -site/service/software you are using \[en]yandex\-client\-id string -Yandex Client Id \[en]yandex\-client\-secret string Yandex Client Secret -\[en]yandex\-unlink Remove existing public link to file/folder with link -command rather than creating. -.IP -.nf -\f[C] - -1Fichier -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -This\ is\ a\ backend\ for\ the\ [1ficher](https://1fichier.com)\ cloud -storage\ service.\ Note\ that\ a\ Premium\ subscription\ is\ required\ to\ use -the\ API. - -Paths\ are\ specified\ as\ `remote:path` - -Paths\ may\ be\ as\ deep\ as\ required,\ eg\ `remote:directory/subdirectory`. - -The\ initial\ setup\ for\ 1Fichier\ involves\ getting\ the\ API\ key\ from\ the\ website\ which\ you -need\ to\ do\ in\ your\ browser. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi +You can see a summary of profiles available at +http://localhost:5572/debug/pprof/ .PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value [snip] XX / 1Fichier \ \[rq]fichier" [snip] -Storage> fichier ** See help for fichier backend at: -https://rclone.org/fichier/ ** -.PP -Your API Key, get it from https://1fichier.com/console/params.pl Enter a -string value. -Press Enter for the default (""). -api_key> example_key -.PP -Edit advanced config? -(y/n) y) Yes n) No y/n> Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = fichier api_key = -example_key \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) -Edit this remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -Once\ configured\ you\ can\ then\ use\ `rclone`\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ 1Fichier\ account - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ 1Fichier\ account - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ a\ 1Fichier\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -###\ Modified\ time\ and\ hashes\ ### - -1Fichier\ does\ not\ support\ modification\ times.\ It\ supports\ the\ Whirlpool\ hash\ algorithm. - -###\ Duplicated\ files\ ### - -1Fichier\ can\ have\ two\ files\ with\ exactly\ the\ same\ name\ and\ path\ (unlike\ a -normal\ file\ system). - -Duplicated\ files\ cause\ problems\ with\ the\ syncing\ and\ you\ will\ see -messages\ in\ the\ log\ about\ duplicates. - -####\ Restricted\ filename\ characters - -In\ addition\ to\ the\ [default\ restricted\ characters\ set](/overview/#restricted\-characters) -the\ following\ characters\ are\ also\ replaced: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | -|\ <\ \ \ \ \ \ \ \ \ |\ 0x3C\ \ |\ ＜\ \ \ \ \ \ \ \ \ \ \ | -|\ >\ \ \ \ \ \ \ \ \ |\ 0x3E\ \ |\ ＞\ \ \ \ \ \ \ \ \ \ \ | -|\ "\ \ \ \ \ \ \ \ \ |\ 0x22\ \ |\ ＂\ \ \ \ \ \ \ \ \ \ \ | -|\ $\ \ \ \ \ \ \ \ \ |\ 0x24\ \ |\ ＄\ \ \ \ \ \ \ \ \ \ \ | -|\ `\ \ \ \ \ \ \ \ \ |\ 0x60\ \ |\ ｀\ \ \ \ \ \ \ \ \ \ \ | -|\ \[aq]\ \ \ \ \ \ \ \ \ |\ 0x27\ \ |\ ＇\ \ \ \ \ \ \ \ \ \ \ | - -File\ names\ can\ also\ not\ start\ or\ end\ with\ the\ following\ characters. -These\ only\ get\ replaced\ if\ they\ are\ first\ or\ last\ character\ in\ the -name: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ fichier\ (1Fichier). - -####\ \-\-fichier\-api\-key - -Your\ API\ Key,\ get\ it\ from\ https://1fichier.com/console/params.pl - -\-\ Config:\ \ \ \ \ \ api_key -\-\ Env\ Var:\ \ \ \ \ RCLONE_FICHIER_API_KEY -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ fichier\ (1Fichier). - -####\ \-\-fichier\-shared\-folder - -If\ you\ want\ to\ download\ a\ shared\ folder,\ add\ this\ parameter - -\-\ Config:\ \ \ \ \ \ shared_folder -\-\ Env\ Var:\ \ \ \ \ RCLONE_FICHIER_SHARED_FOLDER -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - - - -Alias -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ `alias`\ remote\ provides\ a\ new\ name\ for\ another\ remote. - -Paths\ may\ be\ as\ deep\ as\ required\ or\ a\ local\ path,\ -eg\ `remote:directory/subdirectory`\ or\ `/directory/subdirectory`. - -During\ the\ initial\ setup\ with\ `rclone\ config`\ you\ will\ specify\ the\ target -remote.\ The\ target\ remote\ can\ either\ be\ a\ local\ path\ or\ another\ remote. - -Subfolders\ can\ be\ used\ in\ target\ remote.\ Assume\ a\ alias\ remote\ named\ `backup` -with\ the\ target\ `mydrive:private/backup`.\ Invoking\ `rclone\ mkdir\ backup:desktop` -is\ exactly\ the\ same\ as\ invoking\ `rclone\ mkdir\ mydrive:private/backup/desktop`. - -There\ will\ be\ no\ special\ handling\ of\ paths\ containing\ `..`\ segments. -Invoking\ `rclone\ mkdir\ backup:../desktop`\ is\ exactly\ the\ same\ as\ invoking -`rclone\ mkdir\ mydrive:private/backup/../desktop`. -The\ empty\ path\ is\ not\ allowed\ as\ a\ remote.\ To\ alias\ the\ current\ directory -use\ `.`\ instead. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ alias\ called\ `remote`\ for\ local\ folder. -First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Alias -for an existing remote \ \[lq]alias\[rq] [snip] Storage> alias Remote or -path to alias. -Can be \[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq], -\[lq]myremote:\[rq] or \[lq]/local/path\[rq]. -remote> /mnt/storage/backup Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] remote = -/mnt/storage/backup \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is -OK e) Edit this remote d) Delete this remote y/e/d> y Current remotes: -.PP -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\ `rclone`\ like\ this, - -List\ directories\ in\ top\ level\ in\ `/mnt/storage/backup` - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ `/mnt/storage/backup` - -\ \ \ \ rclone\ ls\ remote: - -Copy\ another\ local\ directory\ to\ the\ alias\ directory\ called\ source - -\ \ \ \ rclone\ copy\ /home/source\ remote:source - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ alias\ (Alias\ for\ an\ existing\ remote). - -####\ \-\-alias\-remote - -Remote\ or\ path\ to\ alias. -Can\ be\ "myremote:path/to/dir",\ "myremote:bucket",\ "myremote:"\ or\ "/local/path". - -\-\ Config:\ \ \ \ \ \ remote -\-\ Env\ Var:\ \ \ \ \ RCLONE_ALIAS_REMOTE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - - - -Amazon\ Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Amazon\ Drive,\ formerly\ known\ as\ Amazon\ Cloud\ Drive,\ is\ a\ cloud\ storage -service\ run\ by\ Amazon\ for\ consumers. - -##\ Status - -**Important:**\ rclone\ supports\ Amazon\ Drive\ only\ if\ you\ have\ your\ own -set\ of\ API\ keys.\ Unfortunately\ the\ [Amazon\ Drive\ developer -program](https://developer.amazon.com/amazon\-drive)\ is\ now\ closed\ to -new\ entries\ so\ if\ you\ don\[aq]t\ already\ have\ your\ own\ set\ of\ keys\ you\ will -not\ be\ able\ to\ use\ rclone\ with\ Amazon\ Drive. - -For\ the\ history\ on\ why\ rclone\ no\ longer\ has\ a\ set\ of\ Amazon\ Drive\ API -keys\ see\ [the\ forum](https://forum.rclone.org/t/rclone\-has\-been\-banned\-from\-amazon\-drive/2314). - -If\ you\ happen\ to\ know\ anyone\ who\ works\ at\ Amazon\ then\ please\ ask\ them -to\ re\-instate\ rclone\ into\ the\ Amazon\ Drive\ developer\ program\ \-\ thanks! - -##\ Setup - -The\ initial\ setup\ for\ Amazon\ Drive\ involves\ getting\ a\ token\ from -Amazon\ which\ you\ need\ to\ do\ in\ your\ browser.\ \ `rclone\ config`\ walks -you\ through\ it. - -The\ configuration\ process\ for\ Amazon\ Drive\ may\ involve\ using\ an\ [oauth -proxy](https://github.com/ncw/oauthproxy).\ This\ is\ used\ to\ keep\ the -Amazon\ credentials\ out\ of\ the\ source\ code.\ \ The\ proxy\ runs\ in\ Google\[aq]s -very\ secure\ App\ Engine\ environment\ and\ doesn\[aq]t\ store\ any\ credentials -which\ pass\ through\ it. - -Since\ rclone\ doesn\[aq]t\ currently\ have\ its\ own\ Amazon\ Drive\ credentials -so\ you\ will\ either\ need\ to\ have\ your\ own\ `client_id`\ and -`client_secret`\ with\ Amazon\ Drive,\ or\ use\ a\ a\ third\ party\ ouath\ proxy -in\ which\ case\ you\ will\ need\ to\ enter\ `client_id`,\ `client_secret`, -`auth_url`\ and\ `token_url`. - -Note\ also\ if\ you\ are\ not\ using\ Amazon\[aq]s\ `auth_url`\ and\ `token_url`, -(ie\ you\ filled\ in\ something\ for\ those)\ then\ if\ setting\ up\ on\ a\ remote -machine\ you\ can\ only\ use\ the\ [copying\ the\ config\ method\ of -configuration](https://rclone.org/remote_setup/#configuring\-by\-copying\-the\-config\-file) -\-\ `rclone\ authorize`\ will\ not\ work. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -Drive \ \[lq]amazon cloud drive\[rq] [snip] Storage> amazon cloud drive -Amazon Application Client Id \- required. -client_id> your client ID goes here Amazon Application Client Secret \- -required. -client_secret> your client secret goes here Auth server URL \- leave -blank to use Amazon's. -auth_url> Optional auth URL Token server url \- leave blank to use -Amazon's. -token_url> Optional token URL Remote config Make sure your Redirect URL -is set to \[lq]http://127.0.0.1:53682/\[rq] in your custom config. -Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn't open automatically -go to the following link: http://127.0.0.1:53682/auth Log in and -authorize rclone for access Waiting for code\&... Got code -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] client_id = your client ID -goes here client_secret = your client secret goes here auth_url = -Optional auth URL token_url = Optional token URL token = -{\[lq]access_token\[rq]:\[lq]xxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]xxxxxxxxxxxxxxxxxx\[rq],\[lq]expiry\[rq]:\[lq]2015\-09\-06T16:07:39.658438471+01:00\[rq]} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -See\ the\ [remote\ setup\ docs](https://rclone.org/remote_setup/)\ for\ how\ to\ set\ it\ up\ on\ a -machine\ with\ no\ Internet\ browser\ available. - -Note\ that\ rclone\ runs\ a\ webserver\ on\ your\ local\ machine\ to\ collect\ the -token\ as\ returned\ from\ Amazon.\ This\ only\ runs\ from\ the\ moment\ it -opens\ your\ browser\ to\ the\ moment\ you\ get\ back\ the\ verification -code.\ \ This\ is\ on\ `http://127.0.0.1:53682/`\ and\ this\ it\ may\ require -you\ to\ unblock\ it\ temporarily\ if\ you\ are\ running\ a\ host\ firewall. - -Once\ configured\ you\ can\ then\ use\ `rclone`\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ Amazon\ Drive - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ Amazon\ Drive - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ an\ Amazon\ Drive\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -###\ Modified\ time\ and\ MD5SUMs\ ### - -Amazon\ Drive\ doesn\[aq]t\ allow\ modification\ times\ to\ be\ changed\ via -the\ API\ so\ these\ won\[aq]t\ be\ accurate\ or\ used\ for\ syncing. - -It\ does\ store\ MD5SUMs\ so\ for\ a\ more\ accurate\ sync,\ you\ can\ use\ the -`\-\-checksum`\ flag. - -####\ Restricted\ filename\ characters - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ NUL\ \ \ \ \ \ \ |\ 0x00\ \ |\ ␀\ \ \ \ \ \ \ \ \ \ \ | -|\ /\ \ \ \ \ \ \ \ \ |\ 0x2F\ \ |\ ／\ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - -###\ Deleting\ files\ ### - -Any\ files\ you\ delete\ with\ rclone\ will\ end\ up\ in\ the\ trash.\ \ Amazon -don\[aq]t\ provide\ an\ API\ to\ permanently\ delete\ files,\ nor\ to\ empty\ the -trash,\ so\ you\ will\ have\ to\ do\ that\ with\ one\ of\ Amazon\[aq]s\ apps\ or\ via -the\ Amazon\ Drive\ website.\ As\ of\ November\ 17,\ 2016,\ files\ are\ -automatically\ deleted\ by\ Amazon\ from\ the\ trash\ after\ 30\ days. - -###\ Using\ with\ non\ `.com`\ Amazon\ accounts\ ### - -Let\[aq]s\ say\ you\ usually\ use\ `amazon.co.uk`.\ When\ you\ authenticate\ with -rclone\ it\ will\ take\ you\ to\ an\ `amazon.com`\ page\ to\ log\ in.\ \ Your -`amazon.co.uk`\ email\ and\ password\ should\ work\ here\ just\ fine. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ amazon\ cloud\ drive\ (Amazon\ Drive). - -####\ \-\-acd\-client\-id - -Amazon\ Application\ Client\ ID. - -\-\ Config:\ \ \ \ \ \ client_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_CLIENT_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-acd\-client\-secret - -Amazon\ Application\ Client\ Secret. - -\-\ Config:\ \ \ \ \ \ client_secret -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_CLIENT_SECRET -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ amazon\ cloud\ drive\ (Amazon\ Drive). - -####\ \-\-acd\-auth\-url - -Auth\ server\ URL. -Leave\ blank\ to\ use\ Amazon\[aq]s. - -\-\ Config:\ \ \ \ \ \ auth_url -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_AUTH_URL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-acd\-token\-url - -Token\ server\ url. -leave\ blank\ to\ use\ Amazon\[aq]s. - -\-\ Config:\ \ \ \ \ \ token_url -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_TOKEN_URL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-acd\-checkpoint - -Checkpoint\ for\ internal\ polling\ (debug). - -\-\ Config:\ \ \ \ \ \ checkpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_CHECKPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-acd\-upload\-wait\-per\-gb - -Additional\ time\ per\ GB\ to\ wait\ after\ a\ failed\ complete\ upload\ to\ see\ if\ it\ appears. - -Sometimes\ Amazon\ Drive\ gives\ an\ error\ when\ a\ file\ has\ been\ fully -uploaded\ but\ the\ file\ appears\ anyway\ after\ a\ little\ while.\ \ This -happens\ sometimes\ for\ files\ over\ 1GB\ in\ size\ and\ nearly\ every\ time\ for -files\ bigger\ than\ 10GB.\ This\ parameter\ controls\ the\ time\ rclone\ waits -for\ the\ file\ to\ appear. - -The\ default\ value\ for\ this\ parameter\ is\ 3\ minutes\ per\ GB,\ so\ by -default\ it\ will\ wait\ 3\ minutes\ for\ every\ GB\ uploaded\ to\ see\ if\ the -file\ appears. - -You\ can\ disable\ this\ feature\ by\ setting\ it\ to\ 0.\ This\ may\ cause -conflict\ errors\ as\ rclone\ retries\ the\ failed\ upload\ but\ the\ file\ will -most\ likely\ appear\ correctly\ eventually. - -These\ values\ were\ determined\ empirically\ by\ observing\ lots\ of\ uploads -of\ big\ files\ for\ a\ range\ of\ file\ sizes. - -Upload\ with\ the\ "\-v"\ flag\ to\ see\ more\ info\ about\ what\ rclone\ is\ doing -in\ this\ situation. - -\-\ Config:\ \ \ \ \ \ upload_wait_per_gb -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_UPLOAD_WAIT_PER_GB -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 3m0s - -####\ \-\-acd\-templink\-threshold - -Files\ >=\ this\ size\ will\ be\ downloaded\ via\ their\ tempLink. - -Files\ this\ size\ or\ more\ will\ be\ downloaded\ via\ their\ "tempLink".\ This -is\ to\ work\ around\ a\ problem\ with\ Amazon\ Drive\ which\ blocks\ downloads -of\ files\ bigger\ than\ about\ 10GB.\ \ The\ default\ for\ this\ is\ 9GB\ which -shouldn\[aq]t\ need\ to\ be\ changed. - -To\ download\ files\ above\ this\ threshold,\ rclone\ requests\ a\ "tempLink" -which\ downloads\ the\ file\ through\ a\ temporary\ URL\ directly\ from\ the -underlying\ S3\ storage. - -\-\ Config:\ \ \ \ \ \ templink_threshold -\-\ Env\ Var:\ \ \ \ \ RCLONE_ACD_TEMPLINK_THRESHOLD -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 9G - - - -###\ Limitations\ ### - -Note\ that\ Amazon\ Drive\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a -file\ called\ "Hello.doc"\ and\ one\ called\ "hello.doc". - -Amazon\ Drive\ has\ rate\ limiting\ so\ you\ may\ notice\ errors\ in\ the -sync\ (429\ errors).\ \ rclone\ will\ automatically\ retry\ the\ sync\ up\ to\ 3 -times\ by\ default\ (see\ `\-\-retries`\ flag)\ which\ should\ hopefully\ work -around\ this\ problem. - -Amazon\ Drive\ has\ an\ internal\ limit\ of\ file\ sizes\ that\ can\ be\ uploaded -to\ the\ service.\ This\ limit\ is\ not\ officially\ published,\ but\ all\ files -larger\ than\ this\ will\ fail. - -At\ the\ time\ of\ writing\ (Jan\ 2016)\ is\ in\ the\ area\ of\ 50GB\ per\ file. -This\ means\ that\ larger\ files\ are\ likely\ to\ fail. - -Unfortunately\ there\ is\ no\ way\ for\ rclone\ to\ see\ that\ this\ failure\ is -because\ of\ file\ size,\ so\ it\ will\ retry\ the\ operation,\ as\ any\ other -failure.\ To\ avoid\ this\ problem,\ use\ `\-\-max\-size\ 50000M`\ option\ to\ limit -the\ maximum\ size\ of\ uploaded\ files.\ Note\ that\ `\-\-max\-size`\ does\ not\ split -files\ into\ segments,\ it\ only\ ignores\ files\ over\ this\ size. - -Amazon\ S3\ Storage\ Providers -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ S3\ backend\ can\ be\ used\ with\ a\ number\ of\ different\ providers: - -*\ AWS\ S3 -*\ Alibaba\ Cloud\ (Aliyun)\ Object\ Storage\ System\ (OSS) -*\ Ceph -*\ DigitalOcean\ Spaces -*\ Dreamhost -*\ IBM\ COS\ S3 -*\ Minio -*\ Wasabi - -Paths\ are\ specified\ as\ `remote:bucket`\ (or\ `remote:`\ for\ the\ `lsd` -command.)\ \ You\ may\ put\ subdirectories\ in\ too,\ eg\ `remote:bucket/path/to/dir`. - -Once\ you\ have\ made\ a\ remote\ (see\ the\ provider\ specific\ section\ above) -you\ can\ use\ it\ like\ this: - -See\ all\ buckets - -\ \ \ \ rclone\ lsd\ remote: - -Make\ a\ new\ bucket - -\ \ \ \ rclone\ mkdir\ remote:bucket - -List\ the\ contents\ of\ a\ bucket - -\ \ \ \ rclone\ ls\ remote:bucket - -Sync\ `/home/local/directory`\ to\ the\ remote\ bucket,\ deleting\ any\ excess -files\ in\ the\ bucket. - -\ \ \ \ rclone\ sync\ /home/local/directory\ remote:bucket - -##\ AWS\ S3\ {#amazon\-s3} - -Here\ is\ an\ example\ of\ making\ an\ s3\ configuration.\ \ First\ run - -\ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) -\ \[lq]s3\[rq] [snip] Storage> s3 Choose your S3 provider. -Choose a number from below, or type in your own value 1 / Amazon Web -Services (AWS) S3 \ \[lq]AWS\[rq] 2 / Ceph Object Storage -\ \[lq]Ceph\[rq] 3 / Digital Ocean Spaces \ \[lq]DigitalOcean\[rq] 4 / -Dreamhost DreamObjects \ \[lq]Dreamhost\[rq] 5 / IBM COS S3 -\ \[lq]IBMCOS\[rq] 6 / Minio Object Storage \ \[lq]Minio\[rq] 7 / Wasabi -Object Storage \ \[lq]Wasabi\[rq] 8 / Any other S3 compatible provider -\ \[lq]Other\[rq] provider> 1 Get AWS credentials from runtime -(environment variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[lq]false\[rq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[lq]true\[rq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> XXX AWS Secret Access Key (password) \- leave blank for -anonymous access or runtime credentials. -secret_access_key> YYY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[lq]us\-east\-1\[rq] / US East (Ohio) Region 2 | Needs location -constraint us\-east\-2. -\ \[lq]us\-east\-2\[rq] / US West (Oregon) Region 3 | Needs location -constraint us\-west\-2. -\ \[lq]us\-west\-2\[rq] / US West (Northern California) Region 4 | Needs -location constraint us\-west\-1. -\ \[lq]us\-west\-1\[rq] / Canada (Central) Region 5 | Needs location -constraint ca\-central\-1. -\ \[lq]ca\-central\-1\[rq] / EU (Ireland) Region 6 | Needs location -constraint EU or eu\-west\-1. -\ \[lq]eu\-west\-1\[rq] / EU (London) Region 7 | Needs location -constraint eu\-west\-2. -\ \[lq]eu\-west\-2\[rq] / EU (Frankfurt) Region 8 | Needs location -constraint eu\-central\-1. -\ \[lq]eu\-central\-1\[rq] / Asia Pacific (Singapore) Region 9 | Needs -location constraint ap\-southeast\-1. -\ \[lq]ap\-southeast\-1\[rq] / Asia Pacific (Sydney) Region 10 | Needs -location constraint ap\-southeast\-2. -\ \[lq]ap\-southeast\-2\[rq] / Asia Pacific (Tokyo) Region 11 | Needs -location constraint ap\-northeast\-1. -\ \[lq]ap\-northeast\-1\[rq] / Asia Pacific (Seoul) 12 | Needs location -constraint ap\-northeast\-2. -\ \[lq]ap\-northeast\-2\[rq] / Asia Pacific (Mumbai) 13 | Needs location -constraint ap\-south\-1. -\ \[lq]ap\-south\-1\[rq] / South America (Sao Paulo) Region 14 | Needs -location constraint sa\-east\-1. -\ \[lq]sa\-east\-1\[rq] region> 1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -endpoint> Location constraint \- must be set to match the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ "" 2 / US East (Ohio) Region. -\ \[lq]us\-east\-2\[rq] 3 / US West (Oregon) Region. -\ \[lq]us\-west\-2\[rq] 4 / US West (Northern California) Region. -\ \[lq]us\-west\-1\[rq] 5 / Canada (Central) Region. -\ \[lq]ca\-central\-1\[rq] 6 / EU (Ireland) Region. -\ \[lq]eu\-west\-1\[rq] 7 / EU (London) Region. -\ \[lq]eu\-west\-2\[rq] 8 / EU Region. -\ \[lq]EU\[rq] 9 / Asia Pacific (Singapore) Region. -\ \[lq]ap\-southeast\-1\[rq] 10 / Asia Pacific (Sydney) Region. -\ \[lq]ap\-southeast\-2\[rq] 11 / Asia Pacific (Tokyo) Region. -\ \[lq]ap\-northeast\-1\[rq] 12 / Asia Pacific (Seoul) -\ \[lq]ap\-northeast\-2\[rq] 13 / Asia Pacific (Mumbai) -\ \[lq]ap\-south\-1\[rq] 14 / South America (Sao Paulo) Region. -\ \[lq]sa\-east\-1\[rq] location_constraint> 1 Canned ACL used when -creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[lq]private\[rq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[lq]public\-read\[rq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -3 | Granting this on a bucket is generally not recommended. -\ \[lq]public\-read\-write\[rq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -\ \[lq]authenticated\-read\[rq] / Object owner gets FULL_CONTROL. -Bucket owner gets READ access. -5 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[lq]bucket\-owner\-read\[rq] / Both the object owner and the bucket -owner get FULL_CONTROL over the object. -6 | If you specify this canned ACL when creating a bucket, Amazon S3 -ignores it. -\ \[lq]bucket\-owner\-full\-control\[rq] acl> 1 The server\-side -encryption algorithm used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None \ "" 2 / -AES256 \ \[lq]AES256\[rq] server_side_encryption> 1 The storage class to -use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default \ "" 2 -/ Standard storage class \ \[lq]STANDARD\[rq] 3 / Reduced redundancy -storage class \ \[lq]REDUCED_REDUNDANCY\[rq] 4 / Standard Infrequent -Access storage class \ \[lq]STANDARD_IA\[rq] 5 / One Zone Infrequent -Access storage class \ \[lq]ONEZONE_IA\[rq] 6 / Glacier storage class -\ \[lq]GLACIER\[rq] 7 / Glacier Deep Archive storage class -\ \[lq]DEEP_ARCHIVE\[rq] 8 / Intelligent\-Tiering storage class -\ \[lq]INTELLIGENT_TIERING\[rq] storage_class> 1 Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = s3 provider = AWS -env_auth = false access_key_id = XXX secret_access_key = YYY region = -us\-east\-1 endpoint = location_constraint = acl = private -server_side_encryption = storage_class = -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> -.IP -.nf -\f[C] - -###\ \-\-fast\-list\ ### - -This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer -transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone -docs](/docs/#fast\-list)\ for\ more\ details. - -###\ \-\-update\ and\ \-\-use\-server\-modtime\ ### - -As\ noted\ below,\ the\ modified\ time\ is\ stored\ on\ metadata\ on\ the\ object.\ It\ is -used\ by\ default\ for\ all\ operations\ that\ require\ checking\ the\ time\ a\ file\ was -last\ updated.\ It\ allows\ rclone\ to\ treat\ the\ remote\ more\ like\ a\ true\ filesystem, -but\ it\ is\ inefficient\ because\ it\ requires\ an\ extra\ API\ call\ to\ retrieve\ the -metadata. - -For\ many\ operations,\ the\ time\ the\ object\ was\ last\ uploaded\ to\ the\ remote\ is -sufficient\ to\ determine\ if\ it\ is\ "dirty".\ By\ using\ `\-\-update`\ along\ with -`\-\-use\-server\-modtime`,\ you\ can\ avoid\ the\ extra\ API\ call\ and\ simply\ upload -files\ whose\ local\ modtime\ is\ newer\ than\ the\ time\ it\ was\ last\ uploaded. - -###\ Modified\ time\ ### - -The\ modified\ time\ is\ stored\ as\ metadata\ on\ the\ object\ as -`X\-Amz\-Meta\-Mtime`\ as\ floating\ point\ since\ the\ epoch\ accurate\ to\ 1\ ns. - -If\ the\ modification\ time\ needs\ to\ be\ updated\ rclone\ will\ attempt\ to\ perform\ a\ server -side\ copy\ to\ update\ the\ modification\ if\ the\ object\ can\ be\ copied\ in\ a\ single\ part.\ \ -In\ the\ case\ the\ object\ is\ larger\ than\ 5Gb\ or\ is\ in\ Glacier\ or\ Glacier\ Deep\ Archive\ -storage\ the\ object\ will\ be\ uploaded\ rather\ than\ copied. - -####\ Restricted\ filename\ characters - -S3\ allows\ any\ valid\ UTF\-8\ string\ as\ a\ key. - -Invalid\ UTF\-8\ bytes\ will\ be\ [replaced](/overview/#invalid\-utf8),\ as -they\ can\[aq]t\ be\ used\ in\ XML. - -The\ following\ characters\ are\ replaced\ since\ these\ are\ problematic\ when -dealing\ with\ the\ REST\ API: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ NUL\ \ \ \ \ \ \ |\ 0x00\ \ |\ ␀\ \ \ \ \ \ \ \ \ \ \ | -|\ /\ \ \ \ \ \ \ \ \ |\ 0x2F\ \ |\ ／\ \ \ \ \ \ \ \ \ \ \ | - -The\ encoding\ will\ also\ encode\ these\ file\ names\ as\ they\ don\[aq]t\ seem\ to -work\ with\ the\ SDK\ properly: - -|\ File\ name\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-\-\-\-\-\-\-:| -|\ .\ \ \ \ \ \ \ \ \ |\ ．\ \ \ \ \ \ \ \ \ \ | -|\ ..\ \ \ \ \ \ \ \ |\ ．．\ \ \ \ \ \ \ \ \ | - -###\ Multipart\ uploads\ ### - -rclone\ supports\ multipart\ uploads\ with\ S3\ which\ means\ that\ it\ can -upload\ files\ bigger\ than\ 5GB. - -Note\ that\ files\ uploaded\ *both*\ with\ multipart\ upload\ *and*\ through -crypt\ remotes\ do\ not\ have\ MD5\ sums. - -rclone\ switches\ from\ single\ part\ uploads\ to\ multipart\ uploads\ at\ the -point\ specified\ by\ `\-\-s3\-upload\-cutoff`.\ \ This\ can\ be\ a\ maximum\ of\ 5GB -and\ a\ minimum\ of\ 0\ (ie\ always\ upload\ multipart\ files). - -The\ chunk\ sizes\ used\ in\ the\ multipart\ upload\ are\ specified\ by -`\-\-s3\-chunk\-size`\ and\ the\ number\ of\ chunks\ uploaded\ concurrently\ is -specified\ by\ `\-\-s3\-upload\-concurrency`. - -Multipart\ uploads\ will\ use\ `\-\-transfers`\ *\ `\-\-s3\-upload\-concurrency`\ * -`\-\-s3\-chunk\-size`\ extra\ memory.\ \ Single\ part\ uploads\ to\ not\ use\ extra -memory. - -Single\ part\ transfers\ can\ be\ faster\ than\ multipart\ transfers\ or\ slower -depending\ on\ your\ latency\ from\ S3\ \-\ the\ more\ latency,\ the\ more\ likely -single\ part\ transfers\ will\ be\ faster. - -Increasing\ `\-\-s3\-upload\-concurrency`\ will\ increase\ throughput\ (8\ would -be\ a\ sensible\ value)\ and\ increasing\ `\-\-s3\-chunk\-size`\ also\ increases -throughput\ (16M\ would\ be\ sensible).\ \ Increasing\ either\ of\ these\ will -use\ more\ memory.\ \ The\ default\ values\ are\ high\ enough\ to\ gain\ most\ of -the\ possible\ performance\ without\ using\ too\ much\ memory. - - -###\ Buckets\ and\ Regions\ ### - -With\ Amazon\ S3\ you\ can\ list\ buckets\ (`rclone\ lsd`)\ using\ any\ region, -but\ you\ can\ only\ access\ the\ content\ of\ a\ bucket\ from\ the\ region\ it\ was -created\ in.\ \ If\ you\ attempt\ to\ access\ a\ bucket\ from\ the\ wrong\ region, -you\ will\ get\ an\ error,\ `incorrect\ region,\ the\ bucket\ is\ not\ in\ \[aq]XXX\[aq] -region`. - -###\ Authentication\ ### - -There\ are\ a\ number\ of\ ways\ to\ supply\ `rclone`\ with\ a\ set\ of\ AWS -credentials,\ with\ and\ without\ using\ the\ environment. - -The\ different\ authentication\ methods\ are\ tried\ in\ this\ order: - -\ \-\ Directly\ in\ the\ rclone\ configuration\ file\ (`env_auth\ =\ false`\ in\ the\ config\ file): -\ \ \ \-\ `access_key_id`\ and\ `secret_access_key`\ are\ required. -\ \ \ \-\ `session_token`\ can\ be\ optionally\ set\ when\ using\ AWS\ STS. -\ \-\ Runtime\ configuration\ (`env_auth\ =\ true`\ in\ the\ config\ file): -\ \ \ \-\ Export\ the\ following\ environment\ variables\ before\ running\ `rclone`: -\ \ \ \ \ \-\ Access\ Key\ ID:\ `AWS_ACCESS_KEY_ID`\ or\ `AWS_ACCESS_KEY` -\ \ \ \ \ \-\ Secret\ Access\ Key:\ `AWS_SECRET_ACCESS_KEY`\ or\ `AWS_SECRET_KEY` -\ \ \ \ \ \-\ Session\ Token:\ `AWS_SESSION_TOKEN`\ (optional) -\ \ \ \-\ Or,\ use\ a\ [named\ profile](https://docs.aws.amazon.com/cli/latest/userguide/cli\-multiple\-profiles.html): -\ \ \ \ \ \-\ Profile\ files\ are\ standard\ files\ used\ by\ AWS\ CLI\ tools -\ \ \ \ \ \-\ By\ default\ it\ will\ use\ the\ profile\ in\ your\ home\ directory\ (eg\ `~/.aws/credentials`\ on\ unix\ based\ systems)\ file\ and\ the\ "default"\ profile,\ to\ change\ set\ these\ environment\ variables: -\ \ \ \ \ \ \ \ \ \-\ `AWS_SHARED_CREDENTIALS_FILE`\ to\ control\ which\ file. -\ \ \ \ \ \ \ \ \ \-\ `AWS_PROFILE`\ to\ control\ which\ profile\ to\ use. -\ \ \ \-\ Or,\ run\ `rclone`\ in\ an\ ECS\ task\ with\ an\ IAM\ role\ (AWS\ only). -\ \ \ \-\ Or,\ run\ `rclone`\ on\ an\ EC2\ instance\ with\ an\ IAM\ role\ (AWS\ only). - -If\ none\ of\ these\ option\ actually\ end\ up\ providing\ `rclone`\ with\ AWS -credentials\ then\ S3\ interaction\ will\ be\ non\-authenticated\ (see\ below). - -###\ S3\ Permissions\ ### - -When\ using\ the\ `sync`\ subcommand\ of\ `rclone`\ the\ following\ minimum -permissions\ are\ required\ to\ be\ available\ on\ the\ bucket\ being\ written\ to: - -*\ `ListBucket` -*\ `DeleteObject` -*\ `GetObject` -*\ `PutObject` -*\ `PutObjectACL` - -When\ using\ the\ `lsd`\ subcommand,\ the\ `ListAllMyBuckets`\ permission\ is\ required. - -Example\ policy: -\f[] -.fi -.PP -{ \[lq]Version\[rq]: \[lq]2012\-10\-17\[rq], \[lq]Statement\[rq]: [ { -\[lq]Effect\[rq]: \[lq]Allow\[rq], \[lq]Principal\[rq]: { \[lq]AWS\[rq]: -\[lq]arn:aws:iam::USER_SID:user/USER_NAME\[rq] }, \[lq]Action\[rq]: [ -\[lq]s3:ListBucket\[rq], \[lq]s3:DeleteObject\[rq], -\[lq]s3:GetObject\[rq], \[lq]s3:PutObject\[rq], -\[lq]s3:PutObjectAcl\[rq] ], \[lq]Resource\[rq]: [ -"arn:aws:s3:::BUCKET_NAME/*\[lq],\[rq]arn:aws:s3:::BUCKET_NAME" ] }, { -\[lq]Effect\[rq]: \[lq]Allow\[rq], \[lq]Action\[rq]: -\[lq]s3:ListAllMyBuckets\[rq], \[lq]Resource\[rq]: "arn:aws:s3:::*" } -.PD 0 -.P -.PD -] } -.IP -.nf -\f[C] - -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\[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\ `rclone\ sync`. - -###\ Key\ Management\ System\ (KMS)\ ### - -If\ you\ are\ using\ server\ side\ encryption\ with\ KMS\ then\ you\ will\ find -you\ can\[aq]t\ transfer\ small\ objects.\ \ As\ a\ work\-around\ you\ can\ use\ the -`\-\-ignore\-checksum`\ flag. - -A\ proper\ fix\ is\ being\ worked\ on\ in\ [issue\ #1824](https://github.com/rclone/rclone/issues/1824). - -###\ Glacier\ and\ Glacier\ Deep\ Archive\ ### - -You\ can\ upload\ objects\ using\ the\ glacier\ storage\ class\ or\ transition\ them\ to\ glacier\ using\ a\ [lifecycle\ policy](http://docs.aws.amazon.com/AmazonS3/latest/user\-guide/create\-lifecycle.html). -The\ bucket\ can\ still\ be\ synced\ or\ copied\ into\ normally,\ but\ if\ rclone -tries\ to\ access\ data\ from\ the\ glacier\ storage\ class\ you\ will\ see\ an\ error\ like\ below. - -\ \ \ \ 2017/09/11\ 19:07:43\ Failed\ to\ sync:\ failed\ to\ open\ source\ object:\ Object\ in\ GLACIER,\ restore\ first:\ path/to/file - -In\ this\ case\ you\ need\ to\ [restore](http://docs.aws.amazon.com/AmazonS3/latest/user\-guide/restore\-archived\-objects.html) -the\ object(s)\ in\ question\ before\ using\ rclone. - -Note\ that\ rclone\ only\ speaks\ the\ S3\ API\ it\ does\ not\ speak\ the\ Glacier -Vault\ API,\ so\ rclone\ cannot\ directly\ access\ Glacier\ Vaults. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ s3\ (Amazon\ S3\ Compliant\ Storage\ Provider\ (AWS,\ Alibaba,\ Ceph,\ Digital\ Ocean,\ Dreamhost,\ IBM\ COS,\ Minio,\ etc)). - -####\ \-\-s3\-provider - -Choose\ your\ S3\ provider. - -\-\ Config:\ \ \ \ \ \ provider -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_PROVIDER -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "AWS" -\ \ \ \ \ \ \ \ \-\ Amazon\ Web\ Services\ (AWS)\ S3 -\ \ \ \ \-\ "Alibaba" -\ \ \ \ \ \ \ \ \-\ Alibaba\ Cloud\ Object\ Storage\ System\ (OSS)\ formerly\ Aliyun -\ \ \ \ \-\ "Ceph" -\ \ \ \ \ \ \ \ \-\ Ceph\ Object\ Storage -\ \ \ \ \-\ "DigitalOcean" -\ \ \ \ \ \ \ \ \-\ Digital\ Ocean\ Spaces -\ \ \ \ \-\ "Dreamhost" -\ \ \ \ \ \ \ \ \-\ Dreamhost\ DreamObjects -\ \ \ \ \-\ "IBMCOS" -\ \ \ \ \ \ \ \ \-\ IBM\ COS\ S3 -\ \ \ \ \-\ "Minio" -\ \ \ \ \ \ \ \ \-\ Minio\ Object\ Storage -\ \ \ \ \-\ "Netease" -\ \ \ \ \ \ \ \ \-\ Netease\ Object\ Storage\ (NOS) -\ \ \ \ \-\ "Wasabi" -\ \ \ \ \ \ \ \ \-\ Wasabi\ Object\ Storage -\ \ \ \ \-\ "Other" -\ \ \ \ \ \ \ \ \-\ Any\ other\ S3\ compatible\ provider - -####\ \-\-s3\-env\-auth - -Get\ AWS\ credentials\ from\ runtime\ (environment\ variables\ or\ EC2/ECS\ meta\ data\ if\ no\ env\ vars). -Only\ applies\ if\ access_key_id\ and\ secret_access_key\ is\ blank. - -\-\ Config:\ \ \ \ \ \ env_auth -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ENV_AUTH -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false -\-\ Examples: -\ \ \ \ \-\ "false" -\ \ \ \ \ \ \ \ \-\ Enter\ AWS\ credentials\ in\ the\ next\ step -\ \ \ \ \-\ "true" -\ \ \ \ \ \ \ \ \-\ Get\ AWS\ credentials\ from\ the\ environment\ (env\ vars\ or\ IAM) - -####\ \-\-s3\-access\-key\-id - -AWS\ Access\ Key\ ID. -Leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. - -\-\ Config:\ \ \ \ \ \ access_key_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ACCESS_KEY_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-s3\-secret\-access\-key - -AWS\ Secret\ Access\ Key\ (password) -Leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. - -\-\ Config:\ \ \ \ \ \ secret_access_key -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_SECRET_ACCESS_KEY -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-s3\-region - -Region\ to\ connect\ to. - -\-\ Config:\ \ \ \ \ \ region -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_REGION -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "us\-east\-1" -\ \ \ \ \ \ \ \ \-\ The\ default\ endpoint\ \-\ a\ good\ choice\ if\ you\ are\ unsure. -\ \ \ \ \ \ \ \ \-\ US\ Region,\ Northern\ Virginia\ or\ Pacific\ Northwest. -\ \ \ \ \ \ \ \ \-\ Leave\ location\ constraint\ empty. -\ \ \ \ \-\ "us\-east\-2" -\ \ \ \ \ \ \ \ \-\ US\ East\ (Ohio)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ us\-east\-2. -\ \ \ \ \-\ "us\-west\-2" -\ \ \ \ \ \ \ \ \-\ US\ West\ (Oregon)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ us\-west\-2. -\ \ \ \ \-\ "us\-west\-1" -\ \ \ \ \ \ \ \ \-\ US\ West\ (Northern\ California)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ us\-west\-1. -\ \ \ \ \-\ "ca\-central\-1" -\ \ \ \ \ \ \ \ \-\ Canada\ (Central)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ca\-central\-1. -\ \ \ \ \-\ "eu\-west\-1" -\ \ \ \ \ \ \ \ \-\ EU\ (Ireland)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ EU\ or\ eu\-west\-1. -\ \ \ \ \-\ "eu\-west\-2" -\ \ \ \ \ \ \ \ \-\ EU\ (London)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ eu\-west\-2. -\ \ \ \ \-\ "eu\-north\-1" -\ \ \ \ \ \ \ \ \-\ EU\ (Stockholm)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ eu\-north\-1. -\ \ \ \ \-\ "eu\-central\-1" -\ \ \ \ \ \ \ \ \-\ EU\ (Frankfurt)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ eu\-central\-1. -\ \ \ \ \-\ "ap\-southeast\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Singapore)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ap\-southeast\-1. -\ \ \ \ \-\ "ap\-southeast\-2" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Sydney)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ap\-southeast\-2. -\ \ \ \ \-\ "ap\-northeast\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Tokyo)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ap\-northeast\-1. -\ \ \ \ \-\ "ap\-northeast\-2" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Seoul) -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ap\-northeast\-2. -\ \ \ \ \-\ "ap\-south\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Mumbai) -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ ap\-south\-1. -\ \ \ \ \-\ "sa\-east\-1" -\ \ \ \ \ \ \ \ \-\ South\ America\ (Sao\ Paulo)\ Region -\ \ \ \ \ \ \ \ \-\ Needs\ location\ constraint\ sa\-east\-1. - -####\ \-\-s3\-region - -Region\ to\ connect\ to. -Leave\ blank\ if\ you\ are\ using\ an\ S3\ clone\ and\ you\ don\[aq]t\ have\ a\ region. - -\-\ Config:\ \ \ \ \ \ region -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_REGION -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Use\ this\ if\ unsure.\ Will\ use\ v4\ signatures\ and\ an\ empty\ region. -\ \ \ \ \-\ "other\-v2\-signature" -\ \ \ \ \ \ \ \ \-\ Use\ this\ only\ if\ v4\ signatures\ don\[aq]t\ work,\ eg\ pre\ Jewel/v10\ CEPH. - -####\ \-\-s3\-endpoint - -Endpoint\ for\ S3\ API. -Leave\ blank\ if\ using\ AWS\ to\ use\ the\ default\ endpoint\ for\ the\ region. - -\-\ Config:\ \ \ \ \ \ endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-s3\-endpoint - -Endpoint\ for\ IBM\ COS\ S3\ API. -Specify\ if\ using\ an\ IBM\ COS\ On\ Premise. - -\-\ Config:\ \ \ \ \ \ endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "s3\-api.us\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Endpoint -\ \ \ \ \-\ "s3\-api.dal.us\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Dallas\ Endpoint -\ \ \ \ \-\ "s3\-api.wdc\-us\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Washington\ DC\ Endpoint -\ \ \ \ \-\ "s3\-api.sjc\-us\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ San\ Jose\ Endpoint -\ \ \ \ \-\ "s3\-api.us\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Private\ Endpoint -\ \ \ \ \-\ "s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Dallas\ Private\ Endpoint -\ \ \ \ \-\ "s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Washington\ DC\ Private\ Endpoint -\ \ \ \ \-\ "s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ San\ Jose\ Private\ Endpoint -\ \ \ \ \-\ "s3.us\-east.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Region\ East\ Endpoint -\ \ \ \ \-\ "s3.us\-east.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Region\ East\ Private\ Endpoint -\ \ \ \ \-\ "s3.us\-south.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ US\ Region\ South\ Endpoint -\ \ \ \ \-\ "s3.us\-south.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ US\ Region\ South\ Private\ Endpoint -\ \ \ \ \-\ "s3.eu\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Endpoint -\ \ \ \ \-\ "s3.fra\-eu\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Frankfurt\ Endpoint -\ \ \ \ \-\ "s3.mil\-eu\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Milan\ Endpoint -\ \ \ \ \-\ "s3.ams\-eu\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Amsterdam\ Endpoint -\ \ \ \ \-\ "s3.eu\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Private\ Endpoint -\ \ \ \ \-\ "s3.fra\-eu\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Frankfurt\ Private\ Endpoint -\ \ \ \ \-\ "s3.mil\-eu\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Milan\ Private\ Endpoint -\ \ \ \ \-\ "s3.ams\-eu\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Amsterdam\ Private\ Endpoint -\ \ \ \ \-\ "s3.eu\-gb.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Endpoint -\ \ \ \ \-\ "s3.eu\-gb.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Private\ Endpoint -\ \ \ \ \-\ "s3.ap\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Endpoint -\ \ \ \ \-\ "s3.tok\-ap\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Tokyo\ Endpoint -\ \ \ \ \-\ "s3.hkg\-ap\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ HongKong\ Endpoint -\ \ \ \ \-\ "s3.seo\-ap\-geo.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Seoul\ Endpoint -\ \ \ \ \-\ "s3.ap\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Private\ Endpoint -\ \ \ \ \-\ "s3.tok\-ap\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Tokyo\ Private\ Endpoint -\ \ \ \ \-\ "s3.hkg\-ap\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ HongKong\ Private\ Endpoint -\ \ \ \ \-\ "s3.seo\-ap\-geo.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ APAC\ Cross\ Regional\ Seoul\ Private\ Endpoint -\ \ \ \ \-\ "s3.mel01.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Single\ Site\ Endpoint -\ \ \ \ \-\ "s3.mel01.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Single\ Site\ Private\ Endpoint -\ \ \ \ \-\ "s3.tor01.objectstorage.softlayer.net" -\ \ \ \ \ \ \ \ \-\ Toronto\ Single\ Site\ Endpoint -\ \ \ \ \-\ "s3.tor01.objectstorage.service.networklayer.com" -\ \ \ \ \ \ \ \ \-\ Toronto\ Single\ Site\ Private\ Endpoint - -####\ \-\-s3\-endpoint - -Endpoint\ for\ OSS\ API. - -\-\ Config:\ \ \ \ \ \ endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "oss\-cn\-hangzhou.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ East\ China\ 1\ (Hangzhou) -\ \ \ \ \-\ "oss\-cn\-shanghai.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ East\ China\ 2\ (Shanghai) -\ \ \ \ \-\ "oss\-cn\-qingdao.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ North\ China\ 1\ (Qingdao) -\ \ \ \ \-\ "oss\-cn\-beijing.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ North\ China\ 2\ (Beijing) -\ \ \ \ \-\ "oss\-cn\-zhangjiakou.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ North\ China\ 3\ (Zhangjiakou) -\ \ \ \ \-\ "oss\-cn\-huhehaote.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ North\ China\ 5\ (Huhehaote) -\ \ \ \ \-\ "oss\-cn\-shenzhen.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ South\ China\ 1\ (Shenzhen) -\ \ \ \ \-\ "oss\-cn\-hongkong.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Hong\ Kong\ (Hong\ Kong) -\ \ \ \ \-\ "oss\-us\-west\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ US\ West\ 1\ (Silicon\ Valley) -\ \ \ \ \-\ "oss\-us\-east\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ US\ East\ 1\ (Virginia) -\ \ \ \ \-\ "oss\-ap\-southeast\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Southeast\ Asia\ Southeast\ 1\ (Singapore) -\ \ \ \ \-\ "oss\-ap\-southeast\-2.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ Southeast\ 2\ (Sydney) -\ \ \ \ \-\ "oss\-ap\-southeast\-3.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Southeast\ Asia\ Southeast\ 3\ (Kuala\ Lumpur) -\ \ \ \ \-\ "oss\-ap\-southeast\-5.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ Southeast\ 5\ (Jakarta) -\ \ \ \ \-\ "oss\-ap\-northeast\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ Northeast\ 1\ (Japan) -\ \ \ \ \-\ "oss\-ap\-south\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ South\ 1\ (Mumbai) -\ \ \ \ \-\ "oss\-eu\-central\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Central\ Europe\ 1\ (Frankfurt) -\ \ \ \ \-\ "oss\-eu\-west\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ West\ Europe\ (London) -\ \ \ \ \-\ "oss\-me\-east\-1.aliyuncs.com" -\ \ \ \ \ \ \ \ \-\ Middle\ East\ 1\ (Dubai) - -####\ \-\-s3\-endpoint - -Endpoint\ for\ S3\ API. -Required\ when\ using\ an\ S3\ clone. - -\-\ Config:\ \ \ \ \ \ endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "objects\-us\-east\-1.dream.io" -\ \ \ \ \ \ \ \ \-\ Dream\ Objects\ endpoint -\ \ \ \ \-\ "nyc3.digitaloceanspaces.com" -\ \ \ \ \ \ \ \ \-\ Digital\ Ocean\ Spaces\ New\ York\ 3 -\ \ \ \ \-\ "ams3.digitaloceanspaces.com" -\ \ \ \ \ \ \ \ \-\ Digital\ Ocean\ Spaces\ Amsterdam\ 3 -\ \ \ \ \-\ "sgp1.digitaloceanspaces.com" -\ \ \ \ \ \ \ \ \-\ Digital\ Ocean\ Spaces\ Singapore\ 1 -\ \ \ \ \-\ "s3.wasabisys.com" -\ \ \ \ \ \ \ \ \-\ Wasabi\ US\ East\ endpoint -\ \ \ \ \-\ "s3.us\-west\-1.wasabisys.com" -\ \ \ \ \ \ \ \ \-\ Wasabi\ US\ West\ endpoint -\ \ \ \ \-\ "s3.eu\-central\-1.wasabisys.com" -\ \ \ \ \ \ \ \ \-\ Wasabi\ EU\ Central\ endpoint - -####\ \-\-s3\-location\-constraint - -Location\ constraint\ \-\ must\ be\ set\ to\ match\ the\ Region. -Used\ when\ creating\ buckets\ only. - -\-\ Config:\ \ \ \ \ \ location_constraint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_LOCATION_CONSTRAINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Empty\ for\ US\ Region,\ Northern\ Virginia\ or\ Pacific\ Northwest. -\ \ \ \ \-\ "us\-east\-2" -\ \ \ \ \ \ \ \ \-\ US\ East\ (Ohio)\ Region. -\ \ \ \ \-\ "us\-west\-2" -\ \ \ \ \ \ \ \ \-\ US\ West\ (Oregon)\ Region. -\ \ \ \ \-\ "us\-west\-1" -\ \ \ \ \ \ \ \ \-\ US\ West\ (Northern\ California)\ Region. -\ \ \ \ \-\ "ca\-central\-1" -\ \ \ \ \ \ \ \ \-\ Canada\ (Central)\ Region. -\ \ \ \ \-\ "eu\-west\-1" -\ \ \ \ \ \ \ \ \-\ EU\ (Ireland)\ Region. -\ \ \ \ \-\ "eu\-west\-2" -\ \ \ \ \ \ \ \ \-\ EU\ (London)\ Region. -\ \ \ \ \-\ "eu\-north\-1" -\ \ \ \ \ \ \ \ \-\ EU\ (Stockholm)\ Region. -\ \ \ \ \-\ "EU" -\ \ \ \ \ \ \ \ \-\ EU\ Region. -\ \ \ \ \-\ "ap\-southeast\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Singapore)\ Region. -\ \ \ \ \-\ "ap\-southeast\-2" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Sydney)\ Region. -\ \ \ \ \-\ "ap\-northeast\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Tokyo)\ Region. -\ \ \ \ \-\ "ap\-northeast\-2" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Seoul) -\ \ \ \ \-\ "ap\-south\-1" -\ \ \ \ \ \ \ \ \-\ Asia\ Pacific\ (Mumbai) -\ \ \ \ \-\ "sa\-east\-1" -\ \ \ \ \ \ \ \ \-\ South\ America\ (Sao\ Paulo)\ Region. - -####\ \-\-s3\-location\-constraint - -Location\ constraint\ \-\ must\ match\ endpoint\ when\ using\ IBM\ Cloud\ Public. -For\ on\-prem\ COS,\ do\ not\ make\ a\ selection\ from\ this\ list,\ hit\ enter - -\-\ Config:\ \ \ \ \ \ location_constraint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_LOCATION_CONSTRAINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "us\-standard" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Standard -\ \ \ \ \-\ "us\-vault" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Vault -\ \ \ \ \-\ "us\-cold" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Cold -\ \ \ \ \-\ "us\-flex" -\ \ \ \ \ \ \ \ \-\ US\ Cross\ Region\ Flex -\ \ \ \ \-\ "us\-east\-standard" -\ \ \ \ \ \ \ \ \-\ US\ East\ Region\ Standard -\ \ \ \ \-\ "us\-east\-vault" -\ \ \ \ \ \ \ \ \-\ US\ East\ Region\ Vault -\ \ \ \ \-\ "us\-east\-cold" -\ \ \ \ \ \ \ \ \-\ US\ East\ Region\ Cold -\ \ \ \ \-\ "us\-east\-flex" -\ \ \ \ \ \ \ \ \-\ US\ East\ Region\ Flex -\ \ \ \ \-\ "us\-south\-standard" -\ \ \ \ \ \ \ \ \-\ US\ South\ Region\ Standard -\ \ \ \ \-\ "us\-south\-vault" -\ \ \ \ \ \ \ \ \-\ US\ South\ Region\ Vault -\ \ \ \ \-\ "us\-south\-cold" -\ \ \ \ \ \ \ \ \-\ US\ South\ Region\ Cold -\ \ \ \ \-\ "us\-south\-flex" -\ \ \ \ \ \ \ \ \-\ US\ South\ Region\ Flex -\ \ \ \ \-\ "eu\-standard" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Standard -\ \ \ \ \-\ "eu\-vault" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Vault -\ \ \ \ \-\ "eu\-cold" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Cold -\ \ \ \ \-\ "eu\-flex" -\ \ \ \ \ \ \ \ \-\ EU\ Cross\ Region\ Flex -\ \ \ \ \-\ "eu\-gb\-standard" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Standard -\ \ \ \ \-\ "eu\-gb\-vault" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Vault -\ \ \ \ \-\ "eu\-gb\-cold" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Cold -\ \ \ \ \-\ "eu\-gb\-flex" -\ \ \ \ \ \ \ \ \-\ Great\ Britain\ Flex -\ \ \ \ \-\ "ap\-standard" -\ \ \ \ \ \ \ \ \-\ APAC\ Standard -\ \ \ \ \-\ "ap\-vault" -\ \ \ \ \ \ \ \ \-\ APAC\ Vault -\ \ \ \ \-\ "ap\-cold" -\ \ \ \ \ \ \ \ \-\ APAC\ Cold -\ \ \ \ \-\ "ap\-flex" -\ \ \ \ \ \ \ \ \-\ APAC\ Flex -\ \ \ \ \-\ "mel01\-standard" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Standard -\ \ \ \ \-\ "mel01\-vault" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Vault -\ \ \ \ \-\ "mel01\-cold" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Cold -\ \ \ \ \-\ "mel01\-flex" -\ \ \ \ \ \ \ \ \-\ Melbourne\ Flex -\ \ \ \ \-\ "tor01\-standard" -\ \ \ \ \ \ \ \ \-\ Toronto\ Standard -\ \ \ \ \-\ "tor01\-vault" -\ \ \ \ \ \ \ \ \-\ Toronto\ Vault -\ \ \ \ \-\ "tor01\-cold" -\ \ \ \ \ \ \ \ \-\ Toronto\ Cold -\ \ \ \ \-\ "tor01\-flex" -\ \ \ \ \ \ \ \ \-\ Toronto\ Flex - -####\ \-\-s3\-location\-constraint - -Location\ constraint\ \-\ must\ be\ set\ to\ match\ the\ Region. -Leave\ blank\ if\ not\ sure.\ Used\ when\ creating\ buckets\ only. - -\-\ Config:\ \ \ \ \ \ location_constraint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_LOCATION_CONSTRAINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-s3\-acl - -Canned\ ACL\ used\ when\ creating\ buckets\ and\ storing\ or\ copying\ objects. - -This\ ACL\ is\ used\ for\ creating\ objects\ and\ if\ bucket_acl\ isn\[aq]t\ set,\ for\ creating\ buckets\ too. - -For\ more\ info\ visit\ https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl - -Note\ that\ this\ ACL\ is\ applied\ when\ server\ side\ copying\ objects\ as\ S3 -doesn\[aq]t\ copy\ the\ ACL\ from\ the\ source\ but\ rather\ writes\ a\ fresh\ one. - -\-\ Config:\ \ \ \ \ \ acl -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_ACL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "private" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ No\ one\ else\ has\ access\ rights\ (default). -\ \ \ \ \-\ "public\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ access. -\ \ \ \ \-\ "public\-read\-write" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ and\ WRITE\ access. -\ \ \ \ \ \ \ \ \-\ Granting\ this\ on\ a\ bucket\ is\ generally\ not\ recommended. -\ \ \ \ \-\ "authenticated\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AuthenticatedUsers\ group\ gets\ READ\ access. -\ \ \ \ \-\ "bucket\-owner\-read" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ FULL_CONTROL.\ Bucket\ owner\ gets\ READ\ access. -\ \ \ \ \ \ \ \ \-\ If\ you\ specify\ this\ canned\ ACL\ when\ creating\ a\ bucket,\ Amazon\ S3\ ignores\ it. -\ \ \ \ \-\ "bucket\-owner\-full\-control" -\ \ \ \ \ \ \ \ \-\ Both\ the\ object\ owner\ and\ the\ bucket\ owner\ get\ FULL_CONTROL\ over\ the\ object. -\ \ \ \ \ \ \ \ \-\ If\ you\ specify\ this\ canned\ ACL\ when\ creating\ a\ bucket,\ Amazon\ S3\ ignores\ it. -\ \ \ \ \-\ "private" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ No\ one\ else\ has\ access\ rights\ (default).\ This\ acl\ is\ available\ on\ IBM\ Cloud\ (Infra),\ IBM\ Cloud\ (Storage),\ On\-Premise\ COS -\ \ \ \ \-\ "public\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ access.\ This\ acl\ is\ available\ on\ IBM\ Cloud\ (Infra),\ IBM\ Cloud\ (Storage),\ On\-Premise\ IBM\ COS -\ \ \ \ \-\ "public\-read\-write" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ and\ WRITE\ access.\ This\ acl\ is\ available\ on\ IBM\ Cloud\ (Infra),\ On\-Premise\ IBM\ COS -\ \ \ \ \-\ "authenticated\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AuthenticatedUsers\ group\ gets\ READ\ access.\ Not\ supported\ on\ Buckets.\ This\ acl\ is\ available\ on\ IBM\ Cloud\ (Infra)\ and\ On\-Premise\ IBM\ COS - -####\ \-\-s3\-server\-side\-encryption - -The\ server\-side\ encryption\ algorithm\ used\ when\ storing\ this\ object\ in\ S3. - -\-\ Config:\ \ \ \ \ \ server_side_encryption -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_SERVER_SIDE_ENCRYPTION -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ None -\ \ \ \ \-\ "AES256" -\ \ \ \ \ \ \ \ \-\ AES256 -\ \ \ \ \-\ "aws:kms" -\ \ \ \ \ \ \ \ \-\ aws:kms - -####\ \-\-s3\-sse\-kms\-key\-id - -If\ using\ KMS\ ID\ you\ must\ provide\ the\ ARN\ of\ Key. - -\-\ Config:\ \ \ \ \ \ sse_kms_key_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_SSE_KMS_KEY_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ None -\ \ \ \ \-\ "arn:aws:kms:us\-east\-1:*" -\ \ \ \ \ \ \ \ \-\ arn:aws:kms:* - -####\ \-\-s3\-storage\-class - -The\ storage\ class\ to\ use\ when\ storing\ new\ objects\ in\ S3. - -\-\ Config:\ \ \ \ \ \ storage_class -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_STORAGE_CLASS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Default -\ \ \ \ \-\ "STANDARD" -\ \ \ \ \ \ \ \ \-\ Standard\ storage\ class -\ \ \ \ \-\ "REDUCED_REDUNDANCY" -\ \ \ \ \ \ \ \ \-\ Reduced\ redundancy\ storage\ class -\ \ \ \ \-\ "STANDARD_IA" -\ \ \ \ \ \ \ \ \-\ Standard\ Infrequent\ Access\ storage\ class -\ \ \ \ \-\ "ONEZONE_IA" -\ \ \ \ \ \ \ \ \-\ One\ Zone\ Infrequent\ Access\ storage\ class -\ \ \ \ \-\ "GLACIER" -\ \ \ \ \ \ \ \ \-\ Glacier\ storage\ class -\ \ \ \ \-\ "DEEP_ARCHIVE" -\ \ \ \ \ \ \ \ \-\ Glacier\ Deep\ Archive\ storage\ class -\ \ \ \ \-\ "INTELLIGENT_TIERING" -\ \ \ \ \ \ \ \ \-\ Intelligent\-Tiering\ storage\ class - -####\ \-\-s3\-storage\-class - -The\ storage\ class\ to\ use\ when\ storing\ new\ objects\ in\ OSS. - -\-\ Config:\ \ \ \ \ \ storage_class -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_STORAGE_CLASS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Default -\ \ \ \ \-\ "STANDARD" -\ \ \ \ \ \ \ \ \-\ Standard\ storage\ class -\ \ \ \ \-\ "GLACIER" -\ \ \ \ \ \ \ \ \-\ Archive\ storage\ mode. -\ \ \ \ \-\ "STANDARD_IA" -\ \ \ \ \ \ \ \ \-\ Infrequent\ access\ storage\ mode. - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ s3\ (Amazon\ S3\ Compliant\ Storage\ Provider\ (AWS,\ Alibaba,\ Ceph,\ Digital\ Ocean,\ Dreamhost,\ IBM\ COS,\ Minio,\ etc)). - -####\ \-\-s3\-bucket\-acl - -Canned\ ACL\ used\ when\ creating\ buckets. - -For\ more\ info\ visit\ https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl - -Note\ that\ this\ ACL\ is\ applied\ when\ only\ when\ creating\ buckets.\ \ If\ it -isn\[aq]t\ set\ then\ "acl"\ is\ used\ instead. - -\-\ Config:\ \ \ \ \ \ bucket_acl -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_BUCKET_ACL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "private" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ No\ one\ else\ has\ access\ rights\ (default). -\ \ \ \ \-\ "public\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ access. -\ \ \ \ \-\ "public\-read\-write" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AllUsers\ group\ gets\ READ\ and\ WRITE\ access. -\ \ \ \ \ \ \ \ \-\ Granting\ this\ on\ a\ bucket\ is\ generally\ not\ recommended. -\ \ \ \ \-\ "authenticated\-read" -\ \ \ \ \ \ \ \ \-\ Owner\ gets\ FULL_CONTROL.\ The\ AuthenticatedUsers\ group\ gets\ READ\ access. - -####\ \-\-s3\-upload\-cutoff - -Cutoff\ for\ switching\ to\ chunked\ upload - -Any\ files\ larger\ than\ this\ will\ be\ uploaded\ in\ chunks\ of\ chunk_size. -The\ minimum\ is\ 0\ and\ the\ maximum\ is\ 5GB. - -\-\ Config:\ \ \ \ \ \ upload_cutoff -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_UPLOAD_CUTOFF -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 200M - -####\ \-\-s3\-chunk\-size - -Chunk\ size\ to\ use\ for\ uploading. - -When\ uploading\ files\ larger\ than\ upload_cutoff\ they\ will\ be\ uploaded -as\ multipart\ uploads\ using\ this\ chunk\ size. - -Note\ that\ "\-\-s3\-upload\-concurrency"\ chunks\ of\ this\ size\ are\ buffered -in\ memory\ per\ transfer. - -If\ you\ are\ transferring\ large\ files\ over\ high\ speed\ links\ and\ you\ have -enough\ memory,\ then\ increasing\ this\ will\ speed\ up\ the\ transfers. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 5M - -####\ \-\-s3\-disable\-checksum - -Don\[aq]t\ store\ MD5\ checksum\ with\ object\ metadata - -\-\ Config:\ \ \ \ \ \ disable_checksum -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_DISABLE_CHECKSUM -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-s3\-session\-token - -An\ AWS\ session\ token - -\-\ Config:\ \ \ \ \ \ session_token -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_SESSION_TOKEN -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-s3\-upload\-concurrency - -Concurrency\ for\ multipart\ uploads. - -This\ is\ the\ number\ of\ chunks\ of\ the\ same\ file\ that\ are\ uploaded -concurrently. - -If\ you\ are\ uploading\ small\ numbers\ of\ large\ file\ over\ high\ speed\ link -and\ these\ uploads\ do\ not\ fully\ utilize\ your\ bandwidth,\ then\ increasing -this\ may\ help\ to\ speed\ up\ the\ transfers. - -\-\ Config:\ \ \ \ \ \ upload_concurrency -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_UPLOAD_CONCURRENCY -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 4 - -####\ \-\-s3\-force\-path\-style - -If\ true\ use\ path\ style\ access\ if\ false\ use\ virtual\ hosted\ style. - -If\ this\ is\ true\ (the\ default)\ then\ rclone\ will\ use\ path\ style\ access, -if\ false\ then\ rclone\ will\ use\ virtual\ path\ style.\ See\ [the\ AWS\ S3 -docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access\-bucket\-intro) -for\ more\ info. - -Some\ providers\ (eg\ Aliyun\ OSS\ or\ Netease\ COS)\ require\ this\ set\ to\ false. - -\-\ Config:\ \ \ \ \ \ force_path_style -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_FORCE_PATH_STYLE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ true - -####\ \-\-s3\-v2\-auth - -If\ true\ use\ v2\ authentication. - -If\ this\ is\ false\ (the\ default)\ then\ rclone\ will\ use\ v4\ authentication. -If\ it\ is\ set\ then\ rclone\ will\ use\ v2\ authentication. - -Use\ this\ only\ if\ v4\ signatures\ don\[aq]t\ work,\ eg\ pre\ Jewel/v10\ CEPH. - -\-\ Config:\ \ \ \ \ \ v2_auth -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_V2_AUTH -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-s3\-use\-accelerate\-endpoint - -If\ true\ use\ the\ AWS\ S3\ accelerated\ endpoint. - -See:\ [AWS\ S3\ Transfer\ acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer\-acceleration\-examples.html) - -\-\ Config:\ \ \ \ \ \ use_accelerate_endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_USE_ACCELERATE_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-s3\-leave\-parts\-on\-error - -If\ true\ avoid\ calling\ abort\ upload\ on\ a\ failure,\ leaving\ all\ successfully\ uploaded\ parts\ on\ S3\ for\ manual\ recovery. - -It\ should\ be\ set\ to\ true\ for\ resuming\ uploads\ across\ different\ sessions. - -WARNING:\ Storing\ parts\ of\ an\ incomplete\ multipart\ upload\ counts\ towards\ space\ usage\ on\ S3\ and\ will\ add\ additional\ costs\ if\ not\ cleaned\ up. - - -\-\ Config:\ \ \ \ \ \ leave_parts_on_error -\-\ Env\ Var:\ \ \ \ \ RCLONE_S3_LEAVE_PARTS_ON_ERROR -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - - - -###\ Anonymous\ access\ to\ public\ buckets\ ### - -If\ you\ want\ to\ use\ rclone\ to\ access\ a\ public\ bucket,\ configure\ with\ a -blank\ `access_key_id`\ and\ `secret_access_key`.\ \ Your\ config\ should\ end -up\ looking\ like\ this: -\f[] -.fi -.PP -[anons3] type = s3 provider = AWS env_auth = false access_key_id = -secret_access_key = region = us\-east\-1 endpoint = location_constraint -= acl = private server_side_encryption = storage_class = -.IP -.nf -\f[C] - -Then\ use\ it\ as\ normal\ with\ the\ name\ of\ the\ public\ bucket,\ eg - -\ \ \ \ rclone\ lsd\ anons3:1000genomes - -You\ will\ be\ able\ to\ list\ and\ copy\ data\ but\ not\ upload\ it. - -###\ Ceph\ ### - -[Ceph](https://ceph.com/)\ is\ an\ open\ source\ unified,\ distributed -storage\ system\ designed\ for\ excellent\ performance,\ reliability\ and -scalability.\ \ It\ has\ an\ S3\ compatible\ object\ storage\ interface. - -To\ use\ rclone\ with\ Ceph,\ configure\ as\ above\ but\ leave\ the\ region\ blank -and\ set\ the\ endpoint.\ \ You\ should\ end\ up\ with\ something\ like\ this\ in -your\ config: -\f[] -.fi -.PP -[ceph] type = s3 provider = Ceph env_auth = false access_key_id = XXX -secret_access_key = YYY region = endpoint = -https://ceph.endpoint.example.com location_constraint = acl = -server_side_encryption = storage_class = -.IP -.nf -\f[C] - -If\ you\ are\ using\ an\ older\ version\ of\ CEPH,\ eg\ 10.2.x\ Jewel,\ then\ you -may\ need\ to\ supply\ the\ parameter\ `\-\-s3\-upload\-cutoff\ 0`\ or\ put\ this\ in -the\ config\ file\ as\ `upload_cutoff\ 0`\ to\ work\ around\ a\ bug\ which\ causes -uploading\ of\ small\ files\ to\ fail. - -Note\ also\ that\ Ceph\ sometimes\ puts\ `/`\ in\ the\ passwords\ it\ gives -users.\ \ If\ you\ read\ the\ secret\ access\ key\ using\ the\ command\ line\ tools -you\ will\ get\ a\ JSON\ blob\ with\ the\ `/`\ escaped\ as\ `\\/`.\ \ Make\ sure\ you -only\ write\ `/`\ in\ the\ secret\ access\ key. - -Eg\ the\ dump\ from\ Ceph\ looks\ something\ like\ this\ (irrelevant\ keys -removed). -\f[] -.fi -.PP -{ \[lq]user_id\[rq]: \[lq]xxx\[rq], \[lq]display_name\[rq]: -\[lq]xxxx\[rq], \[lq]keys\[rq]: [ { \[lq]user\[rq]: \[lq]xxx\[rq], -\[lq]access_key\[rq]: \[lq]xxxxxx\[rq], \[lq]secret_key\[rq]: -\[lq]xxxxxx/xxxx\[rq] } ], } -.IP -.nf -\f[C] - -Because\ this\ is\ a\ json\ dump,\ it\ is\ encoding\ the\ `/`\ as\ `\\/`,\ so\ if\ you -use\ the\ secret\ key\ as\ `xxxxxx/xxxx`\ \ it\ will\ work\ fine. - -###\ Dreamhost\ ### - -Dreamhost\ [DreamObjects](https://www.dreamhost.com/cloud/storage/)\ is -an\ object\ storage\ system\ based\ on\ CEPH. - -To\ use\ rclone\ with\ Dreamhost,\ configure\ as\ above\ but\ leave\ the\ region\ blank -and\ set\ the\ endpoint.\ \ You\ should\ end\ up\ with\ something\ like\ this\ in -your\ config: -\f[] -.fi -.PP -[dreamobjects] type = s3 provider = DreamHost env_auth = false -access_key_id = your_access_key secret_access_key = your_secret_key -region = endpoint = objects\-us\-west\-1.dream.io location_constraint = -acl = private server_side_encryption = storage_class = -.IP -.nf -\f[C] - -###\ DigitalOcean\ Spaces\ ### - -[Spaces](https://www.digitalocean.com/products/object\-storage/)\ is\ an\ [S3\-interoperable](https://developers.digitalocean.com/documentation/spaces/)\ object\ storage\ service\ from\ cloud\ provider\ DigitalOcean. - -To\ connect\ to\ DigitalOcean\ Spaces\ you\ will\ need\ an\ access\ key\ and\ secret\ key.\ These\ can\ be\ retrieved\ on\ the\ "[Applications\ &\ API](https://cloud.digitalocean.com/settings/api/tokens)"\ page\ of\ the\ DigitalOcean\ control\ panel.\ They\ will\ be\ needed\ when\ promted\ by\ `rclone\ config`\ for\ your\ `access_key_id`\ and\ `secret_access_key`. - -When\ prompted\ for\ a\ `region`\ or\ `location_constraint`,\ press\ enter\ to\ use\ the\ default\ value.\ The\ region\ must\ be\ included\ in\ the\ `endpoint`\ setting\ (e.g.\ `nyc3.digitaloceanspaces.com`).\ The\ default\ values\ can\ be\ used\ for\ other\ settings. - -Going\ through\ the\ whole\ process\ of\ creating\ a\ new\ remote\ by\ running\ `rclone\ config`,\ each\ prompt\ should\ be\ answered\ as\ shown\ below: -\f[] -.fi -.PP -Storage> s3 env_auth> 1 access_key_id> YOUR_ACCESS_KEY -secret_access_key> YOUR_SECRET_KEY region> endpoint> -nyc3.digitaloceanspaces.com location_constraint> acl> storage_class> -.IP -.nf -\f[C] - -The\ resulting\ configuration\ file\ should\ look\ like: -\f[] -.fi -.PP -[spaces] type = s3 provider = DigitalOcean env_auth = false -access_key_id = YOUR_ACCESS_KEY secret_access_key = YOUR_SECRET_KEY -region = endpoint = nyc3.digitaloceanspaces.com location_constraint = -acl = server_side_encryption = storage_class = -.IP -.nf -\f[C] - -Once\ configured,\ you\ can\ create\ a\ new\ Space\ and\ begin\ copying\ files.\ For\ example: -\f[] -.fi -.PP -rclone mkdir spaces:my\-new\-space rclone copy /path/to/files -spaces:my\-new\-space -.IP -.nf -\f[C] - -###\ IBM\ COS\ (S3)\ ### - -Information\ stored\ with\ IBM\ Cloud\ Object\ Storage\ is\ encrypted\ and\ dispersed\ across\ multiple\ geographic\ locations,\ and\ accessed\ through\ an\ implementation\ of\ the\ S3\ API.\ This\ service\ makes\ use\ of\ the\ distributed\ storage\ technologies\ provided\ by\ IBM's\ Cloud\ Object\ Storage\ System\ (formerly\ Cleversafe).\ For\ more\ information\ visit:\ (http://www.ibm.com/cloud/object\-storage) - -To\ configure\ access\ to\ IBM\ COS\ S3,\ follow\ the\ steps\ below: - -1.\ Run\ rclone\ config\ and\ select\ n\ for\ a\ new\ remote. -\f[] -.fi -.IP -.nf -\f[C] -2018/02/14\ 14:13:11\ NOTICE:\ Config\ file\ "C:\\\\Users\\\\a\\\\.config\\\\rclone\\\\rclone.conf"\ not\ found\ \-\ using\ defaults -No\ remotes\ found\ \-\ make\ a\ new\ one -n)\ New\ remote -s)\ Set\ configuration\ password -q)\ Quit\ config -n/s/q>\ n -\f[] -.fi -.IP -.nf -\f[C] - -2.\ Enter\ the\ name\ for\ the\ configuration -\f[] -.fi -.IP -.nf -\f[C] -name>\ -\f[] -.fi -.IP -.nf -\f[C] - -3.\ Select\ "s3"\ storage. -\f[] -.fi -.PP -Choose a number from below, or type in your own value 1 / Alias for an -existing remote \ \[lq]alias\[rq] 2 / Amazon Drive \ \[lq]amazon cloud -drive\[rq] 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, -Minio, IBM COS) \ \[lq]s3\[rq] 4 / Backblaze B2 \ \[lq]b2\[rq] [snip] 23 -/ http Connection \ \[lq]http\[rq] Storage> 3 -.IP -.nf -\f[C] - -4.\ Select\ IBM\ COS\ as\ the\ S3\ Storage\ Provider. -\f[] -.fi -.PP -Choose the S3 provider. -Choose a number from below, or type in your own value 1 / Choose this -option to configure Storage to AWS S3 \ \[lq]AWS\[rq] 2 / Choose this -option to configure Storage to Ceph Systems \ \[lq]Ceph\[rq] 3 / Choose -this option to configure Storage to Dreamhost \ \[lq]Dreamhost\[rq] 4 / -Choose this option to the configure Storage to IBM COS S3 -\ \[lq]IBMCOS\[rq] 5 / Choose this option to the configure Storage to -Minio \ \[lq]Minio\[rq] Provider>4 -.IP -.nf -\f[C] - -5.\ Enter\ the\ Access\ Key\ and\ Secret. -\f[] -.fi -.IP -.nf -\f[C] -AWS\ Access\ Key\ ID\ \-\ leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. -access_key_id>\ <> -AWS\ Secret\ Access\ Key\ (password)\ \-\ leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. -secret_access_key>\ <> -\f[] -.fi -.IP -.nf -\f[C] - -6.\ Specify\ the\ endpoint\ for\ IBM\ COS.\ For\ Public\ IBM\ COS,\ choose\ from\ the\ option\ below.\ For\ On\ Premise\ IBM\ COS,\ enter\ an\ enpoint\ address. -\f[] -.fi -.IP -.nf -\f[C] -Endpoint\ for\ IBM\ COS\ S3\ API. -Specify\ if\ using\ an\ IBM\ COS\ On\ Premise. -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ US\ Cross\ Region\ Endpoint -\ \ \ \\\ "s3\-api.us\-geo.objectstorage.softlayer.net" -\ 2\ /\ US\ Cross\ Region\ Dallas\ Endpoint -\ \ \ \\\ "s3\-api.dal.us\-geo.objectstorage.softlayer.net" -\ 3\ /\ US\ Cross\ Region\ Washington\ DC\ Endpoint -\ \ \ \\\ "s3\-api.wdc\-us\-geo.objectstorage.softlayer.net" -\ 4\ /\ US\ Cross\ Region\ San\ Jose\ Endpoint -\ \ \ \\\ "s3\-api.sjc\-us\-geo.objectstorage.softlayer.net" -\ 5\ /\ US\ Cross\ Region\ Private\ Endpoint -\ \ \ \\\ "s3\-api.us\-geo.objectstorage.service.networklayer.com" -\ 6\ /\ US\ Cross\ Region\ Dallas\ Private\ Endpoint -\ \ \ \\\ "s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com" -\ 7\ /\ US\ Cross\ Region\ Washington\ DC\ Private\ Endpoint -\ \ \ \\\ "s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com" -\ 8\ /\ US\ Cross\ Region\ San\ Jose\ Private\ Endpoint -\ \ \ \\\ "s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com" -\ 9\ /\ US\ Region\ East\ Endpoint -\ \ \ \\\ "s3.us\-east.objectstorage.softlayer.net" -10\ /\ US\ Region\ East\ Private\ Endpoint -\ \ \ \\\ "s3.us\-east.objectstorage.service.networklayer.com" -11\ /\ US\ Region\ South\ Endpoint -\f[] -.fi -.PP -[snip] 34 / Toronto Single Site Private Endpoint -\ \[lq]s3.tor01.objectstorage.service.networklayer.com\[rq] endpoint>1 -.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 -\f[] -.fi -.IP -.nf -\f[C] -\ 1\ /\ US\ Cross\ Region\ Standard -\ \ \ \\\ "us\-standard" -\ 2\ /\ US\ Cross\ Region\ Vault -\ \ \ \\\ "us\-vault" -\ 3\ /\ US\ Cross\ Region\ Cold -\ \ \ \\\ "us\-cold" -\ 4\ /\ US\ Cross\ Region\ Flex -\ \ \ \\\ "us\-flex" -\ 5\ /\ US\ East\ Region\ Standard -\ \ \ \\\ "us\-east\-standard" -\ 6\ /\ US\ East\ Region\ Vault -\ \ \ \\\ "us\-east\-vault" -\ 7\ /\ US\ East\ Region\ Cold -\ \ \ \\\ "us\-east\-cold" -\ 8\ /\ US\ East\ Region\ Flex -\ \ \ \\\ "us\-east\-flex" -\ 9\ /\ US\ South\ Region\ Standard -\ \ \ \\\ "us\-south\-standard" -10\ /\ US\ South\ Region\ Vault -\ \ \ \\\ "us\-south\-vault" -\f[] -.fi -.PP -[snip] 32 / Toronto Flex \ \[lq]tor01\-flex\[rq] location_constraint>1 -.IP -.nf -\f[C] - -9.\ Specify\ a\ canned\ ACL.\ IBM\ Cloud\ (Strorage)\ supports\ "public\-read"\ and\ "private".\ IBM\ Cloud(Infra)\ supports\ all\ the\ canned\ ACLs.\ On\-Premise\ COS\ supports\ all\ the\ canned\ ACLs. -\f[] -.fi -.PP -Canned ACL used when creating buckets and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise COS \ \[lq]private\[rq] 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), -On\-Premise IBM COS \ \[lq]public\-read\[rq] 3 / Owner gets -FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -This acl is available on IBM Cloud (Infra), On\-Premise IBM COS -\ \[lq]public\-read\-write\[rq] 4 / Owner gets FULL_CONTROL. -The AuthenticatedUsers group gets READ access. -Not supported on Buckets. -This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS -\ \[lq]authenticated\-read\[rq] acl> 1 -.IP -.nf -\f[C] - - -12.\ Review\ the\ displayed\ configuration\ and\ accept\ to\ save\ the\ "remote"\ then\ quit.\ The\ config\ file\ should\ look\ like\ this -\f[] -.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[] -.fi -.IP -.nf -\f[C] - -13.\ Execute\ rclone\ commands -\f[] -.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[] -.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[] -.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\ `rclone\ config`\ like\ this.\ \ Note\ that\ it -is\ important\ to\ put\ the\ region\ in\ as\ stated\ above. -\f[] -.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[] -.fi -.PP -[minio] type = s3 provider = Minio env_auth = false access_key_id = -USWUXHGYZQYFYFFIT3RE secret_access_key = -MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03 region = us\-east\-1 endpoint = -http://192.168.1.106:9000 location_constraint = server_side_encryption = -.IP -.nf -\f[C] - -So\ once\ set\ up,\ for\ example\ to\ copy\ files\ into\ a\ bucket -\f[] -.fi -.PP -rclone copy /path/to/files minio:bucket -.IP -.nf -\f[C] - -###\ Scaleway\ {#scaleway} - -[Scaleway](https://www.scaleway.com/object\-storage/)\ The\ Object\ Storage\ platform\ allows\ you\ to\ store\ anything\ from\ backups,\ logs\ and\ web\ assets\ to\ documents\ and\ photos. -Files\ can\ be\ dropped\ from\ the\ Scaleway\ console\ or\ transferred\ through\ our\ API\ and\ CLI\ or\ using\ any\ S3\-compatible\ tool. - -Scaleway\ provides\ an\ S3\ interface\ which\ can\ be\ configured\ for\ use\ with\ rclone\ like\ this: -\f[] -.fi -.PP -[scaleway] type = s3 env_auth = false endpoint = s3.nl\-ams.scw.cloud -access_key_id = SCWXXXXXXXXXXXXXX secret_access_key = -1111111\-2222\-3333\-44444\-55555555555555 region = nl\-ams -location_constraint = acl = private force_path_style = false -server_side_encryption = storage_class = -.IP -.nf -\f[C] - -###\ Wasabi\ ### - -[Wasabi](https://wasabi.com)\ is\ a\ cloud\-based\ object\ storage\ service\ for\ a -broad\ range\ of\ applications\ and\ use\ cases.\ Wasabi\ is\ designed\ for -individuals\ and\ organizations\ that\ require\ a\ high\-performance, -reliable,\ and\ secure\ data\ storage\ infrastructure\ at\ minimal\ cost. - -Wasabi\ provides\ an\ S3\ interface\ which\ can\ be\ configured\ for\ use\ with -rclone\ like\ this. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password n/s> n name> wasabi Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Amazon -S3 (also Dreamhost, Ceph, Minio) \ \[lq]s3\[rq] [snip] Storage> s3 Get -AWS credentials from runtime (environment variables or EC2/ECS meta data -if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[lq]false\[rq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[lq]true\[rq] env_auth> 1 AWS -Access Key ID \- leave blank for anonymous access or runtime -credentials. -access_key_id> YOURACCESSKEY AWS Secret Access Key (password) \- leave -blank for anonymous access or runtime credentials. -secret_access_key> YOURSECRETACCESSKEY Region to connect to. -Choose a number from below, or type in your own value / The default -endpoint \- a good choice if you are unsure. -1 | US Region, Northern Virginia or Pacific Northwest. -| Leave location constraint empty. -\ \[lq]us\-east\-1\[rq] [snip] region> us\-east\-1 Endpoint for S3 API. -Leave blank if using AWS to use the default endpoint for the region. -Specify if using an S3 clone such as Ceph. -endpoint> s3.wasabisys.com Location constraint \- must be set to match -the Region. -Used when creating buckets only. -Choose a number from below, or type in your own value 1 / Empty for US -Region, Northern Virginia or Pacific Northwest. -\ "" [snip] location_constraint> Canned ACL used when creating buckets -and/or storing objects in S3. -For more info visit -https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl -Choose a number from below, or type in your own value 1 / Owner gets -FULL_CONTROL. -No one else has access rights (default). -\ \[lq]private\[rq] [snip] acl> The server\-side encryption algorithm -used when storing this object in S3. -Choose a number from below, or type in your own value 1 / None \ "" 2 / -AES256 \ \[lq]AES256\[rq] server_side_encryption> The storage class to -use when storing objects in S3. -Choose a number from below, or type in your own value 1 / Default \ "" 2 -/ Standard storage class \ \[lq]STANDARD\[rq] 3 / Reduced redundancy -storage class \ \[lq]REDUCED_REDUNDANCY\[rq] 4 / Standard Infrequent -Access storage class \ \[lq]STANDARD_IA\[rq] storage_class> Remote -config \[em]\[em]\[em]\[em]\[em]\[em]\[en] [wasabi] env_auth = false -access_key_id = YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY -region = us\-east\-1 endpoint = s3.wasabisys.com location_constraint = -acl = server_side_encryption = storage_class = -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This\ will\ leave\ the\ config\ file\ looking\ like\ this. -\f[] -.fi -.PP -[wasabi] type = s3 provider = Wasabi env_auth = false access_key_id = -YOURACCESSKEY secret_access_key = YOURSECRETACCESSKEY region = endpoint -= s3.wasabisys.com location_constraint = acl = server_side_encryption = -storage_class = -.IP -.nf -\f[C] - -###\ Alibaba\ OSS\ {#alibaba\-oss} - -Here\ is\ an\ example\ of\ making\ an\ [Alibaba\ Cloud\ (Aliyun)\ OSS](https://www.alibabacloud.com/product/oss/) -configuration.\ \ First\ run: - -\ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> oss Type of storage to configure. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value [snip] 4 / Amazon S3 Compliant Storage Provider -(AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) -\ \[rq]s3" [snip] Storage> s3 Choose your S3 provider. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value 1 / Amazon Web Services (AWS) S3 \ \[rq]AWS" 2 / -Alibaba Cloud Object Storage System (OSS) formerly Aliyun -\ \[lq]Alibaba\[rq] 3 / Ceph Object Storage \ \[lq]Ceph\[rq] [snip] -provider> Alibaba Get AWS credentials from runtime (environment -variables or EC2/ECS meta data if no env vars). -Only applies if access_key_id and secret_access_key is blank. -Enter a boolean value (true or false). -Press Enter for the default (\[lq]false\[rq]). -Choose a number from below, or type in your own value 1 / Enter AWS -credentials in the next step \ \[lq]false\[rq] 2 / Get AWS credentials -from the environment (env vars or IAM) \ \[lq]true\[rq] env_auth> 1 AWS -Access Key ID. -Leave blank for anonymous access or runtime credentials. -Enter a string value. -Press Enter for the default ("\[lq]). access_key_id> accesskeyid AWS -Secret Access Key (password) Leave blank for anonymous access or runtime -credentials. Enter a string value. Press Enter for the default -(\[rq]\[lq]). secret_access_key> secretaccesskey Endpoint for OSS API. -Enter a string value. Press Enter for the default (\[rq]\[lq]). Choose a -number from below, or type in your own value 1 / East China 1 (Hangzhou) -\ \[rq]oss\-cn\-hangzhou.aliyuncs.com" 2 / East China 2 (Shanghai) -\ \[lq]oss\-cn\-shanghai.aliyuncs.com\[rq] 3 / North China 1 (Qingdao) -\ \[lq]oss\-cn\-qingdao.aliyuncs.com\[rq] [snip] endpoint> 1 Canned ACL -used when creating buckets and storing or copying objects. -.PP -Note that this ACL is applied when server side copying objects as S3 -doesn't copy the ACL from the source but rather writes a fresh one. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value 1 / Owner gets FULL_CONTROL. No one else has -access rights (default). \ \[rq]private" 2 / Owner gets FULL_CONTROL. -The AllUsers group gets READ access. -\ \[lq]public\-read\[rq] / Owner gets FULL_CONTROL. -The AllUsers group gets READ and WRITE access. -[snip] acl> 1 The storage class to use when storing new objects in OSS. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value 1 / Default \ \[rq]" 2 / Standard storage class -\ \[lq]STANDARD\[rq] 3 / Archive storage mode. -\ \[lq]GLACIER\[rq] 4 / Infrequent access storage mode. -\ \[lq]STANDARD_IA\[rq] storage_class> 1 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [oss] type = s3 provider = Alibaba -env_auth = false access_key_id = accesskeyid secret_access_key = -secretaccesskey endpoint = oss\-cn\-hangzhou.aliyuncs.com acl = private -storage_class = Standard \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this -is OK e) Edit this remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -###\ Netease\ NOS\ \ ### - -For\ Netease\ NOS\ configure\ as\ per\ the\ configurator\ `rclone\ config` -setting\ the\ provider\ `Netease`.\ \ This\ will\ automatically\ set -`force_path_style\ =\ false`\ which\ is\ necessary\ for\ it\ to\ run\ properly. - -Backblaze\ B2 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -B2\ is\ [Backblaze\[aq]s\ cloud\ storage\ system](https://www.backblaze.com/b2/). - -Paths\ are\ specified\ as\ `remote:bucket`\ (or\ `remote:`\ for\ the\ `lsd` -command.)\ \ You\ may\ put\ subdirectories\ in\ too,\ eg\ `remote:bucket/path/to/dir`. - -Here\ is\ an\ example\ of\ making\ a\ b2\ configuration.\ \ First\ run - -\ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process.\ \ To\ authenticate -you\ will\ either\ need\ your\ Account\ ID\ (a\ short\ hex\ number)\ and\ Master -Application\ Key\ (a\ long\ hex\ number)\ OR\ an\ Application\ Key,\ which\ is\ the -recommended\ method.\ See\ below\ for\ further\ details\ on\ generating\ and\ using -an\ Application\ Key. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote q) Quit config n/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Backblaze B2 \ \[lq]b2\[rq] [snip] Storage> b2 Account ID or Application -Key ID account> 123456789abc Application Key key> -0123456789abcdef0123456789abcdef0123456789 Endpoint for the service \- -leave blank normally. -endpoint> Remote config \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] -account = 123456789abc key = 0123456789abcdef0123456789abcdef0123456789 -endpoint = \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit -this remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This\ remote\ is\ called\ `remote`\ and\ can\ now\ be\ used\ like\ this - -See\ all\ buckets - -\ \ \ \ rclone\ lsd\ remote: - -Create\ a\ new\ bucket - -\ \ \ \ rclone\ mkdir\ remote:bucket - -List\ the\ contents\ of\ a\ bucket - -\ \ \ \ rclone\ ls\ remote:bucket - -Sync\ `/home/local/directory`\ to\ the\ remote\ bucket,\ deleting\ any -excess\ files\ in\ the\ bucket. - -\ \ \ \ rclone\ sync\ /home/local/directory\ remote:bucket - -###\ Application\ Keys\ ### - -B2\ supports\ multiple\ [Application\ Keys\ for\ different\ access\ permission -to\ B2\ Buckets](https://www.backblaze.com/b2/docs/application_keys.html). - -You\ can\ use\ these\ with\ rclone\ too;\ you\ will\ need\ to\ use\ rclone\ version\ 1.43 -or\ later. - -Follow\ Backblaze\[aq]s\ docs\ to\ create\ an\ Application\ Key\ with\ the\ required -permission\ and\ add\ the\ `applicationKeyId`\ as\ the\ `account`\ and\ the -`Application\ Key`\ itself\ as\ the\ `key`. - -Note\ that\ you\ must\ put\ the\ _applicationKeyId_\ as\ the\ `account`\ \[en]\ you -can\[aq]t\ use\ the\ master\ Account\ ID.\ \ If\ you\ try\ then\ B2\ will\ return\ 401 -errors. - -###\ \-\-fast\-list\ ### - -This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer -transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone -docs](/docs/#fast\-list)\ for\ more\ details. - -###\ Modified\ time\ ### - -The\ modified\ time\ is\ stored\ as\ metadata\ on\ the\ object\ as -`X\-Bz\-Info\-src_last_modified_millis`\ as\ milliseconds\ since\ 1970\-01\-01 -in\ the\ Backblaze\ standard.\ \ Other\ tools\ should\ be\ able\ to\ use\ this\ as -a\ modified\ time. - -Modified\ times\ are\ used\ in\ syncing\ and\ are\ fully\ supported.\ Note\ that -if\ a\ modification\ time\ needs\ to\ be\ updated\ on\ an\ object\ then\ it\ will -create\ a\ new\ version\ of\ the\ object. - -####\ Restricted\ filename\ characters - -In\ addition\ to\ the\ [default\ restricted\ characters\ set](/overview/#restricted\-characters) -the\ following\ characters\ are\ also\ replaced: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - -###\ SHA1\ checksums\ ### - -The\ SHA1\ checksums\ of\ the\ files\ are\ checked\ on\ upload\ and\ download\ and -will\ be\ used\ in\ the\ syncing\ process. - -Large\ files\ (bigger\ than\ the\ limit\ in\ `\-\-b2\-upload\-cutoff`)\ which\ are -uploaded\ in\ chunks\ will\ store\ their\ SHA1\ on\ the\ object\ as -`X\-Bz\-Info\-large_file_sha1`\ as\ recommended\ by\ Backblaze. - -For\ a\ large\ file\ to\ be\ uploaded\ with\ an\ SHA1\ checksum,\ the\ source -needs\ to\ support\ SHA1\ checksums.\ The\ local\ disk\ supports\ SHA1 -checksums\ so\ large\ file\ transfers\ from\ local\ disk\ will\ have\ an\ SHA1. -See\ [the\ overview](/overview/#features)\ for\ exactly\ which\ remotes -support\ SHA1. - -Sources\ which\ don\[aq]t\ support\ SHA1,\ in\ particular\ `crypt`\ will\ upload -large\ files\ without\ SHA1\ checksums.\ \ This\ may\ be\ fixed\ in\ the\ future -(see\ [#1767](https://github.com/rclone/rclone/issues/1767)). - -Files\ sizes\ below\ `\-\-b2\-upload\-cutoff`\ will\ always\ have\ an\ SHA1 -regardless\ of\ the\ source. - -###\ Transfers\ ### - -Backblaze\ recommends\ that\ you\ do\ lots\ of\ transfers\ simultaneously\ for -maximum\ speed.\ \ In\ tests\ from\ my\ SSD\ equipped\ laptop\ the\ optimum -setting\ is\ about\ `\-\-transfers\ 32`\ though\ higher\ numbers\ may\ be\ used -for\ a\ slight\ speed\ improvement.\ The\ optimum\ number\ for\ you\ may\ vary -depending\ on\ your\ hardware,\ how\ big\ the\ files\ are,\ how\ much\ you\ want -to\ load\ your\ computer,\ etc.\ \ The\ default\ of\ `\-\-transfers\ 4`\ is -definitely\ too\ low\ for\ Backblaze\ B2\ though. - -Note\ that\ uploading\ big\ files\ (bigger\ than\ 200\ MB\ by\ default)\ will\ use -a\ 96\ MB\ RAM\ buffer\ by\ default.\ \ There\ can\ be\ at\ most\ `\-\-transfers`\ of -these\ in\ use\ at\ any\ moment,\ so\ this\ sets\ the\ upper\ limit\ on\ the\ memory -used. - -###\ Versions\ ### - -When\ rclone\ uploads\ a\ new\ version\ of\ a\ file\ it\ creates\ a\ [new\ version -of\ it](https://www.backblaze.com/b2/docs/file_versions.html). -Likewise\ when\ you\ delete\ a\ file,\ the\ old\ version\ will\ be\ marked\ hidden -and\ still\ be\ available.\ \ Conversely,\ you\ may\ opt\ in\ to\ a\ "hard\ delete" -of\ files\ with\ the\ `\-\-b2\-hard\-delete`\ flag\ which\ would\ permanently\ remove -the\ file\ instead\ of\ hiding\ it. - -Old\ versions\ of\ files,\ where\ available,\ are\ visible\ using\ the\ -`\-\-b2\-versions`\ flag. - -**NB**\ Note\ that\ `\-\-b2\-versions`\ does\ not\ work\ with\ crypt\ at\ the -moment\ [#1627](https://github.com/rclone/rclone/issues/1627).\ Using -[\-\-backup\-dir](/docs/#backup\-dir\-dir)\ with\ rclone\ is\ the\ recommended -way\ of\ working\ around\ this. - -If\ you\ wish\ to\ remove\ all\ the\ old\ versions\ then\ you\ can\ use\ the -`rclone\ cleanup\ remote:bucket`\ command\ which\ will\ delete\ all\ the\ old -versions\ of\ files,\ leaving\ the\ current\ ones\ intact.\ \ You\ can\ also -supply\ a\ path\ and\ only\ old\ versions\ under\ that\ path\ will\ be\ deleted, -eg\ `rclone\ cleanup\ remote:bucket/path/to/stuff`. - -Note\ that\ `cleanup`\ will\ remove\ partially\ uploaded\ files\ from\ the\ bucket -if\ they\ are\ more\ than\ a\ day\ old. - -When\ you\ `purge`\ a\ bucket,\ the\ current\ and\ the\ old\ versions\ will\ be -deleted\ then\ the\ bucket\ will\ be\ deleted. - -However\ `delete`\ will\ cause\ the\ current\ versions\ of\ the\ files\ to -become\ hidden\ old\ versions. - -Here\ is\ a\ session\ showing\ the\ listing\ and\ retrieval\ of\ an\ old -version\ followed\ by\ a\ `cleanup`\ of\ the\ old\ versions. - -Show\ current\ version\ and\ all\ the\ versions\ with\ `\-\-b2\-versions`\ flag. -\f[] -.fi -.PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt -.PP -$ rclone \-q \[en]b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt -.IP -.nf -\f[C] - -Retrieve\ an\ old\ version -\f[] -.fi -.PP -$ rclone \-q \[en]b2\-versions copy -b2:cleanup\-test/one\-v2016\-07\-04\-141003\-000.txt /tmp -.PP -$ ls \-l /tmp/one\-v2016\-07\-04\-141003\-000.txt \-rw\-rw\-r\[en] 1 ncw -ncw 16 Jul 2 17:46 /tmp/one\-v2016\-07\-04\-141003\-000.txt -.IP -.nf -\f[C] - -Clean\ up\ all\ the\ old\ versions\ and\ show\ that\ they\[aq]ve\ gone. -\f[] -.fi -.PP -$ rclone \-q cleanup b2:cleanup\-test -.PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt -.PP -$ rclone \-q \[en]b2\-versions ls b2:cleanup\-test 9 one.txt -.IP -.nf -\f[C] - -###\ Data\ usage\ ### - -It\ is\ useful\ to\ know\ how\ many\ requests\ are\ sent\ to\ the\ server\ in\ different\ scenarios. - -All\ copy\ commands\ send\ the\ following\ 4\ requests: -\f[] -.fi -.PP -/b2api/v1/b2_authorize_account /b2api/v1/b2_create_bucket -/b2api/v1/b2_list_buckets /b2api/v1/b2_list_file_names -.IP -.nf -\f[C] - -The\ `b2_list_file_names`\ request\ will\ be\ sent\ once\ for\ every\ 1k\ files -in\ the\ remote\ path,\ providing\ the\ checksum\ and\ modification\ time\ of -the\ listed\ files.\ As\ of\ version\ 1.33\ issue -[#818](https://github.com/rclone/rclone/issues/818)\ causes\ extra\ requests -to\ be\ sent\ when\ using\ B2\ with\ Crypt.\ When\ a\ copy\ operation\ does\ not -require\ any\ files\ to\ be\ uploaded,\ no\ more\ requests\ will\ be\ sent. - -Uploading\ files\ that\ do\ not\ require\ chunking,\ will\ send\ 2\ requests\ per -file\ upload: -\f[] -.fi -.PP -/b2api/v1/b2_get_upload_url /b2api/v1/b2_upload_file/ -.IP -.nf -\f[C] - -Uploading\ files\ requiring\ chunking,\ will\ send\ 2\ requests\ (one\ each\ to -start\ and\ finish\ the\ upload)\ and\ another\ 2\ requests\ for\ each\ chunk: -\f[] -.fi -.PP -/b2api/v1/b2_start_large_file /b2api/v1/b2_get_upload_part_url -/b2api/v1/b2_upload_part/ /b2api/v1/b2_finish_large_file -.IP -.nf -\f[C] - -####\ Versions\ #### - -Versions\ can\ be\ viewed\ with\ the\ `\-\-b2\-versions`\ flag.\ When\ it\ is\ set -rclone\ will\ show\ and\ act\ on\ older\ versions\ of\ files.\ \ For\ example - -Listing\ without\ `\-\-b2\-versions` -\f[] -.fi -.PP -$ rclone \-q ls b2:cleanup\-test 9 one.txt -.IP -.nf -\f[C] - -And\ with -\f[] -.fi -.PP -$ rclone \-q \[en]b2\-versions ls b2:cleanup\-test 9 one.txt 8 -one\-v2016\-07\-04\-141032\-000.txt 16 -one\-v2016\-07\-04\-141003\-000.txt 15 -one\-v2016\-07\-02\-155621\-000.txt -.IP -.nf -\f[C] - -Showing\ that\ the\ current\ version\ is\ unchanged\ but\ older\ versions\ can -be\ seen.\ \ These\ have\ the\ UTC\ date\ that\ they\ were\ uploaded\ to\ the -server\ to\ the\ nearest\ millisecond\ appended\ to\ them. - -Note\ that\ when\ using\ `\-\-b2\-versions`\ no\ file\ write\ operations\ are -permitted,\ so\ you\ can\[aq]t\ upload\ files\ or\ delete\ them. - -###\ B2\ and\ rclone\ link\ ### - -Rclone\ supports\ generating\ file\ share\ links\ for\ private\ B2\ buckets. -They\ can\ either\ be\ for\ a\ file\ for\ example: -\f[] -.fi -.PP -\&./rclone link B2:bucket/path/to/file.txt -https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -or\ if\ run\ on\ a\ directory\ you\ will\ get: -\f[] -.fi -.PP -\&./rclone link B2:bucket/path -https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx -.IP -.nf -\f[C] - -you\ can\ then\ use\ the\ authorization\ token\ (the\ part\ of\ the\ url\ from\ the -\ `?Authorization=`\ on)\ on\ any\ file\ path\ under\ that\ directory.\ For\ example: -\f[] -.fi -.PP -https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx -https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx -.IP -.nf -\f[C] - - -###\ 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\[aq]t\ upload\ files\ or\ delete\ them. - -\-\ Config:\ \ \ \ \ \ versions -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_VERSIONS -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-b2\-upload\-cutoff - -Cutoff\ for\ switching\ to\ chunked\ upload. - -Files\ above\ this\ size\ will\ be\ uploaded\ in\ chunks\ of\ "\-\-b2\-chunk\-size". - -This\ value\ should\ be\ set\ no\ larger\ than\ 4.657GiB\ (==\ 5GB). - -\-\ Config:\ \ \ \ \ \ upload_cutoff -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_UPLOAD_CUTOFF -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 200M - -####\ \-\-b2\-chunk\-size - -Upload\ chunk\ size.\ Must\ fit\ in\ memory. - -When\ uploading\ large\ files,\ chunk\ the\ file\ into\ this\ size.\ \ Note\ that -these\ chunks\ are\ buffered\ in\ memory\ and\ there\ might\ a\ maximum\ of -"\-\-transfers"\ chunks\ in\ progress\ at\ once.\ \ 5,000,000\ Bytes\ is\ the -minimum\ size. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 96M - -####\ \-\-b2\-disable\-checksum - -Disable\ checksums\ for\ large\ (>\ upload\ cutoff)\ files - -\-\ Config:\ \ \ \ \ \ disable_checksum -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_DISABLE_CHECKSUM -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-b2\-download\-url - -Custom\ endpoint\ for\ downloads. - -This\ is\ usually\ set\ to\ a\ Cloudflare\ CDN\ URL\ as\ Backblaze\ offers -free\ egress\ for\ data\ downloaded\ through\ the\ Cloudflare\ network. -This\ is\ probably\ only\ useful\ for\ a\ public\ bucket. -Leave\ blank\ if\ you\ want\ to\ use\ the\ endpoint\ provided\ by\ Backblaze. - -\-\ Config:\ \ \ \ \ \ download_url -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_DOWNLOAD_URL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-b2\-download\-auth\-duration - -Time\ before\ the\ authorization\ token\ will\ expire\ in\ s\ or\ suffix\ ms|s|m|h|d. - -The\ duration\ before\ the\ download\ authorization\ token\ will\ expire. -The\ minimum\ value\ is\ 1\ second.\ The\ maximum\ value\ is\ one\ week. - -\-\ Config:\ \ \ \ \ \ download_auth_duration -\-\ Env\ Var:\ \ \ \ \ RCLONE_B2_DOWNLOAD_AUTH_DURATION -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 1w - - - -Box -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths\ are\ specified\ as\ `remote:path` - -Paths\ may\ be\ as\ deep\ as\ required,\ eg\ `remote:directory/subdirectory`. - -The\ initial\ setup\ for\ Box\ involves\ getting\ a\ token\ from\ Box\ which\ you -can\ do\ either\ in\ your\ browser,\ or\ with\ a\ config.json\ downloaded\ from\ Box -to\ use\ JWT\ authentication.\ \ `rclone\ config`\ walks\ you\ through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.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 -\ \[lq]box\[rq] [snip] Storage> box Box App Client Id \- leave blank -normally. -client_id> Box App Client Secret \- leave blank normally. -client_secret> Box App config.json location Leave blank normally. -Enter a string value. -Press Enter for the default ("\[lq]). config_json> `enterprise' or -`user' depending on the type of token being requested. Enter a string -value. Press Enter for the default (\[rq]user\[lq]). box_sub_type> -Remote config Use auto config? * Say Y if not sure * Say N if you are -working on a remote or headless machine y) Yes n) No y/n> y If your -browser doesn't open automatically go to the following link: -http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code\&... Got code \[em]\[em]\[em]\[em]\[em]\[em]\[en] -[remote] client_id = client_secret = token = -{\[rq]access_token\[lq]:\[rq]XXX\[lq],\[rq]token_type\[lq]:\[rq]bearer\[lq],\[rq]refresh_token\[lq]:\[rq]XXX\[lq],\[rq]expiry\[lq]:\[rq]XXX"} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -See\ the\ [remote\ setup\ docs](https://rclone.org/remote_setup/)\ for\ how\ to\ set\ it\ up\ on\ a -machine\ with\ no\ Internet\ browser\ available. - -Note\ that\ rclone\ runs\ a\ webserver\ on\ your\ local\ machine\ to\ collect\ the -token\ as\ returned\ from\ Box.\ This\ only\ runs\ from\ the\ moment\ it\ opens -your\ browser\ to\ the\ moment\ you\ get\ back\ the\ verification\ code.\ \ This -is\ on\ `http://127.0.0.1:53682/`\ and\ this\ it\ may\ require\ you\ to\ unblock -it\ temporarily\ if\ you\ are\ running\ a\ host\ firewall. - -Once\ configured\ you\ can\ then\ use\ `rclone`\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ Box - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ Box - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ an\ Box\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -###\ Using\ rclone\ with\ an\ Enterprise\ account\ with\ SSO\ ### - -If\ you\ have\ an\ "Enterprise"\ account\ type\ with\ Box\ with\ single\ sign\ on -(SSO),\ you\ need\ to\ create\ a\ password\ to\ use\ Box\ with\ rclone.\ This\ can -be\ done\ at\ your\ Enterprise\ Box\ account\ by\ going\ to\ Settings,\ "Account" -Tab,\ and\ then\ set\ the\ password\ in\ the\ "Authentication"\ field. - -Once\ you\ have\ done\ this,\ you\ can\ setup\ your\ Enterprise\ Box\ account -using\ the\ same\ procedure\ detailed\ above\ in\ the,\ using\ the\ password\ you -have\ just\ set. - -###\ Invalid\ refresh\ token\ ### - -According\ to\ the\ [box\ docs](https://developer.box.com/v2.0/docs/oauth\-20#section\-6\-using\-the\-access\-and\-refresh\-tokens): - ->\ Each\ refresh_token\ is\ valid\ for\ one\ use\ in\ 60\ days. - -This\ means\ that\ if\ you - -\ \ *\ Don\[aq]t\ use\ the\ box\ remote\ for\ 60\ days -\ \ *\ Copy\ the\ config\ file\ with\ a\ box\ refresh\ token\ in\ and\ use\ it\ in\ two\ places -\ \ *\ Get\ an\ error\ on\ a\ token\ refresh - -then\ rclone\ will\ return\ an\ error\ which\ includes\ the\ text\ `Invalid -refresh\ token`. - -To\ fix\ this\ you\ will\ need\ to\ use\ oauth2\ again\ to\ update\ the\ refresh -token.\ \ You\ can\ use\ the\ methods\ in\ [the\ remote\ setup -docs](https://rclone.org/remote_setup/),\ bearing\ in\ mind\ that\ if\ you\ use\ the\ copy\ the -config\ file\ method,\ you\ should\ not\ use\ that\ remote\ on\ the\ computer\ you -did\ the\ authentication\ on. - -Here\ is\ how\ to\ do\ it. -\f[] -.fi -.PP -$ rclone config Current remotes: -.PP -Name Type ==== ==== remote box -.IP "e)" 3 -Edit existing remote -.IP "f)" 3 -New remote -.IP "g)" 3 -Delete remote -.IP "h)" 3 -Rename remote -.IP "i)" 3 -Copy remote -.IP "j)" 3 -Set configuration password -.IP "k)" 3 -Quit config e/n/d/r/c/s/q> e Choose a number from below, or type in an -existing value 1 > remote remote> remote -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = box token = -{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2017\-07\-08T23:40:08.059167677+01:00\[rq]} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] Edit remote Value -\[lq]client_id\[rq] = "" Edit? -(y/n)> -.IP "l)" 3 -Yes -.IP "m)" 3 -No y/n> n Value \[lq]client_secret\[rq] = "" Edit? -(y/n)> -.IP "n)" 3 -Yes -.IP "o)" 3 -No y/n> n Remote config Already have a token \- refresh? -.IP "p)" 3 -Yes -.IP "q)" 3 -No y/n> y Use auto config? +Here is how to use some of them: .IP \[bu] 2 -Say Y if not sure +Memory: \f[C]go tool pprof http://localhost:5572/debug/pprof/heap\f[R] .IP \[bu] 2 -Say N if you are working on a remote or headless machine -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn't open automatically go to the following -link: http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code\&... Got code \[em]\[em]\[em]\[em]\[em]\[em]\[en] -[remote] type = box token = -{\[lq]access_token\[rq]:\[lq]YYY\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]YYY\[rq],\[lq]expiry\[rq]:\[lq]2017\-07\-23T12:22:29.259137901+01:00\[rq]} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -###\ Modified\ time\ and\ hashes\ ### - -Box\ allows\ modification\ times\ to\ be\ set\ on\ objects\ accurate\ to\ 1 -second.\ \ These\ will\ be\ used\ to\ detect\ whether\ objects\ need\ syncing\ or -not. - -Box\ supports\ SHA1\ type\ hashes,\ so\ you\ can\ use\ the\ `\-\-checksum` -flag. - -####\ Restricted\ filename\ characters - -In\ addition\ to\ the\ [default\ restricted\ characters\ set](/overview/#restricted\-characters) -the\ following\ characters\ are\ also\ replaced: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | - -File\ names\ can\ also\ not\ end\ with\ the\ following\ characters. -These\ only\ get\ replaced\ if\ they\ are\ last\ character\ in\ the\ name: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - -###\ Transfers\ ### - -For\ files\ above\ 50MB\ rclone\ will\ use\ a\ chunked\ transfer.\ \ Rclone\ will -upload\ up\ to\ `\-\-transfers`\ chunks\ at\ the\ same\ time\ (shared\ among\ all -the\ multipart\ uploads).\ \ Chunks\ are\ buffered\ in\ memory\ and\ are -normally\ 8MB\ so\ increasing\ `\-\-transfers`\ will\ increase\ memory\ use. - -###\ Deleting\ files\ ### - -Depending\ on\ the\ enterprise\ settings\ for\ your\ user,\ the\ item\ will -either\ be\ actually\ deleted\ from\ Box\ or\ moved\ to\ the\ trash. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ box\ (Box). - -####\ \-\-box\-client\-id - -Box\ App\ Client\ Id. -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_CLIENT_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-box\-client\-secret - -Box\ App\ Client\ Secret -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_secret -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_CLIENT_SECRET -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-box\-box\-config\-file - -Box\ App\ config.json\ location -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ box_config_file -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_BOX_CONFIG_FILE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-box\-box\-sub\-type - - - -\-\ Config:\ \ \ \ \ \ box_sub_type -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_BOX_SUB_TYPE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "user" -\-\ Examples: -\ \ \ \ \-\ "user" -\ \ \ \ \ \ \ \ \-\ Rclone\ should\ act\ on\ behalf\ of\ a\ user -\ \ \ \ \-\ "enterprise" -\ \ \ \ \ \ \ \ \-\ Rclone\ should\ act\ on\ behalf\ of\ a\ service\ account - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ box\ (Box). - -####\ \-\-box\-upload\-cutoff - -Cutoff\ for\ switching\ to\ multipart\ upload\ (>=\ 50MB). - -\-\ Config:\ \ \ \ \ \ upload_cutoff -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_UPLOAD_CUTOFF -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 50M - -####\ \-\-box\-commit\-retries - -Max\ number\ of\ times\ to\ try\ committing\ a\ multipart\ file. - -\-\ Config:\ \ \ \ \ \ commit_retries -\-\ Env\ Var:\ \ \ \ \ RCLONE_BOX_COMMIT_RETRIES -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 100 - - - -###\ Limitations\ ### - -Note\ that\ Box\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a\ file\ called -"Hello.doc"\ and\ one\ called\ "hello.doc". - -Box\ file\ names\ can\[aq]t\ have\ the\ `\\`\ character\ in.\ \ rclone\ maps\ this\ to -and\ from\ an\ identical\ looking\ unicode\ equivalent\ `＼`. - -Box\ only\ supports\ filenames\ up\ to\ 255\ characters\ in\ length. - -Cache\ (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ `cache`\ remote\ wraps\ another\ existing\ remote\ and\ stores\ file\ structure -and\ its\ data\ for\ long\ running\ tasks\ like\ `rclone\ mount`. - -To\ get\ started\ you\ just\ need\ to\ have\ an\ existing\ remote\ which\ can\ be\ configured -with\ `cache`. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `test\-cache`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> test\-cache Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Cache -a remote \ \[lq]cache\[rq] [snip] Storage> cache Remote to cache. -Normally should contain a `:' and a path, eg -\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe -\[lq]myremote:\[rq] (not recommended). -remote> local:/test Optional: The URL of the Plex server plex_url> -http://127.0.0.1:32400 Optional: The username of the Plex user -plex_username> dummyusername Optional: The password of the Plex user y) -Yes type in my own password g) Generate random password n) No leave this -optional password blank y/g/n> y Enter the password: password: Confirm -the password: password: The size of a chunk. -Lower value good for slow connections but can affect seamless reading. -Default: 5M Choose a number from below, or type in your own value 1 / -1MB \ \[lq]1m\[rq] 2 / 5 MB \ \[lq]5M\[rq] 3 / 10 MB \ \[lq]10M\[rq] -chunk_size> 2 How much time should object info (file size, file hashes -etc) be stored in cache. -Use a very high value if you don't plan on changing the source FS from -outside the cache. -Accepted units are: \[lq]s\[rq], \[lq]m\[rq], \[lq]h\[rq]. -Default: 5m Choose a number from below, or type in your own value 1 / 1 -hour \ \[lq]1h\[rq] 2 / 24 hours \ \[lq]24h\[rq] 3 / 24 hours -\ \[lq]48h\[rq] info_age> 2 The maximum size of stored chunks. -When the storage grows beyond this size, the oldest chunks will be -deleted. -Default: 10G Choose a number from below, or type in your own value 1 / -500 MB \ \[lq]500M\[rq] 2 / 1 GB \ \[lq]1G\[rq] 3 / 10 GB -\ \[lq]10G\[rq] chunk_total_size> 3 Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [test\-cache] remote = local:/test -plex_url = http://127.0.0.1:32400 plex_username = dummyusername -plex_password = *** ENCRYPTED *** chunk_size = 5M info_age = 48h -chunk_total_size = 10G -.IP -.nf -\f[C] - -You\ can\ then\ use\ it\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ drive - -\ \ \ \ rclone\ lsd\ test\-cache: - -List\ all\ the\ files\ in\ your\ drive - -\ \ \ \ rclone\ ls\ test\-cache: - -To\ start\ a\ cached\ mount - -\ \ \ \ rclone\ mount\ \-\-allow\-other\ test\-cache:\ /var/tmp/test\-cache - -###\ Write\ Features\ ### - -###\ Offline\ uploading\ ### - -In\ an\ effort\ to\ make\ writing\ through\ cache\ more\ reliable,\ the\ backend\ -now\ supports\ this\ feature\ which\ can\ be\ activated\ by\ specifying\ a -`cache\-tmp\-upload\-path`. - -A\ files\ goes\ through\ these\ states\ when\ using\ this\ feature: - -1.\ An\ upload\ is\ started\ (usually\ by\ copying\ a\ file\ on\ the\ cache\ remote) -2.\ When\ the\ copy\ to\ the\ temporary\ location\ is\ complete\ the\ file\ is\ part\ -of\ the\ cached\ remote\ and\ looks\ and\ behaves\ like\ any\ other\ file\ (reading\ included) -3.\ After\ `cache\-tmp\-wait\-time`\ passes\ and\ the\ file\ is\ next\ in\ line,\ `rclone\ move`\ -is\ used\ to\ move\ the\ file\ to\ the\ cloud\ provider -4.\ Reading\ the\ file\ still\ works\ during\ the\ upload\ but\ most\ modifications\ on\ it\ will\ be\ prohibited -5.\ Once\ the\ move\ is\ complete\ the\ file\ is\ unlocked\ for\ modifications\ as\ it -becomes\ as\ any\ other\ regular\ file -6.\ If\ the\ file\ is\ being\ read\ through\ `cache`\ when\ it\[aq]s\ actually -deleted\ from\ the\ temporary\ path\ then\ `cache`\ will\ simply\ swap\ the\ source -to\ the\ cloud\ provider\ without\ interrupting\ the\ reading\ (small\ blip\ can\ happen\ though) - -Files\ are\ uploaded\ in\ sequence\ and\ only\ one\ file\ is\ uploaded\ at\ a\ time. -Uploads\ will\ be\ stored\ in\ a\ queue\ and\ be\ processed\ based\ on\ the\ order\ they\ were\ added. -The\ queue\ and\ the\ temporary\ storage\ is\ persistent\ across\ restarts\ but -can\ be\ cleared\ on\ startup\ with\ the\ `\-\-cache\-db\-purge`\ flag. - -###\ Write\ Support\ ### - -Writes\ are\ supported\ through\ `cache`. -One\ caveat\ is\ that\ a\ mounted\ cache\ remote\ does\ not\ add\ any\ retry\ or\ fallback -mechanism\ to\ the\ upload\ operation.\ This\ will\ depend\ on\ the\ implementation -of\ the\ wrapped\ remote.\ Consider\ using\ `Offline\ uploading`\ for\ reliable\ writes. - -One\ special\ case\ is\ covered\ with\ `cache\-writes`\ which\ will\ cache\ the\ file -data\ at\ the\ same\ time\ as\ the\ upload\ when\ it\ is\ enabled\ making\ it\ available -from\ the\ cache\ store\ immediately\ once\ the\ upload\ is\ finished. - -###\ Read\ Features\ ### - -####\ Multiple\ connections\ #### - -To\ counter\ the\ high\ latency\ between\ a\ local\ PC\ where\ rclone\ is\ running -and\ cloud\ providers,\ the\ cache\ remote\ can\ split\ multiple\ requests\ to\ the -cloud\ provider\ for\ smaller\ file\ chunks\ and\ combines\ them\ together\ locally -where\ they\ can\ be\ available\ almost\ immediately\ before\ the\ reader\ usually -needs\ them. - -This\ is\ similar\ to\ buffering\ when\ media\ files\ are\ played\ online.\ Rclone -will\ stay\ around\ the\ current\ marker\ but\ always\ try\ its\ best\ to\ stay\ ahead -and\ prepare\ the\ data\ before. - -####\ Plex\ Integration\ #### - -There\ is\ a\ direct\ integration\ with\ Plex\ which\ allows\ cache\ to\ detect\ during\ reading -if\ the\ file\ is\ in\ playback\ or\ not.\ This\ helps\ cache\ to\ adapt\ how\ it\ queries -the\ cloud\ provider\ depending\ on\ what\ is\ needed\ for. - -Scans\ will\ have\ a\ minimum\ amount\ of\ workers\ (1)\ while\ in\ a\ confirmed\ playback\ cache -will\ deploy\ the\ configured\ number\ of\ workers. - -This\ integration\ opens\ the\ doorway\ to\ additional\ performance\ improvements -which\ will\ be\ explored\ in\ the\ near\ future. - -**Note:**\ If\ Plex\ options\ are\ not\ configured,\ `cache`\ will\ function\ with\ its -configured\ options\ without\ adapting\ any\ of\ its\ settings. - -How\ to\ enable?\ Run\ `rclone\ config`\ and\ add\ all\ the\ Plex\ options\ (endpoint,\ username -and\ password)\ in\ your\ remote\ and\ it\ will\ be\ automatically\ enabled. - -Affected\ settings: -\-\ `cache\-workers`:\ _Configured\ value_\ during\ confirmed\ playback\ or\ _1_\ all\ the\ other\ times - -#####\ Certificate\ Validation\ ##### - -When\ the\ Plex\ server\ is\ configured\ to\ only\ accept\ secure\ connections,\ it\ is -possible\ to\ use\ `.plex.direct`\ URL\[aq]s\ to\ ensure\ certificate\ validation\ succeeds. -These\ URL\[aq]s\ are\ used\ by\ Plex\ internally\ to\ connect\ to\ the\ Plex\ server\ securely. - -The\ format\ for\ this\ URL\[aq]s\ is\ the\ following: - -https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ - -The\ `ip\-with\-dots\-replaced`\ part\ can\ be\ any\ IPv4\ address,\ where\ the\ dots -have\ been\ replaced\ with\ dashes,\ e.g.\ `127.0.0.1`\ becomes\ `127\-0\-0\-1`. - -To\ get\ the\ `server\-hash`\ part,\ the\ easiest\ way\ is\ to\ visit - -https://plex.tv/api/resources?includeHttps=1&X\-Plex\-Token=your\-plex\-token - -This\ page\ will\ list\ all\ the\ available\ Plex\ servers\ for\ your\ account -with\ at\ least\ one\ `.plex.direct`\ link\ for\ each.\ Copy\ one\ URL\ and\ replace -the\ IP\ address\ with\ the\ desired\ address.\ This\ can\ be\ used\ as\ the -`plex_url`\ value. - -###\ Known\ issues\ ### - -####\ Mount\ and\ \-\-dir\-cache\-time\ #### - -\-\-dir\-cache\-time\ controls\ the\ first\ layer\ of\ directory\ caching\ which\ works\ at\ the\ mount\ layer. -Being\ an\ independent\ caching\ mechanism\ from\ the\ `cache`\ backend,\ it\ will\ manage\ its\ own\ entries -based\ on\ the\ configured\ time. - -To\ avoid\ getting\ in\ a\ scenario\ where\ dir\ cache\ has\ obsolete\ data\ and\ cache\ would\ have\ the\ correct -one,\ try\ to\ set\ `\-\-dir\-cache\-time`\ to\ a\ lower\ time\ than\ `\-\-cache\-info\-age`.\ Default\ values\ are -already\ configured\ in\ this\ way.\ - -####\ Windows\ support\ \-\ Experimental\ #### - -There\ are\ a\ couple\ of\ issues\ with\ Windows\ `mount`\ functionality\ that\ still\ require\ some\ investigations. -It\ should\ be\ considered\ as\ experimental\ thus\ far\ as\ fixes\ come\ in\ for\ this\ OS. - -Most\ of\ the\ issues\ seem\ to\ be\ related\ to\ the\ difference\ between\ filesystems -on\ Linux\ flavors\ and\ Windows\ as\ cache\ is\ heavily\ dependant\ on\ them. - -Any\ reports\ or\ feedback\ on\ how\ cache\ behaves\ on\ this\ OS\ is\ greatly\ appreciated. -\ -\-\ https://github.com/rclone/rclone/issues/1935 -\-\ https://github.com/rclone/rclone/issues/1907 -\-\ https://github.com/rclone/rclone/issues/1834\ - -####\ Risk\ of\ throttling\ #### - -Future\ iterations\ of\ the\ cache\ backend\ will\ make\ use\ of\ the\ pooling\ functionality -of\ the\ cloud\ provider\ to\ synchronize\ and\ at\ the\ same\ time\ make\ writing\ through\ it -more\ tolerant\ to\ failures.\ - -There\ are\ a\ couple\ of\ enhancements\ in\ track\ to\ add\ these\ but\ in\ the\ meantime -there\ is\ a\ valid\ concern\ that\ the\ expiring\ cache\ listings\ can\ lead\ to\ cloud\ provider -throttles\ or\ bans\ due\ to\ repeated\ queries\ on\ it\ for\ very\ large\ mounts. - -Some\ recommendations: -\-\ don\[aq]t\ use\ a\ very\ small\ interval\ for\ entry\ informations\ (`\-\-cache\-info\-age`) -\-\ while\ writes\ aren\[aq]t\ yet\ optimised,\ you\ can\ still\ write\ through\ `cache`\ which\ gives\ you\ the\ advantage -of\ adding\ the\ file\ in\ the\ cache\ at\ the\ same\ time\ if\ configured\ to\ do\ so. - -Future\ enhancements: - -\-\ https://github.com/rclone/rclone/issues/1937 -\-\ https://github.com/rclone/rclone/issues/1936\ - -####\ cache\ and\ crypt\ #### - -One\ common\ scenario\ is\ to\ keep\ your\ data\ encrypted\ in\ the\ cloud\ provider -using\ the\ `crypt`\ remote.\ `crypt`\ uses\ a\ similar\ technique\ to\ wrap\ around -an\ existing\ remote\ and\ handles\ this\ translation\ in\ a\ seamless\ way. - -There\ is\ an\ issue\ with\ wrapping\ the\ remotes\ in\ this\ order: -**cloud\ remote**\ \->\ **crypt**\ \->\ **cache** - -During\ testing,\ I\ experienced\ a\ lot\ of\ bans\ with\ the\ remotes\ in\ this\ order. -I\ suspect\ it\ might\ be\ related\ to\ how\ crypt\ opens\ files\ on\ the\ cloud\ provider -which\ makes\ it\ think\ we\[aq]re\ downloading\ the\ full\ file\ instead\ of\ small\ chunks. -Organizing\ the\ remotes\ in\ this\ order\ yields\ better\ results: -**cloud\ remote**\ \->\ **cache**\ \->\ **crypt** - -####\ absolute\ remote\ paths\ #### - -`cache`\ can\ not\ differentiate\ between\ relative\ and\ absolute\ paths\ for\ the\ wrapped\ remote. -Any\ path\ given\ in\ the\ `remote`\ config\ setting\ and\ on\ the\ command\ line\ will\ be\ passed\ to -the\ wrapped\ remote\ as\ is,\ but\ for\ storing\ the\ chunks\ on\ disk\ the\ path\ will\ be\ made -relative\ by\ removing\ any\ leading\ `/`\ character. - -This\ behavior\ is\ irrelevant\ for\ most\ backend\ types,\ but\ there\ are\ backends\ where\ a\ leading\ `/` -changes\ the\ effective\ directory,\ e.g.\ in\ the\ `sftp`\ backend\ paths\ starting\ with\ a\ `/`\ are -relative\ to\ the\ root\ of\ the\ SSH\ server\ and\ paths\ without\ are\ relative\ to\ the\ user\ home\ directory. -As\ a\ result\ `sftp:bin`\ and\ `sftp:/bin`\ will\ share\ the\ same\ cache\ folder,\ even\ if\ they\ represent -a\ different\ directory\ on\ the\ SSH\ server. - -###\ Cache\ and\ Remote\ Control\ (\-\-rc)\ ### -Cache\ supports\ the\ new\ `\-\-rc`\ mode\ in\ rclone\ and\ can\ be\ remote\ controlled\ through\ the\ following\ end\ points: -By\ default,\ the\ listener\ is\ disabled\ if\ you\ do\ not\ add\ the\ flag. - -###\ rc\ cache/expire -Purge\ a\ remote\ from\ the\ cache\ backend.\ Supports\ either\ a\ directory\ or\ a\ file. -It\ supports\ both\ encrypted\ and\ unencrypted\ file\ names\ if\ cache\ is\ wrapped\ by\ crypt. - -Params: -\ \ \-\ **remote**\ =\ path\ to\ remote\ **(required)** -\ \ \-\ **withData**\ =\ true/false\ to\ delete\ cached\ data\ (chunks)\ as\ well\ _(optional,\ false\ by\ default)_ - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ cache\ (Cache\ a\ remote). - -####\ \-\-cache\-remote - -Remote\ to\ cache. -Normally\ should\ contain\ a\ \[aq]:\[aq]\ and\ a\ path,\ eg\ "myremote:path/to/dir", -"myremote:bucket"\ or\ maybe\ "myremote:"\ (not\ recommended). - -\-\ Config:\ \ \ \ \ \ remote -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_REMOTE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-plex\-url - -The\ URL\ of\ the\ Plex\ server - -\-\ Config:\ \ \ \ \ \ plex_url -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_PLEX_URL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-plex\-username - -The\ username\ of\ the\ Plex\ user - -\-\ Config:\ \ \ \ \ \ plex_username -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_PLEX_USERNAME -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-plex\-password - -The\ password\ of\ the\ Plex\ user - -\-\ Config:\ \ \ \ \ \ plex_password -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_PLEX_PASSWORD -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-chunk\-size - -The\ size\ of\ a\ chunk\ (partial\ file\ data). - -Use\ lower\ numbers\ for\ slower\ connections.\ If\ the\ chunk\ size\ is -changed,\ any\ downloaded\ chunks\ will\ be\ invalid\ and\ cache\-chunk\-path -will\ need\ to\ be\ cleared\ or\ unexpected\ EOF\ errors\ will\ occur. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 5M -\-\ Examples: -\ \ \ \ \-\ "1m" -\ \ \ \ \ \ \ \ \-\ 1MB -\ \ \ \ \-\ "5M" -\ \ \ \ \ \ \ \ \-\ 5\ MB -\ \ \ \ \-\ "10M" -\ \ \ \ \ \ \ \ \-\ 10\ MB - -####\ \-\-cache\-info\-age - -How\ long\ to\ cache\ file\ structure\ information\ (directory\ listings,\ file\ size,\ times\ etc).\ -If\ all\ write\ operations\ are\ done\ through\ the\ cache\ then\ you\ can\ safely\ make -this\ value\ very\ large\ as\ the\ cache\ store\ will\ also\ be\ updated\ in\ real\ time. - -\-\ Config:\ \ \ \ \ \ info_age -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_INFO_AGE -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 6h0m0s -\-\ Examples: -\ \ \ \ \-\ "1h" -\ \ \ \ \ \ \ \ \-\ 1\ hour -\ \ \ \ \-\ "24h" -\ \ \ \ \ \ \ \ \-\ 24\ hours -\ \ \ \ \-\ "48h" -\ \ \ \ \ \ \ \ \-\ 48\ hours - -####\ \-\-cache\-chunk\-total\-size - -The\ total\ size\ that\ the\ chunks\ can\ take\ up\ on\ the\ local\ disk. - -If\ the\ cache\ exceeds\ this\ value\ then\ it\ will\ start\ to\ delete\ the -oldest\ chunks\ until\ it\ goes\ under\ this\ value. - -\-\ Config:\ \ \ \ \ \ chunk_total_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_CHUNK_TOTAL_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 10G -\-\ Examples: -\ \ \ \ \-\ "500M" -\ \ \ \ \ \ \ \ \-\ 500\ MB -\ \ \ \ \-\ "1G" -\ \ \ \ \ \ \ \ \-\ 1\ GB -\ \ \ \ \-\ "10G" -\ \ \ \ \ \ \ \ \-\ 10\ GB - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ cache\ (Cache\ a\ remote). - -####\ \-\-cache\-plex\-token - -The\ plex\ token\ for\ authentication\ \-\ auto\ set\ normally - -\-\ Config:\ \ \ \ \ \ plex_token -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_PLEX_TOKEN -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-plex\-insecure - -Skip\ all\ certificate\ verifications\ when\ connecting\ to\ the\ Plex\ server - -\-\ Config:\ \ \ \ \ \ plex_insecure -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_PLEX_INSECURE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-db\-path - -Directory\ to\ store\ file\ structure\ metadata\ DB. -The\ remote\ name\ is\ used\ as\ the\ DB\ file\ name. - -\-\ Config:\ \ \ \ \ \ db_path -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_DB_PATH -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "$HOME/.cache/rclone/cache\-backend" - -####\ \-\-cache\-chunk\-path - -Directory\ to\ cache\ chunk\ files. - -Path\ to\ where\ partial\ file\ data\ (chunks)\ are\ stored\ locally.\ The\ remote -name\ is\ appended\ to\ the\ final\ path. - -This\ config\ follows\ the\ "\-\-cache\-db\-path".\ If\ you\ specify\ a\ custom -location\ for\ "\-\-cache\-db\-path"\ and\ don\[aq]t\ specify\ one\ for\ "\-\-cache\-chunk\-path" -then\ "\-\-cache\-chunk\-path"\ will\ use\ the\ same\ path\ as\ "\-\-cache\-db\-path". - -\-\ Config:\ \ \ \ \ \ chunk_path -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_CHUNK_PATH -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "$HOME/.cache/rclone/cache\-backend" - -####\ \-\-cache\-db\-purge - -Clear\ all\ the\ cached\ data\ for\ this\ remote\ on\ start. - -\-\ Config:\ \ \ \ \ \ db_purge -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_DB_PURGE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-cache\-chunk\-clean\-interval - -How\ often\ should\ the\ cache\ perform\ cleanups\ of\ the\ chunk\ storage. -The\ default\ value\ should\ be\ ok\ for\ most\ people.\ If\ you\ find\ that\ the -cache\ goes\ over\ "cache\-chunk\-total\-size"\ too\ often\ then\ try\ to\ lower -this\ value\ to\ force\ it\ to\ perform\ cleanups\ more\ often. - -\-\ Config:\ \ \ \ \ \ chunk_clean_interval -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_CHUNK_CLEAN_INTERVAL -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 1m0s - -####\ \-\-cache\-read\-retries - -How\ many\ times\ to\ retry\ a\ read\ from\ a\ cache\ storage. - -Since\ reading\ from\ a\ cache\ stream\ is\ independent\ from\ downloading\ file -data,\ readers\ can\ get\ to\ a\ point\ where\ there\[aq]s\ no\ more\ data\ in\ the -cache.\ \ Most\ of\ the\ times\ this\ can\ indicate\ a\ connectivity\ issue\ if -cache\ isn\[aq]t\ able\ to\ provide\ file\ data\ anymore. - -For\ really\ slow\ connections,\ increase\ this\ to\ a\ point\ where\ the\ stream\ is -able\ to\ provide\ data\ but\ your\ experience\ will\ be\ very\ stuttering. - -\-\ Config:\ \ \ \ \ \ read_retries -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_READ_RETRIES -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 10 - -####\ \-\-cache\-workers - -How\ many\ workers\ should\ run\ in\ parallel\ to\ download\ chunks. - -Higher\ values\ will\ mean\ more\ parallel\ processing\ (better\ CPU\ needed) -and\ more\ concurrent\ requests\ on\ the\ cloud\ provider.\ \ This\ impacts -several\ aspects\ like\ the\ cloud\ provider\ API\ limits,\ more\ stress\ on\ the -hardware\ that\ rclone\ runs\ on\ but\ it\ also\ means\ that\ streams\ will\ be -more\ fluid\ and\ data\ will\ be\ available\ much\ more\ faster\ to\ readers. - -**Note**:\ If\ the\ optional\ Plex\ integration\ is\ enabled\ then\ this -setting\ will\ adapt\ to\ the\ type\ of\ reading\ performed\ and\ the\ value -specified\ here\ will\ be\ used\ as\ a\ maximum\ number\ of\ workers\ to\ use. - -\-\ Config:\ \ \ \ \ \ workers -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_WORKERS -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 4 - -####\ \-\-cache\-chunk\-no\-memory - -Disable\ the\ in\-memory\ cache\ for\ storing\ chunks\ during\ streaming. - -By\ default,\ cache\ will\ keep\ file\ data\ during\ streaming\ in\ RAM\ as\ well -to\ provide\ it\ to\ readers\ as\ fast\ as\ possible. - -This\ transient\ data\ is\ evicted\ as\ soon\ as\ it\ is\ read\ and\ the\ number\ of -chunks\ stored\ doesn\[aq]t\ exceed\ the\ number\ of\ workers.\ However,\ depending -on\ other\ settings\ like\ "cache\-chunk\-size"\ and\ "cache\-workers"\ this\ footprint -can\ increase\ if\ there\ are\ parallel\ streams\ too\ (multiple\ files\ being\ read -at\ the\ same\ time). - -If\ the\ hardware\ permits\ it,\ use\ this\ feature\ to\ provide\ an\ overall\ better -performance\ during\ streaming\ but\ it\ can\ also\ be\ disabled\ if\ RAM\ is\ not -available\ on\ the\ local\ machine. - -\-\ Config:\ \ \ \ \ \ chunk_no_memory -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_CHUNK_NO_MEMORY -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-cache\-rps - -Limits\ the\ number\ of\ requests\ per\ second\ to\ the\ source\ FS\ (\-1\ to\ disable) - -This\ setting\ places\ a\ hard\ limit\ on\ the\ number\ of\ requests\ per\ second -that\ cache\ will\ be\ doing\ to\ the\ cloud\ provider\ remote\ and\ try\ to -respect\ that\ value\ by\ setting\ waits\ between\ reads. - -If\ you\ find\ that\ you\[aq]re\ getting\ banned\ or\ limited\ on\ the\ cloud -provider\ through\ cache\ and\ know\ that\ a\ smaller\ number\ of\ requests\ per -second\ will\ allow\ you\ to\ work\ with\ it\ then\ you\ can\ use\ this\ setting -for\ that. - -A\ good\ balance\ of\ all\ the\ other\ settings\ should\ make\ this\ setting -useless\ but\ it\ is\ available\ to\ set\ for\ more\ special\ cases. - -**NOTE**:\ This\ will\ limit\ the\ number\ of\ requests\ during\ streams\ but -other\ API\ calls\ to\ the\ cloud\ provider\ like\ directory\ listings\ will -still\ pass. - -\-\ Config:\ \ \ \ \ \ rps -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_RPS -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ \-1 - -####\ \-\-cache\-writes - -Cache\ file\ data\ on\ writes\ through\ the\ FS - -If\ you\ need\ to\ read\ files\ immediately\ after\ you\ upload\ them\ through -cache\ you\ can\ enable\ this\ flag\ to\ have\ their\ data\ stored\ in\ the -cache\ store\ at\ the\ same\ time\ during\ upload. - -\-\ Config:\ \ \ \ \ \ writes -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_WRITES -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-cache\-tmp\-upload\-path - -Directory\ to\ keep\ temporary\ files\ until\ they\ are\ uploaded. - -This\ is\ the\ path\ where\ cache\ will\ use\ as\ a\ temporary\ storage\ for\ new -files\ that\ need\ to\ be\ uploaded\ to\ the\ cloud\ provider. - -Specifying\ a\ value\ will\ enable\ this\ feature.\ Without\ it,\ it\ is -completely\ disabled\ and\ files\ will\ be\ uploaded\ directly\ to\ the\ cloud -provider - -\-\ Config:\ \ \ \ \ \ tmp_upload_path -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_TMP_UPLOAD_PATH -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-cache\-tmp\-wait\-time - -How\ long\ should\ files\ be\ stored\ in\ local\ cache\ before\ being\ uploaded - -This\ is\ the\ duration\ that\ a\ file\ must\ wait\ in\ the\ temporary\ location -_cache\-tmp\-upload\-path_\ before\ it\ is\ selected\ for\ upload. - -Note\ that\ only\ one\ file\ is\ uploaded\ at\ a\ time\ and\ it\ can\ take\ longer -to\ start\ the\ upload\ if\ a\ queue\ formed\ for\ this\ purpose. - -\-\ Config:\ \ \ \ \ \ tmp_wait_time -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_TMP_WAIT_TIME -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 15s - -####\ \-\-cache\-db\-wait\-time - -How\ long\ to\ wait\ for\ the\ DB\ to\ be\ available\ \-\ 0\ is\ unlimited - -Only\ one\ process\ can\ have\ the\ DB\ open\ at\ any\ one\ time,\ so\ rclone\ waits -for\ this\ duration\ for\ the\ DB\ to\ become\ available\ before\ it\ gives\ an -error. - -If\ you\ set\ it\ to\ 0\ then\ it\ will\ wait\ forever. - -\-\ Config:\ \ \ \ \ \ db_wait_time -\-\ Env\ Var:\ \ \ \ \ RCLONE_CACHE_DB_WAIT_TIME -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 1s - - - -Chunker\ (BETA) -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ `chunker`\ overlay\ transparently\ splits\ large\ files\ into\ smaller\ chunks -during\ upload\ to\ wrapped\ remote\ and\ transparently\ assembles\ them\ back -when\ the\ file\ is\ downloaded.\ This\ allows\ to\ effectively\ overcome\ size\ limits -imposed\ by\ storage\ providers. - -To\ use\ it,\ first\ set\ up\ the\ underlying\ remote\ following\ the\ configuration -instructions\ for\ that\ remote.\ You\ can\ also\ use\ a\ local\ pathname\ instead\ of -a\ remote. - -First\ check\ your\ chosen\ remote\ is\ working\ \-\ we\[aq]ll\ call\ it\ `remote:path`\ here. -Note\ that\ anything\ inside\ `remote:path`\ will\ be\ chunked\ and\ anything\ outside -won\[aq]t.\ This\ means\ that\ if\ you\ are\ using\ a\ bucket\ based\ remote\ (eg\ S3,\ B2,\ swift) -then\ you\ should\ probably\ put\ the\ bucket\ in\ the\ remote\ `s3:bucket`. - -Now\ configure\ `chunker`\ using\ `rclone\ config`.\ We\ will\ call\ this\ one\ `overlay` -to\ separate\ it\ from\ the\ `remote`\ itself. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> overlay Type of storage to -configure. -Choose a number from below, or type in your own value [snip] XX / -Transparently chunk/split large files \ \[lq]chunker\[rq] [snip] -Storage> chunker Remote to chunk/unchunk. -Normally should contain a `:' and a path, eg -\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe -\[lq]myremote:\[rq] (not recommended). -Enter a string value. -Press Enter for the default ("\[lq]). remote> remote:path Files larger -than chunk size will be split in chunks. Enter a size with suffix -k,M,G,T. Press Enter for the default (\[rq]2G\[lq]). chunk_size> 100M -Choose how chunker handles hash sums. All modes but\[rq]none" require -metadata. -Enter a string value. -Press Enter for the default (\[lq]md5\[rq]). -Choose a number from below, or type in your own value 1 / Pass any hash -supported by wrapped remote for non\-chunked files, return nothing -otherwise \ \[lq]none\[rq] 2 / MD5 for composite files \ \[lq]md5\[rq] 3 -/ SHA1 for composite files \ \[lq]sha1\[rq] 4 / MD5 for all files -\ \[lq]md5all\[rq] 5 / SHA1 for all files \ \[lq]sha1all\[rq] 6 / -Copying a file to chunker will request MD5 from the source falling back -to SHA1 if unsupported \ \[lq]md5quick\[rq] 7 / Similar to -\[lq]md5quick\[rq] but prefers SHA1 over MD5 \ \[lq]sha1quick\[rq] -hash_type> md5 Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [overlay] type = chunker remote = -remote:bucket chunk_size = 100M hash_type = md5 -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -###\ Specifying\ the\ remote - -In\ normal\ use,\ make\ sure\ the\ remote\ has\ a\ `:`\ in.\ If\ you\ specify\ the\ remote -without\ a\ `:`\ then\ rclone\ will\ use\ a\ local\ directory\ of\ that\ name. -So\ if\ you\ use\ a\ remote\ of\ `/path/to/secret/files`\ then\ rclone\ will -chunk\ stuff\ in\ that\ directory.\ If\ you\ use\ a\ remote\ of\ `name`\ then\ rclone -will\ put\ files\ in\ a\ directory\ called\ `name`\ in\ the\ current\ directory. - - -###\ Chunking - -When\ rclone\ starts\ a\ file\ upload,\ chunker\ checks\ the\ file\ size.\ If\ it -doesn\[aq]t\ exceed\ the\ configured\ chunk\ size,\ chunker\ will\ just\ pass\ the\ file -to\ the\ wrapped\ remote.\ If\ a\ file\ is\ large,\ chunker\ will\ transparently\ cut -data\ in\ pieces\ with\ temporary\ names\ and\ stream\ them\ one\ by\ one,\ on\ the\ fly. -Each\ data\ chunk\ will\ contain\ the\ specified\ number\ of\ bytes,\ except\ for\ the -last\ one\ which\ may\ have\ less\ data.\ If\ file\ size\ is\ unknown\ in\ advance -(this\ is\ called\ a\ streaming\ upload),\ chunker\ will\ internally\ create -a\ temporary\ copy,\ record\ its\ size\ and\ repeat\ the\ above\ process. - -When\ upload\ completes,\ temporary\ chunk\ files\ are\ finally\ renamed. -This\ scheme\ guarantees\ that\ operations\ can\ be\ run\ in\ parallel\ and\ look -from\ outside\ as\ atomic. -A\ similar\ method\ with\ hidden\ temporary\ chunks\ is\ used\ for\ other\ operations -(copy/move/rename\ etc).\ If\ an\ operation\ fails,\ hidden\ chunks\ are\ normally -destroyed,\ and\ the\ target\ composite\ file\ stays\ intact. - -When\ a\ composite\ file\ download\ is\ requested,\ chunker\ transparently -assembles\ it\ by\ concatenating\ data\ chunks\ in\ order.\ As\ the\ split\ is\ trivial -one\ could\ even\ manually\ concatenate\ data\ chunks\ together\ to\ obtain\ the -original\ content. - -When\ the\ `list`\ rclone\ command\ scans\ a\ directory\ on\ wrapped\ remote, -the\ potential\ chunk\ files\ are\ accounted\ for,\ grouped\ and\ assembled\ into -composite\ directory\ entries.\ Any\ temporary\ chunks\ are\ hidden. - -List\ and\ other\ commands\ can\ sometimes\ come\ across\ composite\ files\ with -missing\ or\ invalid\ chunks,\ eg.\ shadowed\ by\ like\-named\ directory\ or -another\ file.\ This\ usually\ means\ that\ wrapped\ file\ system\ has\ been\ directly -tampered\ with\ or\ damaged.\ If\ chunker\ detects\ a\ missing\ chunk\ it\ will -by\ default\ print\ warning,\ skip\ the\ whole\ incomplete\ group\ of\ chunks\ but -proceed\ with\ current\ command. -You\ can\ set\ the\ `\-\-chunker\-fail\-hard`\ flag\ to\ have\ commands\ abort\ with -error\ message\ in\ such\ cases. - - -####\ Chunk\ names - -The\ default\ chunk\ name\ format\ is\ `*.rclone\-chunk.###`,\ hence\ by\ default -chunk\ names\ are\ `BIG_FILE_NAME.rclone\-chunk.001`, -`BIG_FILE_NAME.rclone\-chunk.002`\ etc.\ You\ can\ configure\ a\ different\ name -format\ using\ the\ `\-\-chunker\-name\-format`\ option.\ The\ format\ uses\ asterisk -`*`\ as\ a\ placeholder\ for\ the\ base\ file\ name\ and\ one\ or\ more\ consecutive -hash\ characters\ `#`\ as\ a\ placeholder\ for\ sequential\ chunk\ number. -There\ must\ be\ one\ and\ only\ one\ asterisk.\ The\ number\ of\ consecutive\ hash -characters\ defines\ the\ minimum\ length\ of\ a\ string\ representing\ a\ chunk\ number. -If\ decimal\ chunk\ number\ has\ less\ digits\ than\ the\ number\ of\ hashes,\ it\ is -left\-padded\ by\ zeros.\ If\ the\ decimal\ string\ is\ longer,\ it\ is\ left\ intact. -By\ default\ numbering\ starts\ from\ 1\ but\ there\ is\ another\ option\ that\ allows -user\ to\ start\ from\ 0,\ eg.\ for\ compatibility\ with\ legacy\ software. - -For\ example,\ if\ name\ format\ is\ `big_*\-##.part`\ and\ original\ file\ name\ is -`data.txt`\ and\ numbering\ starts\ from\ 0,\ then\ the\ first\ chunk\ will\ be\ named -`big_data.txt\-00.part`,\ the\ 99th\ chunk\ will\ be\ `big_data.txt\-98.part` -and\ the\ 302nd\ chunk\ will\ become\ `big_data.txt\-301.part`. - -Note\ that\ `list`\ assembles\ composite\ directory\ entries\ only\ when\ chunk\ names -match\ the\ configured\ format\ and\ treats\ non\-conforming\ file\ names\ as\ normal -non\-chunked\ files. - - -###\ Metadata - -Besides\ data\ chunks\ chunker\ will\ by\ default\ create\ metadata\ object\ for -a\ composite\ file.\ The\ object\ is\ named\ after\ the\ original\ file. -Chunker\ allows\ user\ to\ disable\ metadata\ completely\ (the\ `none`\ format). -Note\ that\ metadata\ is\ normally\ not\ created\ for\ files\ smaller\ than\ the -configured\ chunk\ size.\ This\ may\ change\ in\ future\ rclone\ releases. - -####\ Simple\ JSON\ metadata\ format - -This\ is\ the\ default\ format.\ It\ supports\ hash\ sums\ and\ chunk\ validation -for\ composite\ files.\ Meta\ objects\ carry\ the\ following\ fields: - -\-\ `ver`\ \ \ \ \ \-\ version\ of\ format,\ currently\ `1` -\-\ `size`\ \ \ \ \-\ total\ size\ of\ composite\ file -\-\ `nchunks`\ \-\ number\ of\ data\ chunks\ in\ file -\-\ `md5`\ \ \ \ \ \-\ MD5\ hashsum\ of\ composite\ file\ (if\ present) -\-\ `sha1`\ \ \ \ \-\ SHA1\ hashsum\ (if\ present) - -There\ is\ no\ field\ for\ composite\ file\ name\ as\ it\[aq]s\ simply\ equal\ to\ the\ name -of\ meta\ object\ on\ the\ wrapped\ remote.\ Please\ refer\ to\ respective\ sections -for\ details\ on\ hashsums\ and\ modified\ time\ handling. - -####\ No\ metadata - -You\ can\ disable\ meta\ objects\ by\ setting\ the\ meta\ format\ option\ to\ `none`. -In\ this\ mode\ chunker\ will\ scan\ directory\ for\ all\ files\ that\ follow -configured\ chunk\ name\ format,\ group\ them\ by\ detecting\ chunks\ with\ the\ same -base\ name\ and\ show\ group\ names\ as\ virtual\ composite\ files. -This\ method\ is\ more\ prone\ to\ missing\ chunk\ errors\ (especially\ missing -last\ chunk)\ than\ format\ with\ metadata\ enabled. - - -###\ Hashsums - -Chunker\ supports\ hashsums\ only\ when\ a\ compatible\ metadata\ is\ present. -Hence,\ if\ you\ choose\ metadata\ format\ of\ `none`,\ chunker\ will\ report\ hashsum -as\ `UNSUPPORTED`. - -Please\ note\ that\ by\ default\ metadata\ is\ stored\ only\ for\ composite\ files. -If\ a\ file\ is\ smaller\ than\ configured\ chunk\ size,\ chunker\ will\ transparently -redirect\ hash\ requests\ to\ wrapped\ remote,\ so\ support\ depends\ on\ that. -You\ will\ see\ the\ empty\ string\ as\ a\ hashsum\ of\ requested\ type\ for\ small -files\ if\ the\ wrapped\ remote\ doesn\[aq]t\ support\ it. - -Many\ storage\ backends\ support\ MD5\ and\ SHA1\ hash\ types,\ so\ does\ chunker. -With\ chunker\ you\ can\ choose\ one\ or\ another\ but\ not\ both. -MD5\ is\ set\ by\ default\ as\ the\ most\ supported\ type. -Since\ chunker\ keeps\ hashes\ for\ composite\ files\ and\ falls\ back\ to\ the -wrapped\ remote\ hash\ for\ non\-chunked\ ones,\ we\ advise\ you\ to\ choose\ the\ same -hash\ type\ as\ supported\ by\ wrapped\ remote\ so\ that\ your\ file\ listings -look\ coherent. - -If\ your\ storage\ backend\ does\ not\ support\ MD5\ or\ SHA1\ but\ you\ need\ consistent -file\ hashing,\ configure\ chunker\ with\ `md5all`\ or\ `sha1all`.\ These\ two\ modes -guarantee\ given\ hash\ for\ all\ files.\ If\ wrapped\ remote\ doesn\[aq]t\ support\ it, -chunker\ will\ then\ add\ metadata\ to\ all\ files,\ even\ small.\ However,\ this\ can -double\ the\ amount\ of\ small\ files\ in\ storage\ and\ incur\ additional\ service\ charges. - -Normally,\ when\ a\ file\ is\ copied\ to\ chunker\ controlled\ remote,\ chunker -will\ ask\ the\ file\ source\ for\ compatible\ file\ hash\ and\ revert\ to\ on\-the\-fly -calculation\ if\ none\ is\ found.\ This\ involves\ some\ CPU\ overhead\ but\ provides -a\ guarantee\ that\ given\ hashsum\ is\ available.\ Also,\ chunker\ will\ reject -a\ server\-side\ copy\ or\ move\ operation\ if\ source\ and\ destination\ hashsum -types\ are\ different\ resulting\ in\ the\ extra\ network\ bandwidth,\ too. -In\ some\ rare\ cases\ this\ may\ be\ undesired,\ so\ chunker\ provides\ two\ optional -choices:\ `sha1quick`\ and\ `md5quick`.\ If\ the\ source\ does\ not\ support\ primary -hash\ type\ and\ the\ quick\ mode\ is\ enabled,\ chunker\ will\ try\ to\ fall\ back\ to -the\ secondary\ type.\ This\ will\ save\ CPU\ and\ bandwidth\ but\ can\ result\ in\ empty -hashsums\ at\ destination.\ Beware\ of\ consequences:\ the\ `sync`\ command\ will -revert\ (sometimes\ silently)\ to\ time/size\ comparison\ if\ compatible\ hashsums -between\ source\ and\ target\ are\ not\ found. - - -###\ Modified\ time - -Chunker\ stores\ modification\ times\ using\ the\ wrapped\ remote\ so\ support -depends\ on\ that.\ For\ a\ small\ non\-chunked\ file\ the\ chunker\ overlay\ simply -manipulates\ modification\ time\ of\ the\ wrapped\ remote\ file. -For\ a\ composite\ file\ with\ metadata\ chunker\ will\ get\ and\ set -modification\ time\ of\ the\ metadata\ object\ on\ the\ wrapped\ remote. -If\ file\ is\ chunked\ but\ metadata\ format\ is\ `none`\ then\ chunker\ will -use\ modification\ time\ of\ the\ first\ data\ chunk. - - -###\ Migrations - -The\ idiomatic\ way\ to\ migrate\ to\ a\ different\ chunk\ size,\ hash\ type\ or -chunk\ naming\ scheme\ is\ to: - -\-\ Collect\ all\ your\ chunked\ files\ under\ a\ directory\ and\ have\ your -\ \ chunker\ remote\ point\ to\ it. -\-\ Create\ another\ directory\ (most\ probably\ on\ the\ same\ cloud\ storage) -\ \ and\ configure\ a\ new\ remote\ with\ desired\ metadata\ format, -\ \ hash\ type,\ chunk\ naming\ etc. -\-\ Now\ run\ `rclone\ sync\ oldchunks:\ newchunks:`\ and\ all\ your\ data -\ \ will\ be\ transparently\ converted\ in\ transfer. -\ \ This\ may\ take\ some\ time,\ yet\ chunker\ will\ try\ server\-side -\ \ copy\ if\ possible. -\-\ After\ checking\ data\ integrity\ you\ may\ remove\ configuration\ section -\ \ of\ the\ old\ remote. - -If\ rclone\ gets\ killed\ during\ a\ long\ operation\ on\ a\ big\ composite\ file, -hidden\ temporary\ chunks\ may\ stay\ in\ the\ directory.\ They\ will\ not\ be -shown\ by\ the\ `list`\ command\ but\ will\ eat\ up\ your\ account\ quota. -Please\ note\ that\ the\ `deletefile`\ command\ deletes\ only\ active -chunks\ of\ a\ file.\ As\ a\ workaround,\ you\ can\ use\ remote\ of\ the\ wrapped -file\ system\ to\ see\ them. -An\ easy\ way\ to\ get\ rid\ of\ hidden\ garbage\ is\ to\ copy\ littered\ directory -somewhere\ using\ the\ chunker\ remote\ and\ purge\ the\ original\ directory. -The\ `copy`\ command\ will\ copy\ only\ active\ chunks\ while\ the\ `purge`\ will -remove\ everything\ including\ garbage. - - -###\ Caveats\ and\ Limitations - -Chunker\ requires\ wrapped\ remote\ to\ support\ server\ side\ `move`\ (or\ `copy`\ + -`delete`)\ operations,\ otherwise\ it\ will\ explicitly\ refuse\ to\ start. -This\ is\ because\ it\ internally\ renames\ temporary\ chunk\ files\ to\ their\ final -names\ when\ an\ operation\ completes\ successfully. - -Note\ that\ a\ move\ implemented\ using\ the\ copy\-and\-delete\ method\ may\ incur -double\ charging\ with\ some\ cloud\ storage\ providers. - -Chunker\ will\ not\ automatically\ rename\ existing\ chunks\ when\ you\ run -`rclone\ config`\ on\ a\ live\ remote\ and\ change\ the\ chunk\ name\ format. -Beware\ that\ in\ result\ of\ this\ some\ files\ which\ have\ been\ treated\ as\ chunks -before\ the\ change\ can\ pop\ up\ in\ directory\ listings\ as\ normal\ files -and\ vice\ versa.\ The\ same\ warning\ holds\ for\ the\ chunk\ size. -If\ you\ desperately\ need\ to\ change\ critical\ chunking\ setings,\ you\ should -run\ data\ migration\ as\ described\ above. - -If\ wrapped\ remote\ is\ case\ insensitive,\ the\ chunker\ overlay\ will\ inherit -that\ property\ (so\ you\ can\[aq]t\ have\ a\ file\ called\ "Hello.doc"\ and\ "hello.doc" -in\ the\ same\ directory). - - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ chunker\ (Transparently\ chunk/split\ large\ files). - -####\ \-\-chunker\-remote - -Remote\ to\ chunk/unchunk. -Normally\ should\ contain\ a\ \[aq]:\[aq]\ and\ a\ path,\ eg\ "myremote:path/to/dir", -"myremote:bucket"\ or\ maybe\ "myremote:"\ (not\ recommended). - -\-\ Config:\ \ \ \ \ \ remote -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_REMOTE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-chunker\-chunk\-size - -Files\ larger\ than\ chunk\ size\ will\ be\ split\ in\ chunks. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 2G - -####\ \-\-chunker\-hash\-type - -Choose\ how\ chunker\ handles\ hash\ sums.\ All\ modes\ but\ "none"\ require\ metadata. - -\-\ Config:\ \ \ \ \ \ hash_type -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_HASH_TYPE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "md5" -\-\ Examples: -\ \ \ \ \-\ "none" -\ \ \ \ \ \ \ \ \-\ Pass\ any\ hash\ supported\ by\ wrapped\ remote\ for\ non\-chunked\ files,\ return\ nothing\ otherwise -\ \ \ \ \-\ "md5" -\ \ \ \ \ \ \ \ \-\ MD5\ for\ composite\ files -\ \ \ \ \-\ "sha1" -\ \ \ \ \ \ \ \ \-\ SHA1\ for\ composite\ files -\ \ \ \ \-\ "md5all" -\ \ \ \ \ \ \ \ \-\ MD5\ for\ all\ files -\ \ \ \ \-\ "sha1all" -\ \ \ \ \ \ \ \ \-\ SHA1\ for\ all\ files -\ \ \ \ \-\ "md5quick" -\ \ \ \ \ \ \ \ \-\ Copying\ a\ file\ to\ chunker\ will\ request\ MD5\ from\ the\ source\ falling\ back\ to\ SHA1\ if\ unsupported -\ \ \ \ \-\ "sha1quick" -\ \ \ \ \ \ \ \ \-\ Similar\ to\ "md5quick"\ but\ prefers\ SHA1\ over\ MD5 - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ chunker\ (Transparently\ chunk/split\ large\ files). - -####\ \-\-chunker\-name\-format - -String\ format\ of\ chunk\ file\ names. -The\ two\ placeholders\ are:\ base\ file\ name\ (*)\ and\ chunk\ number\ (#...). -There\ must\ be\ one\ and\ only\ one\ asterisk\ and\ one\ or\ more\ consecutive\ hash\ characters. -If\ chunk\ number\ has\ less\ digits\ than\ the\ number\ of\ hashes,\ it\ is\ left\-padded\ by\ zeros. -If\ there\ are\ more\ digits\ in\ the\ number,\ they\ are\ left\ as\ is. -Possible\ chunk\ files\ are\ ignored\ if\ their\ name\ does\ not\ match\ given\ format. - -\-\ Config:\ \ \ \ \ \ name_format -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_NAME_FORMAT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "*.rclone_chunk.###" - -####\ \-\-chunker\-start\-from - -Minimum\ valid\ chunk\ number.\ Usually\ 0\ or\ 1. -By\ default\ chunk\ numbers\ start\ from\ 1. - -\-\ Config:\ \ \ \ \ \ start_from -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_START_FROM -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 1 - -####\ \-\-chunker\-meta\-format - -Format\ of\ the\ metadata\ object\ or\ "none".\ By\ default\ "simplejson". -Metadata\ is\ a\ small\ JSON\ file\ named\ after\ the\ composite\ file. - -\-\ Config:\ \ \ \ \ \ meta_format -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_META_FORMAT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "simplejson" -\-\ Examples: -\ \ \ \ \-\ "none" -\ \ \ \ \ \ \ \ \-\ Do\ not\ use\ metadata\ files\ at\ all.\ Requires\ hash\ type\ "none". -\ \ \ \ \-\ "simplejson" -\ \ \ \ \ \ \ \ \-\ Simple\ JSON\ supports\ hash\ sums\ and\ chunk\ validation. -\ \ \ \ \ \ \ \ \-\ It\ has\ the\ following\ fields:\ ver,\ size,\ nchunks,\ md5,\ sha1. - -####\ \-\-chunker\-fail\-hard - -Choose\ how\ chunker\ should\ handle\ files\ with\ missing\ or\ invalid\ chunks. - -\-\ Config:\ \ \ \ \ \ fail_hard -\-\ Env\ Var:\ \ \ \ \ RCLONE_CHUNKER_FAIL_HARD -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false -\-\ Examples: -\ \ \ \ \-\ "true" -\ \ \ \ \ \ \ \ \-\ Report\ errors\ and\ abort\ current\ command. -\ \ \ \ \-\ "false" -\ \ \ \ \ \ \ \ \-\ Warn\ user,\ skip\ incomplete\ file\ and\ proceed. - - - -##\ Citrix\ ShareFile - -[Citrix\ ShareFile](https://sharefile.com)\ is\ a\ secure\ file\ sharing\ and\ transfer\ service\ aimed\ as\ business. - -The\ initial\ setup\ for\ Citrix\ ShareFile\ involves\ getting\ a\ token\ from -Citrix\ ShareFile\ which\ you\ can\ in\ your\ browser.\ \ `rclone\ config`\ walks\ you -through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value XX / Citrix Sharefile \ \[rq]sharefile" Storage> -sharefile ** See help for sharefile backend at: -https://rclone.org/sharefile/ ** -.PP -ID of the root folder -.PP -Leave blank to access \[lq]Personal Folders\[rq]. -You can use one of the standard values here or any folder ID (long hex -number ID). -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value 1 / Access the Personal Folders. (Default) -\ \[rq]" 2 / Access the Favorites folder. -\ \[lq]favorites\[rq] 3 / Access all the shared folders. -\ \[lq]allshared\[rq] 4 / Access all the individual connectors. -\ \[lq]connectors\[rq] 5 / Access the home, favorites, and shared -folders as well as the connectors. -\ \[lq]top\[rq] root_folder_id> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn't open automatically -go to the following link: http://127.0.0.1:53682/auth?state=XXX Log in -and authorize rclone for access Waiting for code\&... Got code -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = sharefile endpoint = -https://XXX.sharefile.com token = -{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2019\-09\-30T19:41:45.878561877+01:00\[rq]} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -See\ the\ [remote\ setup\ docs](https://rclone.org/remote_setup/)\ for\ how\ to\ set\ it\ up\ on\ a -machine\ with\ no\ Internet\ browser\ available. - -Note\ that\ rclone\ runs\ a\ webserver\ on\ your\ local\ machine\ to\ collect\ the -token\ as\ returned\ from\ Citrix\ ShareFile.\ This\ only\ runs\ from\ the\ moment\ it\ opens -your\ browser\ to\ the\ moment\ you\ get\ back\ the\ verification\ code.\ \ This -is\ on\ `http://127.0.0.1:53682/`\ and\ this\ it\ may\ require\ you\ to\ unblock -it\ temporarily\ if\ you\ are\ running\ a\ host\ firewall. - -Once\ configured\ you\ can\ then\ use\ `rclone`\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ ShareFile - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ ShareFile - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ an\ ShareFile\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -Paths\ may\ be\ as\ deep\ as\ required,\ eg\ `remote:directory/subdirectory`. - -###\ Modified\ time\ and\ hashes\ ### - -ShareFile\ allows\ modification\ times\ to\ be\ set\ on\ objects\ accurate\ to\ 1 -second.\ \ These\ will\ be\ used\ to\ detect\ whether\ objects\ need\ syncing\ or -not. - -ShareFile\ supports\ MD5\ type\ hashes,\ so\ you\ can\ use\ the\ `\-\-checksum` -flag. - -###\ Transfers\ ### - -For\ files\ above\ 128MB\ rclone\ will\ use\ a\ chunked\ transfer.\ \ Rclone\ will -upload\ up\ to\ `\-\-transfers`\ chunks\ at\ the\ same\ time\ (shared\ among\ all -the\ multipart\ uploads).\ \ Chunks\ are\ buffered\ in\ memory\ and\ are -normally\ 64MB\ so\ increasing\ `\-\-transfers`\ will\ increase\ memory\ use. - -###\ Limitations\ ### - -Note\ that\ ShareFile\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a\ file\ called -"Hello.doc"\ and\ one\ called\ "hello.doc". - -ShareFile\ only\ supports\ filenames\ up\ to\ 256\ characters\ in\ length. - -####\ Restricted\ filename\ characters - -In\ addition\ to\ the\ [default\ restricted\ characters\ set](/overview/#restricted\-characters) -the\ following\ characters\ are\ also\ replaced: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ \\\\\ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | -|\ *\ \ \ \ \ \ \ \ \ |\ 0x2A\ \ |\ ＊\ \ \ \ \ \ \ \ \ \ \ | -|\ <\ \ \ \ \ \ \ \ \ |\ 0x3C\ \ |\ ＜\ \ \ \ \ \ \ \ \ \ \ | -|\ >\ \ \ \ \ \ \ \ \ |\ 0x3E\ \ |\ ＞\ \ \ \ \ \ \ \ \ \ \ | -|\ ?\ \ \ \ \ \ \ \ \ |\ 0x3F\ \ |\ ？\ \ \ \ \ \ \ \ \ \ \ | -|\ :\ \ \ \ \ \ \ \ \ |\ 0x3A\ \ |\ ：\ \ \ \ \ \ \ \ \ \ \ | -|\ \\|\ \ \ \ \ \ \ \ |\ 0x7C\ \ |\ ｜\ \ \ \ \ \ \ \ \ \ \ | -|\ "\ \ \ \ \ \ \ \ \ |\ 0x22\ \ |\ ＂\ \ \ \ \ \ \ \ \ \ \ | - -File\ names\ can\ also\ not\ start\ or\ end\ with\ the\ following\ characters. -These\ only\ get\ replaced\ if\ they\ are\ first\ or\ last\ character\ in\ the -name: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | -|\ .\ \ \ \ \ \ \ \ \ |\ 0x2E\ \ |\ ．\ \ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ sharefile\ (Citrix\ Sharefile). - -####\ \-\-sharefile\-root\-folder\-id - -ID\ of\ the\ root\ folder - -Leave\ blank\ to\ access\ "Personal\ Folders".\ \ You\ can\ use\ one\ of\ the -standard\ values\ here\ or\ any\ folder\ ID\ (long\ hex\ number\ ID). - -\-\ Config:\ \ \ \ \ \ root_folder_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_SHAREFILE_ROOT_FOLDER_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Access\ the\ Personal\ Folders.\ (Default) -\ \ \ \ \-\ "favorites" -\ \ \ \ \ \ \ \ \-\ Access\ the\ Favorites\ folder. -\ \ \ \ \-\ "allshared" -\ \ \ \ \ \ \ \ \-\ Access\ all\ the\ shared\ folders. -\ \ \ \ \-\ "connectors" -\ \ \ \ \ \ \ \ \-\ Access\ all\ the\ individual\ connectors. -\ \ \ \ \-\ "top" -\ \ \ \ \ \ \ \ \-\ Access\ the\ home,\ favorites,\ and\ shared\ folders\ as\ well\ as\ the\ connectors. - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ sharefile\ (Citrix\ Sharefile). - -####\ \-\-sharefile\-upload\-cutoff - -Cutoff\ for\ switching\ to\ multipart\ upload. - -\-\ Config:\ \ \ \ \ \ upload_cutoff -\-\ Env\ Var:\ \ \ \ \ RCLONE_SHAREFILE_UPLOAD_CUTOFF -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 128M - -####\ \-\-sharefile\-chunk\-size - -Upload\ chunk\ size.\ Must\ a\ power\ of\ 2\ >=\ 256k. - -Making\ this\ larger\ will\ improve\ performance,\ but\ note\ that\ each\ chunk -is\ buffered\ in\ memory\ one\ per\ transfer. - -Reducing\ this\ will\ reduce\ memory\ usage\ but\ decrease\ performance. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_SHAREFILE_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 64M - -####\ \-\-sharefile\-endpoint - -Endpoint\ for\ API\ calls. - -This\ is\ usually\ auto\ discovered\ as\ part\ of\ the\ oauth\ process,\ but\ can -be\ set\ manually\ to\ something\ like:\ https://XXX.sharefile.com - - -\-\ Config:\ \ \ \ \ \ endpoint -\-\ Env\ Var:\ \ \ \ \ RCLONE_SHAREFILE_ENDPOINT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - - - -Crypt -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ `crypt`\ remote\ encrypts\ and\ decrypts\ another\ remote. - -To\ use\ it\ first\ set\ up\ the\ underlying\ remote\ following\ the\ config -instructions\ for\ that\ remote.\ \ You\ can\ also\ use\ a\ local\ pathname -instead\ of\ a\ remote\ which\ will\ encrypt\ and\ decrypt\ from\ that\ directory -which\ might\ be\ useful\ for\ encrypting\ onto\ a\ USB\ stick\ for\ example. - -First\ check\ your\ chosen\ remote\ is\ working\ \-\ we\[aq]ll\ call\ it -`remote:path`\ in\ these\ docs.\ \ Note\ that\ anything\ inside\ `remote:path` -will\ be\ encrypted\ and\ anything\ outside\ won\[aq]t.\ \ This\ means\ that\ if\ you -are\ using\ a\ bucket\ based\ remote\ (eg\ S3,\ B2,\ swift)\ then\ you\ should -probably\ put\ the\ bucket\ in\ the\ remote\ `s3:bucket`.\ If\ you\ just\ use -`s3:`\ then\ rclone\ will\ make\ encrypted\ bucket\ names\ too\ (if\ using\ file -name\ encryption)\ which\ may\ or\ may\ not\ be\ what\ you\ want. - -Now\ configure\ `crypt`\ using\ `rclone\ config`.\ We\ will\ call\ this\ one -`secret`\ to\ differentiate\ it\ from\ the\ `remote`. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n -.PD 0 -.P -.PD -name> secret Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Encrypt/Decrypt a remote \ \[lq]crypt\[rq] [snip] Storage> crypt Remote -to encrypt/decrypt. -Normally should contain a `:' and a path, eg -\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe -\[lq]myremote:\[rq] (not recommended). -remote> remote:path How to encrypt the filenames. -Choose a number from below, or type in your own value 1 / Don't encrypt -the file names. -Adds a \[lq].bin\[rq] extension only. -\ \[lq]off\[rq] 2 / Encrypt the filenames see the docs for the details. -\ \[lq]standard\[rq] 3 / Very simple filename obfuscation. -\ \[lq]obfuscate\[rq] filename_encryption> 2 Option to either encrypt -directory names or leave them intact. -Choose a number from below, or type in your own value 1 / Encrypt -directory names. -\ \[lq]true\[rq] 2 / Don't encrypt directory names, leave them intact. -\ \[lq]false\[rq] filename_encryption> 1 Password or pass phrase for -encryption. -y) Yes type in my own password g) Generate random password y/g> y Enter -the password: password: Confirm the password: password: Password or pass -phrase for salt. -Optional but recommended. -Should be different to the previous password. -y) Yes type in my own password g) Generate random password n) No leave -this optional password blank y/g/n> g Password strength in bits. -64 is just about memorable 128 is secure 1024 is the maximum Bits> 128 -Your password is: JAsJvRcgR\-_veXNfy_sGmQ Use this password? -y) Yes n) No y/n> y Remote config \[em]\[em]\[em]\[em]\[em]\[em]\[en] -[secret] remote = remote:path filename_encryption = standard password = -*** ENCRYPTED \f[B]\f[BI] password2 = \f[B]\f[] ENCRYPTED *** -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -**Important**\ The\ password\ is\ stored\ in\ the\ config\ file\ is\ lightly -obscured\ so\ it\ isn\[aq]t\ immediately\ obvious\ what\ it\ is.\ \ It\ is\ in\ no\ way -secure\ unless\ you\ use\ config\ file\ encryption. - -A\ long\ passphrase\ is\ recommended,\ or\ you\ can\ use\ a\ random\ one.\ \ Note -that\ if\ you\ reconfigure\ rclone\ with\ the\ same\ passwords/passphrases -elsewhere\ it\ will\ be\ compatible\ \-\ all\ the\ secrets\ used\ are\ derived -from\ those\ two\ passwords/passphrases. - -Note\ that\ rclone\ does\ not\ encrypt - -\ \ *\ file\ length\ \-\ this\ can\ be\ calcuated\ within\ 16\ bytes -\ \ *\ modification\ time\ \-\ used\ for\ syncing - -##\ Specifying\ the\ remote\ ## - -In\ normal\ use,\ make\ sure\ the\ remote\ has\ a\ `:`\ in.\ If\ you\ specify\ the -remote\ without\ a\ `:`\ then\ rclone\ will\ use\ a\ local\ directory\ of\ that -name.\ \ So\ if\ you\ use\ a\ remote\ of\ `/path/to/secret/files`\ then\ rclone -will\ encrypt\ stuff\ to\ that\ directory.\ \ If\ you\ use\ a\ remote\ of\ `name` -then\ rclone\ will\ put\ files\ in\ a\ directory\ called\ `name`\ in\ the\ current -directory. - -If\ you\ specify\ the\ remote\ as\ `remote:path/to/dir`\ then\ rclone\ will -store\ encrypted\ files\ in\ `path/to/dir`\ on\ the\ remote.\ If\ you\ are\ using -file\ name\ encryption,\ then\ when\ you\ save\ files\ to -`secret:subdir/subfile`\ this\ will\ store\ them\ in\ the\ unencrypted\ path -`path/to/dir`\ but\ the\ `subdir/subpath`\ bit\ will\ be\ encrypted. - -Note\ that\ unless\ you\ want\ encrypted\ bucket\ names\ (which\ are\ difficult -to\ manage\ because\ you\ won\[aq]t\ know\ what\ directory\ they\ represent\ in\ web -interfaces\ etc),\ you\ should\ probably\ specify\ a\ bucket,\ eg -`remote:secretbucket`\ when\ using\ bucket\ based\ remotes\ such\ as\ S3, -Swift,\ Hubic,\ B2,\ GCS. - -##\ Example\ ## - -To\ test\ I\ made\ a\ little\ directory\ of\ files\ using\ "standard"\ file\ name -encryption. -\f[] -.fi -.PP -plaintext/ ├── file0.txt ├── file1.txt └── subdir ├── file2.txt ├── -file3.txt └── subsubdir └── file4.txt -.IP -.nf -\f[C] - -Copy\ these\ to\ the\ remote\ and\ list\ them\ back -\f[] -.fi -.PP -$ rclone \-q copy plaintext secret: $ rclone \-q ls secret: 7 file1.txt -6 file0.txt 8 subdir/file2.txt 10 subdir/subsubdir/file4.txt 9 -subdir/file3.txt -.IP -.nf -\f[C] - -Now\ see\ what\ that\ looked\ like\ when\ encrypted -\f[] -.fi -.PP -$ rclone \-q ls remote:path 55 hagjclgavj2mbiqm6u6cnjjqcg 54 -v05749mltvv1tf4onltun46gls 57 -86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo 58 -86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc -56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps -.IP -.nf -\f[C] - -Note\ that\ this\ retains\ the\ directory\ structure\ which\ means\ you\ can\ do\ this -\f[] -.fi -.PP -$ rclone \-q ls secret:subdir 8 file2.txt 9 file3.txt 10 -subsubdir/file4.txt -.IP -.nf -\f[C] - -If\ don\[aq]t\ use\ file\ name\ encryption\ then\ the\ remote\ will\ look\ like\ this -\-\ note\ the\ `.bin`\ extensions\ added\ to\ prevent\ the\ cloud\ provider -attempting\ to\ interpret\ the\ data. -\f[] -.fi -.PP -$ rclone \-q ls remote:path 54 file0.txt.bin 57 subdir/file3.txt.bin 56 -subdir/file2.txt.bin 58 subdir/subsubdir/file4.txt.bin 55 file1.txt.bin -.IP -.nf -\f[C] - -###\ File\ name\ encryption\ modes\ ### - -Here\ are\ some\ of\ the\ features\ of\ the\ file\ name\ encryption\ modes - -Off - -\ \ *\ doesn\[aq]t\ hide\ file\ names\ or\ directory\ structure -\ \ *\ allows\ for\ longer\ file\ names\ (~246\ characters) -\ \ *\ can\ use\ sub\ paths\ and\ copy\ single\ files - -Standard - -\ \ *\ file\ names\ encrypted -\ \ *\ file\ names\ can\[aq]t\ be\ as\ long\ (~143\ characters) -\ \ *\ can\ use\ sub\ paths\ and\ copy\ single\ files -\ \ *\ directory\ structure\ visible -\ \ *\ identical\ files\ names\ will\ have\ identical\ uploaded\ names -\ \ *\ can\ use\ shortcuts\ to\ shorten\ the\ directory\ recursion - -Obfuscation - -This\ is\ a\ simple\ "rotate"\ of\ the\ filename,\ with\ each\ file\ having\ a\ rot -distance\ based\ on\ the\ filename.\ We\ store\ the\ distance\ at\ the\ beginning -of\ the\ filename.\ So\ a\ file\ called\ "hello"\ may\ become\ "53.jgnnq" - -This\ is\ not\ a\ strong\ encryption\ of\ filenames,\ but\ it\ may\ stop\ automated -scanning\ tools\ from\ picking\ up\ on\ filename\ patterns.\ As\ such\ it\[aq]s\ an -intermediate\ between\ "off"\ and\ "standard".\ The\ advantage\ is\ that\ it -allows\ for\ longer\ path\ segment\ names. - -There\ is\ a\ possibility\ with\ some\ unicode\ based\ filenames\ that\ the -obfuscation\ is\ weak\ and\ may\ map\ lower\ case\ characters\ to\ upper\ case -equivalents.\ \ You\ can\ not\ rely\ on\ this\ for\ strong\ protection. - -\ \ *\ file\ names\ very\ lightly\ obfuscated -\ \ *\ file\ names\ can\ be\ longer\ than\ standard\ encryption -\ \ *\ can\ use\ sub\ paths\ and\ copy\ single\ files -\ \ *\ directory\ structure\ visible -\ \ *\ identical\ files\ names\ will\ have\ identical\ uploaded\ names - -Cloud\ storage\ systems\ have\ various\ limits\ on\ file\ name\ length\ and -total\ path\ length\ which\ you\ are\ more\ likely\ to\ hit\ using\ "Standard" -file\ name\ encryption.\ \ If\ you\ keep\ your\ file\ names\ to\ below\ 156 -characters\ in\ length\ then\ you\ should\ be\ OK\ on\ all\ providers. - -There\ may\ be\ an\ even\ more\ secure\ file\ name\ encryption\ mode\ in\ the -future\ which\ will\ address\ the\ long\ file\ name\ problem. - -###\ Directory\ name\ encryption\ ### -Crypt\ offers\ the\ option\ of\ encrypting\ dir\ names\ or\ leaving\ them\ intact. -There\ are\ two\ options: - -True - -Encrypts\ the\ whole\ file\ path\ including\ directory\ names -Example: -`1/12/123.txt`\ is\ encrypted\ to -`p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0` - -False - -Only\ encrypts\ file\ names,\ skips\ directory\ names -Example: -`1/12/123.txt`\ is\ encrypted\ to -`1/12/qgm4avr35m5loi1th53ato71v0` - - -###\ Modified\ time\ and\ hashes\ ### - -Crypt\ stores\ modification\ times\ using\ the\ underlying\ remote\ so\ support -depends\ on\ that. - -Hashes\ are\ not\ stored\ for\ crypt.\ \ However\ the\ data\ integrity\ is -protected\ by\ an\ extremely\ strong\ crypto\ authenticator. - -Note\ that\ you\ should\ use\ the\ `rclone\ cryptcheck`\ command\ to\ check\ the -integrity\ of\ a\ crypted\ remote\ instead\ of\ `rclone\ check`\ which\ can\[aq]t -check\ the\ checksums\ properly. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ crypt\ (Encrypt/Decrypt\ a\ remote). - -####\ \-\-crypt\-remote - -Remote\ to\ encrypt/decrypt. -Normally\ should\ contain\ a\ \[aq]:\[aq]\ and\ a\ path,\ eg\ "myremote:path/to/dir", -"myremote:bucket"\ or\ maybe\ "myremote:"\ (not\ recommended). - -\-\ Config:\ \ \ \ \ \ remote -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_REMOTE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-crypt\-filename\-encryption - -How\ to\ encrypt\ the\ filenames. - -\-\ Config:\ \ \ \ \ \ filename_encryption -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_FILENAME_ENCRYPTION -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "standard" -\-\ Examples: -\ \ \ \ \-\ "off" -\ \ \ \ \ \ \ \ \-\ Don\[aq]t\ encrypt\ the\ file\ names.\ \ Adds\ a\ ".bin"\ extension\ only. -\ \ \ \ \-\ "standard" -\ \ \ \ \ \ \ \ \-\ Encrypt\ the\ filenames\ see\ the\ docs\ for\ the\ details. -\ \ \ \ \-\ "obfuscate" -\ \ \ \ \ \ \ \ \-\ Very\ simple\ filename\ obfuscation. - -####\ \-\-crypt\-directory\-name\-encryption - -Option\ to\ either\ encrypt\ directory\ names\ or\ leave\ them\ intact. - -\-\ Config:\ \ \ \ \ \ directory_name_encryption -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ true -\-\ Examples: -\ \ \ \ \-\ "true" -\ \ \ \ \ \ \ \ \-\ Encrypt\ directory\ names. -\ \ \ \ \-\ "false" -\ \ \ \ \ \ \ \ \-\ Don\[aq]t\ encrypt\ directory\ names,\ leave\ them\ intact. - -####\ \-\-crypt\-password - -Password\ or\ pass\ phrase\ for\ encryption. - -\-\ Config:\ \ \ \ \ \ password -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_PASSWORD -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-crypt\-password2 - -Password\ or\ pass\ phrase\ for\ salt.\ Optional\ but\ recommended. -Should\ be\ different\ to\ the\ previous\ password. - -\-\ Config:\ \ \ \ \ \ password2 -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_PASSWORD2 -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ crypt\ (Encrypt/Decrypt\ a\ remote). - -####\ \-\-crypt\-show\-mapping - -For\ all\ files\ listed\ show\ how\ the\ names\ encrypt. - -If\ this\ flag\ is\ set\ then\ for\ each\ file\ that\ the\ remote\ is\ asked\ to -list,\ it\ will\ log\ (at\ level\ INFO)\ a\ line\ stating\ the\ decrypted\ file -name\ and\ the\ encrypted\ file\ name. - -This\ is\ so\ you\ can\ work\ out\ which\ encrypted\ names\ are\ which\ decrypted -names\ just\ in\ case\ you\ need\ to\ do\ something\ with\ the\ encrypted\ file -names,\ or\ for\ debugging\ purposes. - -\-\ Config:\ \ \ \ \ \ show_mapping -\-\ Env\ Var:\ \ \ \ \ RCLONE_CRYPT_SHOW_MAPPING -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - - - -##\ Backing\ up\ a\ crypted\ remote\ ## - -If\ you\ wish\ to\ backup\ a\ crypted\ remote,\ it\ it\ recommended\ that\ you\ use -`rclone\ sync`\ on\ the\ encrypted\ files,\ and\ make\ sure\ the\ passwords\ are -the\ same\ in\ the\ new\ encrypted\ remote. - -This\ will\ have\ the\ following\ advantages - -\ \ *\ `rclone\ sync`\ will\ check\ the\ checksums\ while\ copying -\ \ *\ you\ can\ use\ `rclone\ check`\ between\ the\ encrypted\ remotes -\ \ *\ you\ don\[aq]t\ decrypt\ and\ encrypt\ unnecessarily - -For\ example,\ let\[aq]s\ say\ you\ have\ your\ original\ remote\ at\ `remote:`\ with -the\ encrypted\ version\ at\ `eremote:`\ with\ path\ `remote:crypt`.\ \ You -would\ then\ set\ up\ the\ new\ remote\ `remote2:`\ and\ then\ the\ encrypted -version\ `eremote2:`\ with\ path\ `remote2:crypt`\ using\ the\ same\ passwords -as\ `eremote:`. - -To\ sync\ the\ two\ remotes\ you\ would\ do - -\ \ \ \ rclone\ sync\ remote:crypt\ remote2:crypt - -And\ to\ check\ the\ integrity\ you\ would\ do - -\ \ \ \ rclone\ check\ remote:crypt\ remote2:crypt - -##\ File\ formats\ ## - -###\ File\ encryption\ ### - -Files\ are\ encrypted\ 1:1\ source\ file\ to\ destination\ object.\ \ The\ file -has\ a\ header\ and\ is\ divided\ into\ chunks. - -####\ Header\ #### - -\ \ *\ 8\ bytes\ magic\ string\ `RCLONE\\x00\\x00` -\ \ *\ 24\ bytes\ Nonce\ (IV) - -The\ initial\ nonce\ is\ generated\ from\ the\ operating\ systems\ crypto -strong\ random\ number\ generator.\ \ The\ nonce\ is\ incremented\ for\ each -chunk\ read\ making\ sure\ each\ nonce\ is\ unique\ for\ each\ block\ written. -The\ chance\ of\ a\ nonce\ being\ re\-used\ is\ minuscule.\ \ If\ you\ wrote\ an -exabyte\ of\ data\ (10¹⁸\ bytes)\ you\ would\ have\ a\ probability\ of -approximately\ 2×10⁻³²\ of\ re\-using\ a\ nonce. - -####\ Chunk\ #### - -Each\ chunk\ will\ contain\ 64kB\ of\ data,\ except\ for\ the\ last\ one\ which -may\ have\ less\ data.\ \ The\ data\ chunk\ is\ in\ standard\ NACL\ secretbox -format.\ Secretbox\ uses\ XSalsa20\ and\ Poly1305\ to\ encrypt\ and -authenticate\ messages. - -Each\ chunk\ contains: - -\ \ *\ 16\ Bytes\ of\ Poly1305\ authenticator -\ \ *\ 1\ \-\ 65536\ bytes\ XSalsa20\ encrypted\ data - -64k\ chunk\ size\ was\ chosen\ as\ the\ best\ performing\ chunk\ size\ (the -authenticator\ takes\ too\ much\ time\ below\ this\ and\ the\ performance\ drops -off\ due\ to\ cache\ effects\ above\ this).\ \ Note\ that\ these\ chunks\ are -buffered\ in\ memory\ so\ they\ can\[aq]t\ be\ too\ big. - -This\ uses\ a\ 32\ byte\ (256\ bit\ key)\ key\ derived\ from\ the\ user\ password. - -####\ Examples\ #### - -1\ byte\ file\ will\ encrypt\ to - -\ \ *\ 32\ bytes\ header -\ \ *\ 17\ bytes\ data\ chunk - -49\ bytes\ total - -1MB\ (1048576\ bytes)\ file\ will\ encrypt\ to - -\ \ *\ 32\ bytes\ header -\ \ *\ 16\ chunks\ of\ 65568\ bytes - -1049120\ bytes\ total\ (a\ 0.05%\ overhead).\ \ This\ is\ the\ overhead\ for\ big -files. - -###\ Name\ encryption\ ### - -File\ names\ are\ encrypted\ segment\ by\ segment\ \-\ the\ path\ is\ broken\ up -into\ `/`\ separated\ strings\ and\ these\ are\ encrypted\ individually. - -File\ segments\ are\ padded\ using\ using\ PKCS#7\ to\ a\ multiple\ of\ 16\ bytes -before\ encryption. - -They\ are\ then\ encrypted\ with\ EME\ using\ AES\ with\ 256\ bit\ key.\ EME -(ECB\-Mix\-ECB)\ is\ a\ wide\-block\ encryption\ mode\ presented\ in\ the\ 2003 -paper\ "A\ Parallelizable\ Enciphering\ Mode"\ by\ Halevi\ and\ Rogaway. - -This\ makes\ for\ deterministic\ encryption\ which\ is\ what\ we\ want\ \-\ the -same\ filename\ must\ encrypt\ to\ the\ same\ thing\ otherwise\ we\ can\[aq]t\ find -it\ on\ the\ cloud\ storage\ system. - -This\ means\ that - -\ \ *\ filenames\ with\ the\ same\ name\ will\ encrypt\ the\ same -\ \ *\ filenames\ which\ start\ the\ same\ won\[aq]t\ have\ a\ common\ prefix - -This\ uses\ a\ 32\ byte\ key\ (256\ bits)\ and\ a\ 16\ byte\ (128\ bits)\ IV\ both\ of -which\ are\ derived\ from\ the\ user\ password. - -After\ encryption\ they\ are\ written\ out\ using\ a\ modified\ version\ of -standard\ `base32`\ encoding\ as\ described\ in\ RFC4648.\ \ The\ standard -encoding\ is\ modified\ in\ two\ ways: - -\ \ *\ it\ becomes\ lower\ case\ (no\-one\ likes\ upper\ case\ filenames!) -\ \ *\ we\ strip\ the\ padding\ character\ `=` - -`base32`\ is\ used\ rather\ than\ the\ more\ efficient\ `base64`\ so\ rclone\ can\ be -used\ on\ case\ insensitive\ remotes\ (eg\ Windows,\ Amazon\ Drive). - -###\ Key\ derivation\ ### - -Rclone\ uses\ `scrypt`\ with\ parameters\ `N=16384,\ r=8,\ p=1`\ with\ an -optional\ user\ supplied\ salt\ (password2)\ to\ derive\ the\ 32+32+16\ =\ 80 -bytes\ of\ key\ material\ required.\ \ If\ the\ user\ doesn\[aq]t\ supply\ a\ salt -then\ rclone\ uses\ an\ internal\ one. - -`scrypt`\ makes\ it\ impractical\ to\ mount\ a\ dictionary\ attack\ on\ rclone -encrypted\ data.\ \ For\ full\ protection\ against\ this\ you\ should\ always\ use -a\ salt. - -Dropbox -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths\ are\ specified\ as\ `remote:path` - -Dropbox\ paths\ may\ be\ as\ deep\ as\ required,\ eg -`remote:directory/subdirectory`. - -The\ initial\ setup\ for\ dropbox\ involves\ getting\ a\ token\ from\ Dropbox -which\ you\ need\ to\ do\ in\ your\ browser.\ \ `rclone\ config`\ walks\ you -through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / -Dropbox \ \[lq]dropbox\[rq] [snip] Storage> dropbox Dropbox App Key \- -leave blank normally. -app_key> Dropbox App Secret \- leave blank normally. -app_secret> Remote config Please visit: -https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX&response_type=code -Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] app_key = app_secret = -token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX -\[em]\[em]\[em]\[em]\[em]\[em]\[en] -.IP "q)" 3 -Yes this is OK -.IP "r)" 3 -Edit this remote -.IP "s)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -You\ can\ then\ use\ it\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ dropbox - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ dropbox - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ a\ dropbox\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -###\ Dropbox\ for\ business\ ### - -Rclone\ supports\ Dropbox\ for\ business\ and\ Team\ Folders. - -When\ using\ Dropbox\ for\ business\ `remote:`\ and\ `remote:path/to/file` -will\ refer\ to\ your\ personal\ folder. - -If\ you\ wish\ to\ see\ Team\ Folders\ you\ must\ use\ a\ leading\ `/`\ in\ the -path,\ so\ `rclone\ lsd\ remote:/`\ will\ refer\ to\ the\ root\ and\ show\ you\ all -Team\ Folders\ and\ your\ User\ Folder. - -You\ can\ then\ use\ team\ folders\ like\ this\ `remote:/TeamFolder`\ and -`remote:/TeamFolder/path/to/file`. - -A\ leading\ `/`\ for\ a\ Dropbox\ personal\ account\ will\ do\ nothing,\ but\ it -will\ take\ an\ extra\ HTTP\ transaction\ so\ it\ should\ be\ avoided. - -###\ Modified\ time\ and\ Hashes\ ### - -Dropbox\ supports\ modified\ times,\ but\ the\ only\ way\ to\ set\ a -modification\ time\ is\ to\ re\-upload\ the\ file. - -This\ means\ that\ if\ you\ uploaded\ your\ data\ with\ an\ older\ version\ of -rclone\ which\ didn\[aq]t\ support\ the\ v2\ API\ and\ modified\ times,\ rclone\ will -decide\ to\ upload\ all\ your\ old\ data\ to\ fix\ the\ modification\ times.\ \ If -you\ don\[aq]t\ want\ this\ to\ happen\ use\ `\-\-size\-only`\ or\ `\-\-checksum`\ flag -to\ stop\ it. - -Dropbox\ supports\ [its\ own\ hash -type](https://www.dropbox.com/developers/reference/content\-hash)\ which -is\ checked\ for\ all\ transfers. - -####\ Restricted\ filename\ characters - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ NUL\ \ \ \ \ \ \ |\ 0x00\ \ |\ ␀\ \ \ \ \ \ \ \ \ \ \ | -|\ /\ \ \ \ \ \ \ \ \ |\ 0x2F\ \ |\ ／\ \ \ \ \ \ \ \ \ \ \ | -|\ DEL\ \ \ \ \ \ \ |\ 0x7F\ \ |\ ␡\ \ \ \ \ \ \ \ \ \ \ | -|\ \\\ \ \ \ \ \ \ \ \ |\ 0x5C\ \ |\ ＼\ \ \ \ \ \ \ \ \ \ \ | - -File\ names\ can\ also\ not\ end\ with\ the\ following\ characters. -These\ only\ get\ replaced\ if\ they\ are\ last\ character\ in\ the\ name: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ dropbox\ (Dropbox). - -####\ \-\-dropbox\-client\-id - -Dropbox\ App\ Client\ Id -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_DROPBOX_CLIENT_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-dropbox\-client\-secret - -Dropbox\ App\ Client\ Secret -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_secret -\-\ Env\ Var:\ \ \ \ \ RCLONE_DROPBOX_CLIENT_SECRET -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ dropbox\ (Dropbox). - -####\ \-\-dropbox\-chunk\-size - -Upload\ chunk\ size.\ (<\ 150M). - -Any\ files\ larger\ than\ this\ will\ be\ uploaded\ in\ chunks\ of\ this\ size. - -Note\ that\ chunks\ are\ buffered\ in\ memory\ (one\ at\ a\ time)\ so\ rclone\ can -deal\ with\ retries.\ \ Setting\ this\ larger\ will\ increase\ the\ speed -slightly\ (at\ most\ 10%\ for\ 128MB\ in\ tests)\ at\ the\ cost\ of\ using\ more -memory.\ \ It\ can\ be\ set\ smaller\ if\ you\ are\ tight\ on\ memory. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_DROPBOX_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 48M - -####\ \-\-dropbox\-impersonate - -Impersonate\ this\ user\ when\ using\ a\ business\ account. - -\-\ Config:\ \ \ \ \ \ impersonate -\-\ Env\ Var:\ \ \ \ \ RCLONE_DROPBOX_IMPERSONATE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - - - -###\ Limitations\ ### - -Note\ that\ Dropbox\ is\ case\ insensitive\ so\ you\ can\[aq]t\ have\ a\ file\ called -"Hello.doc"\ and\ one\ called\ "hello.doc". - -There\ are\ some\ file\ names\ such\ as\ `thumbs.db`\ which\ Dropbox\ can\[aq]t -store.\ \ There\ is\ a\ full\ list\ of\ them\ in\ the\ ["Ignored\ Files"\ section -of\ this\ document](https://www.dropbox.com/en/help/145).\ \ Rclone\ will -issue\ an\ error\ message\ `File\ name\ disallowed\ \-\ not\ uploading`\ if\ it -attempts\ to\ upload\ one\ of\ those\ file\ names,\ but\ the\ sync\ won\[aq]t\ fail. - -If\ you\ have\ more\ than\ 10,000\ files\ in\ a\ directory\ then\ `rclone\ purge -dropbox:dir`\ will\ return\ the\ error\ `Failed\ to\ purge:\ There\ are\ too -many\ files\ involved\ in\ this\ operation`.\ \ As\ a\ work\-around\ do\ an -`rclone\ delete\ dropbox:dir`\ followed\ by\ an\ `rclone\ rmdir\ dropbox:dir`. - -FTP -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -FTP\ is\ the\ File\ Transfer\ Protocol.\ FTP\ support\ is\ provided\ using\ the -[github.com/jlaffaye/ftp](https://godoc.org/github.com/jlaffaye/ftp) -package. - -Here\ is\ an\ example\ of\ making\ an\ FTP\ configuration.\ \ First\ run - -\ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process.\ An\ FTP\ remote\ only -needs\ a\ host\ together\ with\ and\ a\ username\ and\ a\ password.\ With\ anonymous\ FTP -server,\ you\ will\ need\ to\ use\ `anonymous`\ as\ username\ and\ your\ email\ address\ as -the\ password. -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value [snip] XX / FTP Connection \ \[rq]ftp" [snip] -Storage> ftp ** See help for ftp backend at: https://rclone.org/ftp/ ** -.PP -FTP host to connect to Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value 1 / Connect to ftp.example.com -\ \[rq]ftp.example.com" host> ftp.example.com FTP username, leave blank -for current username, ncw Enter a string value. -Press Enter for the default ("\[lq]). user> FTP port, leave blank to use -default (21) Enter a string value. Press Enter for the default -(\[rq]\[lq]). port> FTP password y) Yes type in my own password g) -Generate random password y/g> y Enter the password: password: Confirm -the password: password: Use FTP over TLS (Implicit) Enter a boolean -value (true or false). Press Enter for the default (\[rq]false"). -tls> Remote config \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] type = -ftp host = ftp.example.com pass = *** ENCRYPTED *** -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -This\ remote\ is\ called\ `remote`\ and\ can\ now\ be\ used\ like\ this - -See\ all\ directories\ in\ the\ home\ directory - -\ \ \ \ rclone\ lsd\ remote: - -Make\ a\ new\ directory - -\ \ \ \ rclone\ mkdir\ remote:path/to/directory - -List\ the\ contents\ of\ a\ directory - -\ \ \ \ rclone\ ls\ remote:path/to/directory - -Sync\ `/home/local/directory`\ to\ the\ remote\ directory,\ deleting\ any -excess\ files\ in\ the\ directory. - -\ \ \ \ rclone\ sync\ /home/local/directory\ remote:directory - -###\ Modified\ time\ ### - -FTP\ does\ not\ support\ modified\ times.\ \ Any\ times\ you\ see\ on\ the\ server -will\ be\ time\ of\ upload. - -###\ Checksums\ ### - -FTP\ does\ not\ support\ any\ checksums. - -####\ Restricted\ filename\ characters - -In\ addition\ to\ the\ [default\ restricted\ characters\ set](/overview/#restricted\-characters) -the\ following\ characters\ are\ also\ replaced: - -File\ names\ can\ also\ not\ end\ with\ the\ following\ characters. -These\ only\ get\ replaced\ if\ they\ are\ last\ character\ in\ the\ name: - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ SP\ \ \ \ \ \ \ \ |\ 0x20\ \ |\ ␠\ \ \ \ \ \ \ \ \ \ \ | - -Note\ that\ not\ all\ FTP\ servers\ can\ have\ all\ characters\ in\ file\ names,\ for\ example: - -|\ FTP\ Server|\ Forbidden\ characters\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-:| -|\ proftpd\ \ \ |\ `*`\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ | -|\ pureftpd\ \ |\ `\\\ [\ ]`\ \ \ \ \ \ \ \ \ \ \ \ \ \ | - -###\ Implicit\ TLS\ ### - -FTP\ supports\ implicit\ FTP\ over\ TLS\ servers\ (FTPS).\ This\ has\ to\ be\ enabled -in\ the\ config\ for\ the\ remote.\ The\ default\ FTPS\ port\ is\ `990`\ so\ the -port\ will\ likely\ have\ to\ be\ explictly\ set\ in\ the\ config\ for\ the\ remote. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ ftp\ (FTP\ Connection). - -####\ \-\-ftp\-host - -FTP\ host\ to\ connect\ to - -\-\ Config:\ \ \ \ \ \ host -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_HOST -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "ftp.example.com" -\ \ \ \ \ \ \ \ \-\ Connect\ to\ ftp.example.com - -####\ \-\-ftp\-user - -FTP\ username,\ leave\ blank\ for\ current\ username,\ $USER - -\-\ Config:\ \ \ \ \ \ user -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_USER -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-ftp\-port - -FTP\ port,\ leave\ blank\ to\ use\ default\ (21) - -\-\ Config:\ \ \ \ \ \ port -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_PORT -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-ftp\-pass - -FTP\ password - -\-\ Config:\ \ \ \ \ \ pass -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_PASS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-ftp\-tls - -Use\ FTP\ over\ TLS\ (Implicit) - -\-\ Config:\ \ \ \ \ \ tls -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_TLS -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ ftp\ (FTP\ Connection). - -####\ \-\-ftp\-concurrency - -Maximum\ number\ of\ FTP\ simultaneous\ connections,\ 0\ for\ unlimited - -\-\ Config:\ \ \ \ \ \ concurrency -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_CONCURRENCY -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 0 - -####\ \-\-ftp\-no\-check\-certificate - -Do\ not\ verify\ the\ TLS\ certificate\ of\ the\ server - -\-\ Config:\ \ \ \ \ \ no_check_certificate -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_NO_CHECK_CERTIFICATE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-ftp\-disable\-epsv - -Disable\ using\ EPSV\ even\ if\ server\ advertises\ support - -\-\ Config:\ \ \ \ \ \ disable_epsv -\-\ Env\ Var:\ \ \ \ \ RCLONE_FTP_DISABLE_EPSV -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - - - -###\ Limitations\ ### - -Note\ that\ since\ FTP\ isn\[aq]t\ HTTP\ based\ the\ following\ flags\ don\[aq]t\ work -with\ it:\ `\-\-dump\-headers`,\ `\-\-dump\-bodies`,\ `\-\-dump\-auth` - -Note\ that\ `\-\-timeout`\ isn\[aq]t\ supported\ (but\ `\-\-contimeout`\ is). - -Note\ that\ `\-\-bind`\ isn\[aq]t\ supported. - -FTP\ could\ support\ server\ side\ move\ but\ doesn\[aq]t\ yet. - -Note\ that\ the\ ftp\ backend\ does\ not\ support\ the\ `ftp_proxy`\ environment -variable\ yet. - -Note\ that\ while\ implicit\ FTP\ over\ TLS\ is\ supported, -explicit\ FTP\ over\ TLS\ is\ not. - -Google\ Cloud\ Storage -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths\ are\ specified\ as\ `remote:bucket`\ (or\ `remote:`\ for\ the\ `lsd` -command.)\ \ You\ may\ put\ subdirectories\ in\ too,\ eg\ `remote:bucket/path/to/dir`. - -The\ initial\ setup\ for\ google\ cloud\ storage\ involves\ getting\ a\ token\ from\ Google\ Cloud\ Storage -which\ you\ need\ to\ do\ in\ your\ browser.\ \ `rclone\ config`\ walks\ you -through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.IP "n)" 3 -New remote -.IP "o)" 3 -Delete remote -.IP "p)" 3 -Quit config e/n/d/q> n name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Cloud Storage (this is not Google Drive) \ \[lq]google cloud -storage\[rq] [snip] Storage> google cloud storage Google Application -Client Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Project number optional \- needed only for -list/create/delete buckets \- see your developer console. -project_number> 12345678 Service Account Credentials JSON file path \- -needed only if you want use SA instead of interactive login. -service_account_file> Access Control List for new objects. -Choose a number from below, or type in your own value 1 / Object owner -gets OWNER access, and all Authenticated Users get READER access. -\ \[lq]authenticatedRead\[rq] 2 / Object owner gets OWNER access, and -project team owners get OWNER access. -\ \[lq]bucketOwnerFullControl\[rq] 3 / Object owner gets OWNER access, -and project team owners get READER access. -\ \[lq]bucketOwnerRead\[rq] 4 / Object owner gets OWNER access [default -if left blank]. -\ \[lq]private\[rq] 5 / Object owner gets OWNER access, and project team -members get access according to their roles. -\ \[lq]projectPrivate\[rq] 6 / Object owner gets OWNER access, and all -Users get READER access. -\ \[lq]publicRead\[rq] object_acl> 4 Access Control List for new -buckets. -Choose a number from below, or type in your own value 1 / Project team -owners get OWNER access, and all Authenticated Users get READER access. -\ \[lq]authenticatedRead\[rq] 2 / Project team owners get OWNER access -[default if left blank]. -\ \[lq]private\[rq] 3 / Project team members get access according to -their roles. -\ \[lq]projectPrivate\[rq] 4 / Project team owners get OWNER access, and -all Users get READER access. -\ \[lq]publicRead\[rq] 5 / Project team owners get OWNER access, and all -Users get WRITER access. -\ \[lq]publicReadWrite\[rq] bucket_acl> 2 Location for the newly created -buckets. -Choose a number from below, or type in your own value 1 / Empty for -default location (US). -\ "" 2 / Multi\-regional location for Asia. -\ \[lq]asia\[rq] 3 / Multi\-regional location for Europe. -\ \[lq]eu\[rq] 4 / Multi\-regional location for United States. -\ \[lq]us\[rq] 5 / Taiwan. -\ \[lq]asia\-east1\[rq] 6 / Tokyo. -\ \[lq]asia\-northeast1\[rq] 7 / Singapore. -\ \[lq]asia\-southeast1\[rq] 8 / Sydney. -\ \[lq]australia\-southeast1\[rq] 9 / Belgium. -\ \[lq]europe\-west1\[rq] 10 / London. -\ \[lq]europe\-west2\[rq] 11 / Iowa. -\ \[lq]us\-central1\[rq] 12 / South Carolina. -\ \[lq]us\-east1\[rq] 13 / Northern Virginia. -\ \[lq]us\-east4\[rq] 14 / Oregon. -\ \[lq]us\-west1\[rq] location> 12 The storage class to use when storing -objects in Google Cloud Storage. -Choose a number from below, or type in your own value 1 / Default \ "" 2 -/ Multi\-regional storage class \ \[lq]MULTI_REGIONAL\[rq] 3 / Regional -storage class \ \[lq]REGIONAL\[rq] 4 / Nearline storage class -\ \[lq]NEARLINE\[rq] 5 / Coldline storage class \ \[lq]COLDLINE\[rq] 6 / -Durable reduced availability storage class -\ \[lq]DURABLE_REDUCED_AVAILABILITY\[rq] storage_class> 5 Remote config -Use auto config? +Go routines: +\f[C]curl http://localhost:5572/debug/pprof/goroutine?debug=1\f[R] .IP \[bu] 2 -Say Y if not sure +30\-second CPU profile: +\f[C]go tool pprof http://localhost:5572/debug/pprof/profile\f[R] .IP \[bu] 2 -Say N if you are working on a remote or headless machine or Y didn't -work -.IP "y)" 3 -Yes -.IP "z)" 3 -No y/n> y If your browser doesn't open automatically go to the following -link: http://127.0.0.1:53682/auth Log in and authorize rclone for access -Waiting for code\&... Got code \[em]\[em]\[em]\[em]\[em]\[em]\[en] -[remote] type = google cloud storage client_id = client_secret = token = -{\[lq]AccessToken\[rq]:\[lq]xxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]RefreshToken\[rq]:\[lq]x/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxx\[rq],\[lq]Expiry\[rq]:\[lq]2014\-07\-17T20:49:14.929208288+01:00\[rq],\[lq]Extra\[rq]:null} -project_number = 12345678 object_acl = private bucket_acl = private -\[em]\[em]\[em]\[em]\[em]\[em]\[en] -.IP "a)" 3 -Yes this is OK -.IP "b)" 3 -Edit this remote -.IP "c)" 3 -Delete this remote y/e/d> y -.IP -.nf -\f[C] - -Note\ that\ rclone\ runs\ a\ webserver\ on\ your\ local\ machine\ to\ collect\ the -token\ as\ returned\ from\ Google\ if\ you\ use\ auto\ config\ mode.\ This\ only -runs\ from\ the\ moment\ it\ opens\ your\ browser\ to\ the\ moment\ you\ get\ back -the\ verification\ code.\ \ This\ is\ on\ `http://127.0.0.1:53682/`\ and\ this -it\ may\ require\ you\ to\ unblock\ it\ temporarily\ if\ you\ are\ running\ a\ host -firewall,\ or\ use\ manual\ mode. - -This\ remote\ is\ called\ `remote`\ and\ can\ now\ be\ used\ like\ this - -See\ all\ the\ buckets\ in\ your\ project - -\ \ \ \ rclone\ lsd\ remote: - -Make\ a\ new\ bucket - -\ \ \ \ rclone\ mkdir\ remote:bucket - -List\ the\ contents\ of\ a\ bucket - -\ \ \ \ rclone\ ls\ remote:bucket - -Sync\ `/home/local/directory`\ to\ the\ remote\ bucket,\ deleting\ any\ excess -files\ in\ the\ bucket. - -\ \ \ \ rclone\ sync\ /home/local/directory\ remote:bucket - -###\ Service\ Account\ support\ ### - -You\ can\ set\ up\ rclone\ with\ Google\ Cloud\ Storage\ in\ an\ unattended\ mode, -i.e.\ not\ tied\ to\ a\ specific\ end\-user\ Google\ account.\ This\ is\ useful -when\ you\ want\ to\ synchronise\ files\ onto\ machines\ that\ don\[aq]t\ have -actively\ logged\-in\ users,\ for\ example\ build\ machines. - -To\ get\ credentials\ for\ Google\ Cloud\ Platform -[IAM\ Service\ Accounts](https://cloud.google.com/iam/docs/service\-accounts), -please\ head\ to\ the -[Service\ Account](https://console.cloud.google.com/permissions/serviceaccounts) -section\ of\ the\ Google\ Developer\ Console.\ Service\ Accounts\ behave\ just -like\ normal\ `User`\ permissions\ in -[Google\ Cloud\ Storage\ ACLs](https://cloud.google.com/storage/docs/access\-control), -so\ you\ can\ limit\ their\ access\ (e.g.\ make\ them\ read\ only).\ After -creating\ an\ account,\ a\ JSON\ file\ containing\ the\ Service\ Account\[aq]s -credentials\ will\ be\ downloaded\ onto\ your\ machines.\ These\ credentials -are\ what\ rclone\ will\ use\ for\ authentication. - -To\ use\ a\ Service\ Account\ instead\ of\ OAuth2\ token\ flow,\ enter\ the\ path -to\ your\ Service\ Account\ credentials\ at\ the\ `service_account_file` -prompt\ and\ rclone\ won\[aq]t\ use\ the\ browser\ based\ authentication -flow.\ If\ you\[aq]d\ rather\ stuff\ the\ contents\ of\ the\ credentials\ file\ into -the\ rclone\ config\ file,\ you\ can\ set\ `service_account_credentials`\ with -the\ actual\ contents\ of\ the\ file\ instead,\ or\ set\ the\ equivalent -environment\ variable. - -###\ Application\ Default\ Credentials\ ### - -If\ no\ other\ source\ of\ credentials\ is\ provided,\ rclone\ will\ fall\ back -to -[Application\ Default\ Credentials](https://cloud.google.com/video\-intelligence/docs/common/auth#authenticating_with_application_default_credentials) -this\ is\ useful\ both\ when\ you\ already\ have\ configured\ authentication -for\ your\ developer\ account,\ or\ in\ production\ when\ running\ on\ a\ google -compute\ host.\ Note\ that\ if\ running\ in\ docker,\ you\ may\ need\ to\ run -additional\ commands\ on\ your\ google\ compute\ machine\ \- -[see\ this\ page](https://cloud.google.com/container\-registry/docs/advanced\-authentication#gcloud_as_a_docker_credential_helper). - -Note\ that\ in\ the\ case\ application\ default\ credentials\ are\ used,\ there -is\ no\ need\ to\ explicitly\ configure\ a\ project\ number. - -###\ \-\-fast\-list\ ### - -This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer -transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone -docs](/docs/#fast\-list)\ for\ more\ details. - -###\ Modified\ time\ ### - -Google\ google\ cloud\ storage\ stores\ md5sums\ natively\ and\ rclone\ stores -modification\ times\ as\ metadata\ on\ the\ object,\ under\ the\ "mtime"\ key\ in -RFC3339\ format\ accurate\ to\ 1ns. - -####\ Restricted\ filename\ characters - -|\ Character\ |\ Value\ |\ Replacement\ | -|\ \-\-\-\-\-\-\-\-\-\ |:\-\-\-\-\-:|:\-\-\-\-\-\-\-\-\-\-\-:| -|\ NUL\ \ \ \ \ \ \ |\ 0x00\ \ |\ ␀\ \ \ \ \ \ \ \ \ \ \ | -|\ LF\ \ \ \ \ \ \ \ |\ 0x0A\ \ |\ ␊\ \ \ \ \ \ \ \ \ \ \ | -|\ CR\ \ \ \ \ \ \ \ |\ 0x0D\ \ |\ ␍\ \ \ \ \ \ \ \ \ \ \ | -|\ /\ \ \ \ \ \ \ \ \ |\ 0x2F\ \ |\ ／\ \ \ \ \ \ \ \ \ \ | - -Invalid\ UTF\-8\ bytes\ will\ also\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ google\ cloud\ storage\ (Google\ Cloud\ Storage\ (this\ is\ not\ Google\ Drive)). - -####\ \-\-gcs\-client\-id - -Google\ Application\ Client\ Id -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_CLIENT_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-gcs\-client\-secret - -Google\ Application\ Client\ Secret -Leave\ blank\ normally. - -\-\ Config:\ \ \ \ \ \ client_secret -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_CLIENT_SECRET -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-gcs\-project\-number - -Project\ number. -Optional\ \-\ needed\ only\ for\ list/create/delete\ buckets\ \-\ see\ your\ developer\ console. - -\-\ Config:\ \ \ \ \ \ project_number -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_PROJECT_NUMBER -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-gcs\-service\-account\-file - -Service\ Account\ Credentials\ JSON\ file\ path -Leave\ blank\ normally. -Needed\ only\ if\ you\ want\ use\ SA\ instead\ of\ interactive\ login. - -\-\ Config:\ \ \ \ \ \ service_account_file -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_SERVICE_ACCOUNT_FILE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-gcs\-service\-account\-credentials - -Service\ Account\ Credentials\ JSON\ blob -Leave\ blank\ normally. -Needed\ only\ if\ you\ want\ use\ SA\ instead\ of\ interactive\ login. - -\-\ Config:\ \ \ \ \ \ service_account_credentials -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-gcs\-object\-acl - -Access\ Control\ List\ for\ new\ objects. - -\-\ Config:\ \ \ \ \ \ object_acl -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_OBJECT_ACL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "authenticatedRead" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access,\ and\ all\ Authenticated\ Users\ get\ READER\ access. -\ \ \ \ \-\ "bucketOwnerFullControl" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access,\ and\ project\ team\ owners\ get\ OWNER\ access. -\ \ \ \ \-\ "bucketOwnerRead" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access,\ and\ project\ team\ owners\ get\ READER\ access. -\ \ \ \ \-\ "private" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access\ [default\ if\ left\ blank]. -\ \ \ \ \-\ "projectPrivate" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access,\ and\ project\ team\ members\ get\ access\ according\ to\ their\ roles. -\ \ \ \ \-\ "publicRead" -\ \ \ \ \ \ \ \ \-\ Object\ owner\ gets\ OWNER\ access,\ and\ all\ Users\ get\ READER\ access. - -####\ \-\-gcs\-bucket\-acl - -Access\ Control\ List\ for\ new\ buckets. - -\-\ Config:\ \ \ \ \ \ bucket_acl -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_BUCKET_ACL -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "authenticatedRead" -\ \ \ \ \ \ \ \ \-\ Project\ team\ owners\ get\ OWNER\ access,\ and\ all\ Authenticated\ Users\ get\ READER\ access. -\ \ \ \ \-\ "private" -\ \ \ \ \ \ \ \ \-\ Project\ team\ owners\ get\ OWNER\ access\ [default\ if\ left\ blank]. -\ \ \ \ \-\ "projectPrivate" -\ \ \ \ \ \ \ \ \-\ Project\ team\ members\ get\ access\ according\ to\ their\ roles. -\ \ \ \ \-\ "publicRead" -\ \ \ \ \ \ \ \ \-\ Project\ team\ owners\ get\ OWNER\ access,\ and\ all\ Users\ get\ READER\ access. -\ \ \ \ \-\ "publicReadWrite" -\ \ \ \ \ \ \ \ \-\ Project\ team\ owners\ get\ OWNER\ access,\ and\ all\ Users\ get\ WRITER\ access. - -####\ \-\-gcs\-bucket\-policy\-only - -Access\ checks\ should\ use\ bucket\-level\ IAM\ policies. - -If\ you\ want\ to\ upload\ objects\ to\ a\ bucket\ with\ Bucket\ Policy\ Only\ set -then\ you\ will\ need\ to\ set\ this. - -When\ it\ is\ set,\ rclone: - -\-\ ignores\ ACLs\ set\ on\ buckets -\-\ ignores\ ACLs\ set\ on\ objects -\-\ creates\ buckets\ with\ Bucket\ Policy\ Only\ set - -Docs:\ https://cloud.google.com/storage/docs/bucket\-policy\-only - - -\-\ Config:\ \ \ \ \ \ bucket_policy_only -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_BUCKET_POLICY_ONLY -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-gcs\-location - -Location\ for\ the\ newly\ created\ buckets. - -\-\ Config:\ \ \ \ \ \ location -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_LOCATION -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Empty\ for\ default\ location\ (US). -\ \ \ \ \-\ "asia" -\ \ \ \ \ \ \ \ \-\ Multi\-regional\ location\ for\ Asia. -\ \ \ \ \-\ "eu" -\ \ \ \ \ \ \ \ \-\ Multi\-regional\ location\ for\ Europe. -\ \ \ \ \-\ "us" -\ \ \ \ \ \ \ \ \-\ Multi\-regional\ location\ for\ United\ States. -\ \ \ \ \-\ "asia\-east1" -\ \ \ \ \ \ \ \ \-\ Taiwan. -\ \ \ \ \-\ "asia\-east2" -\ \ \ \ \ \ \ \ \-\ Hong\ Kong. -\ \ \ \ \-\ "asia\-northeast1" -\ \ \ \ \ \ \ \ \-\ Tokyo. -\ \ \ \ \-\ "asia\-south1" -\ \ \ \ \ \ \ \ \-\ Mumbai. -\ \ \ \ \-\ "asia\-southeast1" -\ \ \ \ \ \ \ \ \-\ Singapore. -\ \ \ \ \-\ "australia\-southeast1" -\ \ \ \ \ \ \ \ \-\ Sydney. -\ \ \ \ \-\ "europe\-north1" -\ \ \ \ \ \ \ \ \-\ Finland. -\ \ \ \ \-\ "europe\-west1" -\ \ \ \ \ \ \ \ \-\ Belgium. -\ \ \ \ \-\ "europe\-west2" -\ \ \ \ \ \ \ \ \-\ London. -\ \ \ \ \-\ "europe\-west3" -\ \ \ \ \ \ \ \ \-\ Frankfurt. -\ \ \ \ \-\ "europe\-west4" -\ \ \ \ \ \ \ \ \-\ Netherlands. -\ \ \ \ \-\ "us\-central1" -\ \ \ \ \ \ \ \ \-\ Iowa. -\ \ \ \ \-\ "us\-east1" -\ \ \ \ \ \ \ \ \-\ South\ Carolina. -\ \ \ \ \-\ "us\-east4" -\ \ \ \ \ \ \ \ \-\ Northern\ Virginia. -\ \ \ \ \-\ "us\-west1" -\ \ \ \ \ \ \ \ \-\ Oregon. -\ \ \ \ \-\ "us\-west2" -\ \ \ \ \ \ \ \ \-\ California. - -####\ \-\-gcs\-storage\-class - -The\ storage\ class\ to\ use\ when\ storing\ objects\ in\ Google\ Cloud\ Storage. - -\-\ Config:\ \ \ \ \ \ storage_class -\-\ Env\ Var:\ \ \ \ \ RCLONE_GCS_STORAGE_CLASS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "" -\ \ \ \ \ \ \ \ \-\ Default -\ \ \ \ \-\ "MULTI_REGIONAL" -\ \ \ \ \ \ \ \ \-\ Multi\-regional\ storage\ class -\ \ \ \ \-\ "REGIONAL" -\ \ \ \ \ \ \ \ \-\ Regional\ storage\ class -\ \ \ \ \-\ "NEARLINE" -\ \ \ \ \ \ \ \ \-\ Nearline\ storage\ class -\ \ \ \ \-\ "COLDLINE" -\ \ \ \ \ \ \ \ \-\ Coldline\ storage\ class -\ \ \ \ \-\ "DURABLE_REDUCED_AVAILABILITY" -\ \ \ \ \ \ \ \ \-\ Durable\ reduced\ availability\ storage\ class - - - -Google\ Drive -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -Paths\ are\ specified\ as\ `drive:path` - -Drive\ paths\ may\ be\ as\ deep\ as\ required,\ eg\ `drive:directory/subdirectory`. - -The\ initial\ setup\ for\ drive\ involves\ getting\ a\ token\ from\ Google\ drive -which\ you\ need\ to\ do\ in\ your\ browser.\ \ `rclone\ config`\ walks\ you -through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi +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 -No remotes found \- make a new one n) New remote r) Rename remote c) -Copy remote s) Set configuration password q) Quit config n/r/c/s/q> n -name> remote Type of storage to configure. -Choose a number from below, or type in your own value [snip] XX / Google -Drive \ \[lq]drive\[rq] [snip] Storage> drive Google Application Client -Id \- leave blank normally. -client_id> Google Application Client Secret \- leave blank normally. -client_secret> Scope that rclone should use when requesting access from -drive. -Choose a number from below, or type in your own value 1 / Full access -all files, excluding Application Data Folder. -\ \[lq]drive\[rq] 2 / Read\-only access to file metadata and file -contents. -\ \[lq]drive.readonly\[rq] / Access to files created by rclone only. -3 | These are visible in the drive website. -| File authorization is revoked when the user deauthorizes the app. -\ \[lq]drive.file\[rq] / Allows read and write access to the Application -Data folder. -4 | This is not visible in the drive website. -\ \[lq]drive.appfolder\[rq] / Allows read\-only access to file metadata -but 5 | does not allow any access to read or download file content. -\ \[lq]drive.metadata.readonly\[rq] scope> 1 ID of the root folder \- -leave blank normally. -Fill in to access \[lq]Computers\[rq] folders. -(see docs). -root_folder_id> Service Account Credentials JSON file path \- needed -only if you want use SA instead of interactive login. -service_account_file> Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine or Y didn't work y) Yes n) No y/n> y If your browser doesn't -open automatically go to the following link: http://127.0.0.1:53682/auth -Log in and authorize rclone for access Waiting for code\&... Got code -Configure this as a team drive? -y) Yes n) No y/n> n \[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] -client_id = client_secret = scope = drive root_folder_id = -service_account_file = token = -{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]Bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2014\-03\-16T13:57:58.955387075Z\[rq]} -\[em]\[em]\[em]\[em]\[em]\[em]\[en] y) Yes this is OK e) Edit this -remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -Note\ that\ rclone\ runs\ a\ webserver\ on\ your\ local\ machine\ to\ collect\ the -token\ as\ returned\ from\ Google\ if\ you\ use\ auto\ config\ mode.\ This\ only -runs\ from\ the\ moment\ it\ opens\ your\ browser\ to\ the\ moment\ you\ get\ back -the\ verification\ code.\ \ This\ is\ on\ `http://127.0.0.1:53682/`\ and\ this -it\ may\ require\ you\ to\ unblock\ it\ temporarily\ if\ you\ are\ running\ a\ host -firewall,\ or\ use\ manual\ mode. - -You\ can\ then\ use\ it\ like\ this, - -List\ directories\ in\ top\ level\ of\ your\ drive - -\ \ \ \ rclone\ lsd\ remote: - -List\ all\ the\ files\ in\ your\ drive - -\ \ \ \ rclone\ ls\ remote: - -To\ copy\ a\ local\ directory\ to\ a\ drive\ directory\ called\ backup - -\ \ \ \ rclone\ copy\ /home/source\ remote:backup - -###\ Scopes\ ### - -Rclone\ allows\ you\ to\ select\ which\ scope\ you\ would\ like\ for\ rclone\ to -use.\ \ This\ changes\ what\ type\ of\ token\ is\ granted\ to\ rclone.\ \ [The -scopes\ are\ defined -here.](https://developers.google.com/drive/v3/web/about\-auth). - -The\ scope\ are - -####\ drive\ #### - -This\ is\ the\ default\ scope\ and\ allows\ full\ access\ to\ all\ files,\ except -for\ the\ Application\ Data\ Folder\ (see\ below). - -Choose\ this\ one\ if\ you\ aren\[aq]t\ sure. - -####\ drive.readonly\ #### - -This\ allows\ read\ only\ access\ to\ all\ files.\ \ Files\ may\ be\ listed\ and -downloaded\ but\ not\ uploaded,\ renamed\ or\ deleted. - -####\ drive.file\ #### - -With\ this\ scope\ rclone\ can\ read/view/modify\ only\ those\ files\ and -folders\ it\ creates. - -So\ if\ you\ uploaded\ files\ to\ drive\ via\ the\ web\ interface\ (or\ any\ other -means)\ they\ will\ not\ be\ visible\ to\ rclone. - -This\ can\ be\ useful\ if\ you\ are\ using\ rclone\ to\ backup\ data\ and\ you\ want -to\ be\ sure\ confidential\ data\ on\ your\ drive\ is\ not\ visible\ to\ rclone. - -Files\ created\ with\ this\ scope\ are\ visible\ in\ the\ web\ interface. - -####\ drive.appfolder\ #### - -This\ gives\ rclone\ its\ own\ private\ area\ to\ store\ files.\ \ Rclone\ will -not\ be\ able\ to\ see\ any\ other\ files\ on\ your\ drive\ and\ you\ won\[aq]t\ be\ able -to\ see\ rclone\[aq]s\ files\ from\ the\ web\ interface\ either. - -####\ drive.metadata.readonly\ #### - -This\ allows\ read\ only\ access\ to\ file\ names\ only.\ \ It\ does\ not\ allow -rclone\ to\ download\ or\ upload\ data,\ or\ rename\ or\ delete\ files\ or -directories. - -###\ Root\ folder\ ID\ ### - -You\ can\ set\ the\ `root_folder_id`\ for\ rclone.\ \ This\ is\ the\ directory -(identified\ by\ its\ `Folder\ ID`)\ that\ rclone\ considers\ to\ be\ the\ root -of\ your\ drive. - -Normally\ you\ will\ leave\ this\ blank\ and\ rclone\ will\ determine\ the -correct\ root\ to\ use\ itself. - -However\ you\ can\ set\ this\ to\ restrict\ rclone\ to\ a\ specific\ folder -hierarchy\ or\ to\ access\ data\ within\ the\ "Computers"\ tab\ on\ the\ drive -web\ interface\ (where\ files\ from\ Google\[aq]s\ Backup\ and\ Sync\ desktop -program\ go). - -In\ order\ to\ do\ this\ you\ will\ have\ to\ find\ the\ `Folder\ ID`\ of\ the -directory\ you\ wish\ rclone\ to\ display.\ \ This\ will\ be\ the\ last\ segment -of\ the\ URL\ when\ you\ open\ the\ relevant\ folder\ in\ the\ drive\ web -interface. - -So\ if\ the\ folder\ you\ want\ rclone\ to\ use\ has\ a\ URL\ which\ looks\ like -`https://drive.google.com/drive/folders/1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh` -in\ the\ browser,\ then\ you\ use\ `1XyfxxxxxxxxxxxxxxxxxxxxxxxxxKHCh`\ as -the\ `root_folder_id`\ in\ the\ config. - -**NB**\ folders\ under\ the\ "Computers"\ tab\ seem\ to\ be\ read\ only\ (drive -gives\ a\ 500\ error)\ when\ using\ rclone. - -There\ doesn\[aq]t\ appear\ to\ be\ an\ API\ to\ discover\ the\ folder\ IDs\ of\ the -"Computers"\ tab\ \-\ please\ contact\ us\ if\ you\ know\ otherwise! - -Note\ also\ that\ rclone\ can\[aq]t\ access\ any\ data\ under\ the\ "Backups"\ tab\ on -the\ google\ drive\ web\ interface\ yet. - -###\ Service\ Account\ support\ ### - -You\ can\ set\ up\ rclone\ with\ Google\ Drive\ in\ an\ unattended\ mode, -i.e.\ not\ tied\ to\ a\ specific\ end\-user\ Google\ account.\ This\ is\ useful -when\ you\ want\ to\ synchronise\ files\ onto\ machines\ that\ don\[aq]t\ have -actively\ logged\-in\ users,\ for\ example\ build\ machines. - -To\ use\ a\ Service\ Account\ instead\ of\ OAuth2\ token\ flow,\ enter\ the\ path -to\ your\ Service\ Account\ credentials\ at\ the\ `service_account_file` -prompt\ during\ `rclone\ config`\ and\ rclone\ won\[aq]t\ use\ the\ browser\ based -authentication\ flow.\ If\ you\[aq]d\ rather\ stuff\ the\ contents\ of\ the -credentials\ file\ into\ the\ rclone\ config\ file,\ you\ can\ set -`service_account_credentials`\ with\ the\ actual\ contents\ of\ the\ file -instead,\ or\ set\ the\ equivalent\ environment\ variable. - -####\ Use\ case\ \-\ Google\ Apps/G\-suite\ account\ and\ individual\ Drive\ #### - -Let\[aq]s\ say\ that\ you\ are\ the\ administrator\ of\ a\ Google\ Apps\ (old)\ or -G\-suite\ account. -The\ goal\ is\ to\ store\ data\ on\ an\ individual\[aq]s\ Drive\ account,\ who\ IS -a\ member\ of\ the\ domain. -We\[aq]ll\ call\ the\ domain\ **example.com**,\ and\ the\ user -**foo\@example.com**. - -There\[aq]s\ a\ few\ steps\ we\ need\ to\ go\ through\ to\ accomplish\ this: - -#####\ 1.\ Create\ a\ service\ account\ for\ example.com\ ##### -\ \ \-\ To\ create\ a\ service\ account\ and\ obtain\ its\ credentials,\ go\ to\ the -[Google\ Developer\ Console](https://console.developers.google.com). -\ \ \-\ You\ must\ have\ a\ project\ \-\ create\ one\ if\ you\ don\[aq]t. -\ \ \-\ Then\ go\ to\ "IAM\ &\ admin"\ \->\ "Service\ Accounts". -\ \ \-\ Use\ the\ "Create\ Credentials"\ button.\ Fill\ in\ "Service\ account\ name" -with\ something\ that\ identifies\ your\ client.\ "Role"\ can\ be\ empty. -\ \ \-\ Tick\ "Furnish\ a\ new\ private\ key"\ \-\ select\ "Key\ type\ JSON". -\ \ \-\ Tick\ "Enable\ G\ Suite\ Domain\-wide\ Delegation".\ This\ option\ makes -"impersonation"\ possible,\ as\ documented\ here: -[Delegating\ domain\-wide\ authority\ to\ the\ service\ account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) -\ \ \-\ These\ credentials\ are\ what\ rclone\ will\ use\ for\ authentication. -If\ you\ ever\ need\ to\ remove\ access,\ press\ the\ "Delete\ service -account\ key"\ button. - -#####\ 2.\ Allowing\ API\ access\ to\ example.com\ Google\ Drive\ ##### -\ \ \-\ Go\ to\ example.com\[aq]s\ admin\ console -\ \ \-\ Go\ into\ "Security"\ (or\ use\ the\ search\ bar) -\ \ \-\ Select\ "Show\ more"\ and\ then\ "Advanced\ settings" -\ \ \-\ Select\ "Manage\ API\ client\ access"\ in\ the\ "Authentication"\ section -\ \ \-\ In\ the\ "Client\ Name"\ field\ enter\ the\ service\ account\[aq]s -"Client\ ID"\ \-\ this\ can\ be\ found\ in\ the\ Developer\ Console\ under -"IAM\ &\ Admin"\ \->\ "Service\ Accounts",\ then\ "View\ Client\ ID"\ for -the\ newly\ created\ service\ account. -It\ is\ a\ ~21\ character\ numerical\ string. -\ \ \-\ In\ the\ next\ field,\ "One\ or\ More\ API\ Scopes",\ enter -`https://www.googleapis.com/auth/drive` -to\ grant\ access\ to\ Google\ Drive\ specifically. - -#####\ 3.\ Configure\ rclone,\ assuming\ a\ new\ install\ ##### -\f[] -.fi +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\[cq]s blog post on profiling go +programs (https://blog.golang.org/profiling-go-programs). .PP -rclone config +The profiling hook is zero overhead unless it is +used (https://stackoverflow.com/q/26545159/164234). +.SH Overview of cloud storage systems .PP -n/s/q> n # New name>gdrive # Gdrive is an example name Storage> # Select -the number shown for Google Drive client_id> # Can be left blank -client_secret> # Can be left blank scope> # Select your scope, 1 for -example root_folder_id> # Can be left blank service_account_file> -/home/foo/myJSONfile.json # This is where the JSON file goes! y/n> # -Auto config, y -.IP -.nf -\f[C] - -#####\ 4.\ Verify\ that\ it\[aq]s\ working\ ##### -\ \ \-\ `rclone\ \-v\ \-\-drive\-impersonate\ foo\@example.com\ lsf\ gdrive:backup` -\ \ \-\ The\ arguments\ do: -\ \ \ \ \-\ `\-v`\ \-\ verbose\ logging -\ \ \ \ \-\ `\-\-drive\-impersonate\ foo\@example.com`\ \-\ this\ is\ what\ does -the\ magic,\ pretending\ to\ be\ user\ foo. -\ \ \ \ \-\ `lsf`\ \-\ list\ files\ in\ a\ parsing\ friendly\ way -\ \ \ \ \-\ `gdrive:backup`\ \-\ use\ the\ remote\ called\ gdrive,\ work\ in -the\ folder\ named\ backup. - -###\ Team\ drives\ ### - -If\ you\ want\ to\ configure\ the\ remote\ to\ point\ to\ a\ Google\ Team\ Drive -then\ answer\ `y`\ to\ the\ question\ `Configure\ this\ as\ a\ team\ drive?`. - -This\ will\ fetch\ the\ list\ of\ Team\ Drives\ from\ google\ and\ allow\ you\ to -configure\ which\ one\ you\ want\ to\ use.\ \ You\ can\ also\ type\ in\ a\ team -drive\ ID\ if\ you\ prefer. - -For\ example: -\f[] -.fi +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 -Configure this as a team drive? -y) Yes n) No y/n> y Fetching team drive list\&... Choose a number from -below, or type in your own value 1 / Rclone Test -\ \[lq]xxxxxxxxxxxxxxxxxxxx\[rq] 2 / Rclone Test 2 -\ \[lq]yyyyyyyyyyyyyyyyyyyy\[rq] 3 / Rclone Test 3 -\ \[lq]zzzzzzzzzzzzzzzzzzzz\[rq] Enter a Team Drive ID> 1 -\[em]\[em]\[em]\[em]\[em]\[em]\[en] [remote] client_id = client_secret = -token = -{\[lq]AccessToken\[rq]:\[lq]xxxx.x.xxxxx_xxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]RefreshToken\[rq]:\[lq]1/xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxx\[rq],\[lq]Expiry\[rq]:\[lq]2014\-03\-16T13:57:58.955387075Z\[rq],\[lq]Extra\[rq]:null} -team_drive = xxxxxxxxxxxxxxxxxxxx \[em]\[em]\[em]\[em]\[em]\[em]\[en] y) -Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y -.IP -.nf -\f[C] - -###\ \-\-fast\-list\ ### - -This\ remote\ supports\ `\-\-fast\-list`\ which\ allows\ you\ to\ use\ fewer -transactions\ in\ exchange\ for\ more\ memory.\ See\ the\ [rclone -docs](/docs/#fast\-list)\ for\ more\ details. - -It\ does\ this\ by\ combining\ multiple\ `list`\ calls\ into\ a\ single\ API\ request. - -This\ works\ by\ combining\ many\ `\[aq]%s\[aq]\ in\ parents`\ filters\ into\ one\ expression. -To\ list\ the\ contents\ of\ directories\ a,\ b\ and\ c,\ the\ following\ requests\ will\ be\ send\ by\ the\ regular\ `List`\ function: -\f[] -.fi -.PP -trashed=false and `a' in parents trashed=false and `b' in parents -trashed=false and `c' in parents -.IP -.nf -\f[C] -These\ can\ now\ be\ combined\ into\ a\ single\ request: -\f[] -.fi -.PP -trashed=false and (`a' in parents or `b' in parents or `c' in parents) -.IP -.nf -\f[C] - -The\ implementation\ of\ `ListR`\ will\ put\ up\ to\ 50\ `parents`\ filters\ into\ one\ request. -It\ will\ \ use\ the\ `\-\-checkers`\ value\ to\ specify\ the\ number\ of\ requests\ to\ run\ in\ parallel. - -In\ tests,\ these\ batch\ requests\ were\ up\ to\ 20x\ faster\ than\ the\ regular\ method. -Running\ the\ following\ command\ against\ different\ sized\ folders\ gives: -\f[] -.fi -.PP -rclone lsjson \-vv \-R \[en]checkers=6 gdrive:folder -.IP -.nf -\f[C] - -small\ folder\ (220\ directories,\ 700\ files): - -\-\ without\ `\-\-fast\-list`:\ 38s -\-\ with\ `\-\-fast\-list`:\ 10s - -large\ folder\ (10600\ directories,\ 39000\ files): - -\-\ without\ `\-\-fast\-list`:\ 22:05\ min -\-\ with\ `\-\-fast\-list`:\ 58s - -###\ Modified\ time\ ### - -Google\ drive\ stores\ modification\ times\ accurate\ to\ 1\ ms. - -####\ Restricted\ filename\ characters - -Only\ Invalid\ UTF\-8\ bytes\ will\ be\ [replaced](/overview/#invalid\-utf8), -as\ they\ can\[aq]t\ be\ used\ in\ JSON\ strings. - -In\ contrast\ to\ other\ backends,\ `/`\ can\ also\ be\ used\ in\ names\ and\ `.` -or\ `..`\ are\ valid\ names. - -###\ Revisions\ ### - -Google\ drive\ stores\ revisions\ of\ files.\ \ When\ you\ upload\ a\ change\ to -an\ existing\ file\ to\ google\ drive\ using\ rclone\ it\ will\ create\ a\ new -revision\ of\ that\ file. - -Revisions\ follow\ the\ standard\ google\ policy\ which\ at\ time\ of\ writing -was - -\ \ *\ They\ are\ deleted\ after\ 30\ days\ or\ 100\ revisions\ (whatever\ comes\ first). -\ \ *\ They\ do\ not\ count\ towards\ a\ user\ storage\ quota. - -###\ Deleting\ files\ ### - -By\ default\ rclone\ will\ send\ all\ files\ to\ the\ trash\ when\ deleting -files.\ \ If\ deleting\ them\ permanently\ is\ required\ then\ use\ the -`\-\-drive\-use\-trash=false`\ flag,\ or\ set\ the\ equivalent\ environment -variable. - -###\ Emptying\ trash\ ### - -If\ you\ wish\ to\ empty\ your\ trash\ you\ can\ use\ the\ `rclone\ cleanup\ remote:` -command\ which\ will\ permanently\ delete\ all\ your\ trashed\ files.\ This\ command -does\ not\ take\ any\ path\ arguments. - -Note\ that\ Google\ Drive\ takes\ some\ time\ (minutes\ to\ days)\ to\ empty\ the -trash\ even\ though\ the\ command\ returns\ within\ a\ few\ seconds.\ \ No\ output -is\ echoed,\ so\ there\ will\ be\ no\ confirmation\ even\ using\ \-v\ or\ \-vv. - -###\ Quota\ information\ ### - -To\ view\ your\ current\ quota\ you\ can\ use\ the\ `rclone\ about\ remote:` -command\ which\ will\ display\ your\ usage\ limit\ (quota),\ the\ usage\ in\ Google -Drive,\ the\ size\ of\ all\ files\ in\ the\ Trash\ and\ the\ space\ used\ by\ other -Google\ services\ such\ as\ Gmail.\ This\ command\ does\ not\ take\ any\ path -arguments. - -####\ Import/Export\ of\ google\ documents\ #### - -Google\ documents\ can\ be\ exported\ from\ and\ uploaded\ to\ Google\ Drive. - -When\ rclone\ downloads\ a\ Google\ doc\ it\ chooses\ a\ format\ to\ download -depending\ upon\ the\ `\-\-drive\-export\-formats`\ setting. -By\ default\ the\ export\ formats\ are\ `docx,xlsx,pptx,svg`\ which\ are\ a -sensible\ default\ for\ an\ editable\ document. - -When\ choosing\ a\ format,\ rclone\ runs\ down\ the\ list\ provided\ in\ order -and\ chooses\ the\ first\ file\ format\ the\ doc\ can\ be\ exported\ as\ from\ the -list.\ If\ the\ file\ can\[aq]t\ be\ exported\ to\ a\ format\ on\ the\ formats\ list, -then\ rclone\ will\ choose\ a\ format\ from\ the\ default\ list. - -If\ you\ prefer\ an\ archive\ copy\ then\ you\ might\ use\ `\-\-drive\-export\-formats -pdf`,\ or\ if\ you\ prefer\ openoffice/libreoffice\ formats\ you\ might\ use -`\-\-drive\-export\-formats\ ods,odt,odp`. - -Note\ that\ rclone\ adds\ the\ extension\ to\ the\ google\ doc,\ so\ if\ it\ is -called\ `My\ Spreadsheet`\ on\ google\ docs,\ it\ will\ be\ exported\ as\ `My -Spreadsheet.xlsx`\ or\ `My\ Spreadsheet.pdf`\ etc. - -When\ importing\ files\ into\ Google\ Drive,\ rclone\ will\ convert\ all -files\ with\ an\ extension\ in\ `\-\-drive\-import\-formats`\ to\ their -associated\ document\ type. -rclone\ will\ not\ convert\ any\ files\ by\ default,\ since\ the\ conversion -is\ lossy\ process. - -The\ conversion\ must\ result\ in\ a\ file\ with\ the\ same\ extension\ when -the\ `\-\-drive\-export\-formats`\ rules\ are\ applied\ to\ the\ uploaded\ document. - -Here\ are\ some\ examples\ for\ allowed\ and\ prohibited\ conversions. - -|\ export\-formats\ |\ import\-formats\ |\ Upload\ Ext\ |\ Document\ Ext\ |\ Allowed\ | -|\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\ | -|\ odt\ |\ odt\ |\ odt\ |\ odt\ |\ Yes\ | -|\ odt\ |\ docx,odt\ |\ odt\ |\ odt\ |\ Yes\ | -|\ \ |\ docx\ |\ docx\ |\ docx\ |\ Yes\ | -|\ \ |\ odt\ |\ odt\ |\ docx\ |\ No\ | -|\ odt,docx\ |\ docx,odt\ |\ docx\ |\ odt\ |\ No\ | -|\ docx,odt\ |\ docx,odt\ |\ docx\ |\ docx\ |\ Yes\ | -|\ docx,odt\ |\ docx,odt\ |\ odt\ |\ docx\ |\ No\ | - -This\ limitation\ can\ be\ disabled\ by\ specifying\ `\-\-drive\-allow\-import\-name\-change`. -When\ using\ this\ flag,\ rclone\ can\ convert\ multiple\ files\ types\ resulting -in\ the\ same\ document\ type\ at\ once,\ eg\ with\ `\-\-drive\-import\-formats\ docx,odt,txt`, -all\ files\ having\ these\ extension\ would\ result\ in\ a\ document\ represented\ as\ a\ docx\ file. -This\ brings\ the\ additional\ risk\ of\ overwriting\ a\ document,\ if\ multiple\ files -have\ the\ same\ stem.\ Many\ rclone\ operations\ will\ not\ handle\ this\ name\ change -in\ any\ way.\ They\ assume\ an\ equal\ name\ when\ copying\ files\ and\ might\ copy\ the -file\ again\ or\ delete\ them\ when\ the\ name\ changes.\ - -Here\ are\ the\ possible\ export\ extensions\ with\ their\ corresponding\ mime\ types. -Most\ of\ these\ can\ also\ be\ used\ for\ importing,\ but\ there\ more\ that\ are\ not -listed\ here.\ Some\ of\ these\ additional\ ones\ might\ only\ be\ available\ when -the\ operating\ system\ provides\ the\ correct\ MIME\ type\ entries. - -This\ list\ can\ be\ changed\ by\ Google\ Drive\ at\ any\ time\ and\ might\ not -represent\ the\ currently\ available\ conversions. - -|\ Extension\ |\ Mime\ Type\ |\ Description\ | -|\ \-\-\-\-\-\-\-\-\-\ |\-\-\-\-\-\-\-\-\-\-\-|\ \-\-\-\-\-\-\-\-\-\-\-\-| -|\ csv\ \ |\ text/csv\ |\ Standard\ CSV\ format\ for\ Spreadsheets\ | -|\ docx\ |\ application/vnd.openxmlformats\-officedocument.wordprocessingml.document\ |\ Microsoft\ Office\ Document\ | -|\ epub\ |\ application/epub+zip\ |\ E\-book\ format\ | -|\ html\ |\ text/html\ |\ An\ HTML\ Document\ | -|\ jpg\ \ |\ image/jpeg\ |\ A\ JPEG\ Image\ File\ | -|\ json\ |\ application/vnd.google\-apps.script+json\ |\ JSON\ Text\ Format\ | -|\ odp\ \ |\ application/vnd.oasis.opendocument.presentation\ |\ Openoffice\ Presentation\ | -|\ ods\ \ |\ application/vnd.oasis.opendocument.spreadsheet\ |\ Openoffice\ Spreadsheet\ | -|\ ods\ \ |\ application/x\-vnd.oasis.opendocument.spreadsheet\ |\ Openoffice\ Spreadsheet\ | -|\ odt\ \ |\ application/vnd.oasis.opendocument.text\ |\ Openoffice\ Document\ | -|\ pdf\ \ |\ application/pdf\ |\ Adobe\ PDF\ Format\ | -|\ png\ \ |\ image/png\ |\ PNG\ Image\ Format| -|\ pptx\ |\ application/vnd.openxmlformats\-officedocument.presentationml.presentation\ |\ Microsoft\ Office\ Powerpoint\ | -|\ rtf\ \ |\ application/rtf\ |\ Rich\ Text\ Format\ | -|\ svg\ \ |\ image/svg+xml\ |\ Scalable\ Vector\ Graphics\ Format\ | -|\ tsv\ \ |\ text/tab\-separated\-values\ |\ Standard\ TSV\ format\ for\ spreadsheets\ | -|\ txt\ \ |\ text/plain\ |\ Plain\ Text\ | -|\ xlsx\ |\ application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet\ |\ Microsoft\ Office\ Spreadsheet\ | -|\ zip\ \ |\ application/zip\ |\ A\ ZIP\ file\ of\ HTML,\ Images\ CSS\ | - -Google\ documents\ can\ also\ be\ exported\ as\ link\ files.\ These\ files\ will -open\ a\ browser\ window\ for\ the\ Google\ Docs\ website\ of\ that\ document -when\ opened.\ The\ link\ file\ extension\ has\ to\ be\ specified\ as\ a -`\-\-drive\-export\-formats`\ parameter.\ They\ will\ match\ all\ available -Google\ Documents. - -|\ Extension\ |\ Description\ |\ OS\ Support\ | -|\ \-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\-\-\-\-\ |\ \-\-\-\-\-\-\-\-\-\-\ | -|\ desktop\ |\ freedesktop.org\ specified\ desktop\ entry\ |\ Linux\ | -|\ link.html\ |\ An\ HTML\ Document\ with\ a\ redirect\ |\ All\ | -|\ url\ |\ INI\ style\ link\ file\ |\ macOS,\ Windows\ | -|\ webloc\ |\ macOS\ specific\ XML\ format\ |\ macOS\ | - - -###\ Standard\ Options - -Here\ are\ the\ standard\ options\ specific\ to\ drive\ (Google\ Drive). - -####\ \-\-drive\-client\-id - -Google\ Application\ Client\ Id -Setting\ your\ own\ is\ recommended. -See\ https://rclone.org/drive/#making\-your\-own\-client\-id\ for\ how\ to\ create\ your\ own. -If\ you\ leave\ this\ blank,\ it\ will\ use\ an\ internal\ key\ which\ is\ low\ performance. - -\-\ Config:\ \ \ \ \ \ client_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_CLIENT_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-client\-secret - -Google\ Application\ Client\ Secret -Setting\ your\ own\ is\ recommended. - -\-\ Config:\ \ \ \ \ \ client_secret -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_CLIENT_SECRET -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-scope - -Scope\ that\ rclone\ should\ use\ when\ requesting\ access\ from\ drive. - -\-\ Config:\ \ \ \ \ \ scope -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SCOPE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" -\-\ Examples: -\ \ \ \ \-\ "drive" -\ \ \ \ \ \ \ \ \-\ Full\ access\ all\ files,\ excluding\ Application\ Data\ Folder. -\ \ \ \ \-\ "drive.readonly" -\ \ \ \ \ \ \ \ \-\ Read\-only\ access\ to\ file\ metadata\ and\ file\ contents. -\ \ \ \ \-\ "drive.file" -\ \ \ \ \ \ \ \ \-\ Access\ to\ files\ created\ by\ rclone\ only. -\ \ \ \ \ \ \ \ \-\ These\ are\ visible\ in\ the\ drive\ website. -\ \ \ \ \ \ \ \ \-\ File\ authorization\ is\ revoked\ when\ the\ user\ deauthorizes\ the\ app. -\ \ \ \ \-\ "drive.appfolder" -\ \ \ \ \ \ \ \ \-\ Allows\ read\ and\ write\ access\ to\ the\ Application\ Data\ folder. -\ \ \ \ \ \ \ \ \-\ This\ is\ not\ visible\ in\ the\ drive\ website. -\ \ \ \ \-\ "drive.metadata.readonly" -\ \ \ \ \ \ \ \ \-\ Allows\ read\-only\ access\ to\ file\ metadata\ but -\ \ \ \ \ \ \ \ \-\ does\ not\ allow\ any\ access\ to\ read\ or\ download\ file\ content. - -####\ \-\-drive\-root\-folder\-id - -ID\ of\ the\ root\ folder -Leave\ blank\ normally. - -Fill\ in\ to\ access\ "Computers"\ folders\ (see\ docs),\ or\ for\ rclone\ to\ use -a\ non\ root\ folder\ as\ its\ starting\ point. - -Note\ that\ if\ this\ is\ blank,\ the\ first\ time\ rclone\ runs\ it\ will\ fill\ it -in\ with\ the\ ID\ of\ the\ root\ folder. - - -\-\ Config:\ \ \ \ \ \ root_folder_id -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_ROOT_FOLDER_ID -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-service\-account\-file - -Service\ Account\ Credentials\ JSON\ file\ path\ -Leave\ blank\ normally. -Needed\ only\ if\ you\ want\ use\ SA\ instead\ of\ interactive\ login. - -\-\ Config:\ \ \ \ \ \ service_account_file -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SERVICE_ACCOUNT_FILE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -###\ Advanced\ Options - -Here\ are\ the\ advanced\ options\ specific\ to\ drive\ (Google\ Drive). - -####\ \-\-drive\-service\-account\-credentials - -Service\ Account\ Credentials\ JSON\ blob -Leave\ blank\ normally. -Needed\ only\ if\ you\ want\ use\ SA\ instead\ of\ interactive\ login. - -\-\ Config:\ \ \ \ \ \ service_account_credentials -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-team\-drive - -ID\ of\ the\ Team\ Drive - -\-\ Config:\ \ \ \ \ \ team_drive -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_TEAM_DRIVE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-auth\-owner\-only - -Only\ consider\ files\ owned\ by\ the\ authenticated\ user. - -\-\ Config:\ \ \ \ \ \ auth_owner_only -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_AUTH_OWNER_ONLY -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-use\-trash - -Send\ files\ to\ the\ trash\ instead\ of\ deleting\ permanently. -Defaults\ to\ true,\ namely\ sending\ files\ to\ the\ trash. -Use\ `\-\-drive\-use\-trash=false`\ to\ delete\ files\ permanently\ instead. - -\-\ Config:\ \ \ \ \ \ use_trash -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_USE_TRASH -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ true - -####\ \-\-drive\-skip\-gdocs - -Skip\ google\ documents\ in\ all\ listings. -If\ given,\ gdocs\ practically\ become\ invisible\ to\ rclone. - -\-\ Config:\ \ \ \ \ \ skip_gdocs -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SKIP_GDOCS -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-skip\-checksum\-gphotos - -Skip\ MD5\ checksum\ on\ Google\ photos\ and\ videos\ only. - -Use\ this\ if\ you\ get\ checksum\ errors\ when\ transferring\ Google\ photos\ or -videos. - -Setting\ this\ flag\ will\ cause\ Google\ photos\ and\ videos\ to\ return\ a -blank\ MD5\ checksum. - -Google\ photos\ are\ identifed\ by\ being\ in\ the\ "photos"\ space. - -Corrupted\ checksums\ are\ caused\ by\ Google\ modifying\ the\ image/video\ but -not\ updating\ the\ checksum. - -\-\ Config:\ \ \ \ \ \ skip_checksum_gphotos -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-shared\-with\-me - -Only\ show\ files\ that\ are\ shared\ with\ me. - -Instructs\ rclone\ to\ operate\ on\ your\ "Shared\ with\ me"\ folder\ (where -Google\ Drive\ lets\ you\ access\ the\ files\ and\ folders\ others\ have\ shared -with\ you). - -This\ works\ both\ with\ the\ "list"\ (lsd,\ lsl,\ etc)\ and\ the\ "copy" -commands\ (copy,\ sync,\ etc),\ and\ with\ all\ other\ commands\ too. - -\-\ Config:\ \ \ \ \ \ shared_with_me -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SHARED_WITH_ME -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-trashed\-only - -Only\ show\ files\ that\ are\ in\ the\ trash. -This\ will\ show\ trashed\ files\ in\ their\ original\ directory\ structure. - -\-\ Config:\ \ \ \ \ \ trashed_only -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_TRASHED_ONLY -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-formats - -Deprecated:\ see\ export_formats - -\-\ Config:\ \ \ \ \ \ formats -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_FORMATS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-export\-formats - -Comma\ separated\ list\ of\ preferred\ formats\ for\ downloading\ Google\ docs. - -\-\ Config:\ \ \ \ \ \ export_formats -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_EXPORT_FORMATS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "docx,xlsx,pptx,svg" - -####\ \-\-drive\-import\-formats - -Comma\ separated\ list\ of\ preferred\ formats\ for\ uploading\ Google\ docs. - -\-\ Config:\ \ \ \ \ \ import_formats -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_IMPORT_FORMATS -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-allow\-import\-name\-change - -Allow\ the\ filetype\ to\ change\ when\ uploading\ Google\ docs\ (e.g.\ file.doc\ to\ file.docx).\ This\ will\ confuse\ sync\ and\ reupload\ every\ time. - -\-\ Config:\ \ \ \ \ \ allow_import_name_change -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-use\-created\-date - -Use\ file\ created\ date\ instead\ of\ modified\ date., - -Useful\ when\ downloading\ data\ and\ you\ want\ the\ creation\ date\ used\ in -place\ of\ the\ last\ modified\ date. - -**WARNING**:\ This\ flag\ may\ have\ some\ unexpected\ consequences. - -When\ uploading\ to\ your\ drive\ all\ files\ will\ be\ overwritten\ unless\ they -haven\[aq]t\ been\ modified\ since\ their\ creation.\ And\ the\ inverse\ will\ occur -while\ downloading.\ \ This\ side\ effect\ can\ be\ avoided\ by\ using\ the -"\-\-checksum"\ flag. - -This\ feature\ was\ implemented\ to\ retain\ photos\ capture\ date\ as\ recorded -by\ google\ photos.\ You\ will\ first\ need\ to\ check\ the\ "Create\ a\ Google -Photos\ folder"\ option\ in\ your\ google\ drive\ settings.\ You\ can\ then\ copy -or\ move\ the\ photos\ locally\ and\ use\ the\ date\ the\ image\ was\ taken -(created)\ set\ as\ the\ modification\ date. - -\-\ Config:\ \ \ \ \ \ use_created_date -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_USE_CREATED_DATE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-list\-chunk - -Size\ of\ listing\ chunk\ 100\-1000.\ 0\ to\ disable. - -\-\ Config:\ \ \ \ \ \ list_chunk -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_LIST_CHUNK -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 1000 - -####\ \-\-drive\-impersonate - -Impersonate\ this\ user\ when\ using\ a\ service\ account. - -\-\ Config:\ \ \ \ \ \ impersonate -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_IMPERSONATE -\-\ Type:\ \ \ \ \ \ \ \ string -\-\ Default:\ \ \ \ \ "" - -####\ \-\-drive\-alternate\-export - -Use\ alternate\ export\ URLs\ for\ google\ documents\ export., - -If\ this\ option\ is\ set\ this\ instructs\ rclone\ to\ use\ an\ alternate\ set\ of -export\ URLs\ for\ drive\ documents.\ \ Users\ have\ reported\ that\ the -official\ export\ URLs\ can\[aq]t\ export\ large\ documents,\ whereas\ these -unofficial\ ones\ can. - -See\ rclone\ issue\ [#2243](https://github.com/rclone/rclone/issues/2243)\ for\ background, -[this\ google\ drive\ issue](https://issuetracker.google.com/issues/36761333)\ and -[this\ helpful\ post](https://www.labnol.org/internet/direct\-links\-for\-google\-drive/28356/). - -\-\ Config:\ \ \ \ \ \ alternate_export -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_ALTERNATE_EXPORT -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-upload\-cutoff - -Cutoff\ for\ switching\ to\ chunked\ upload - -\-\ Config:\ \ \ \ \ \ upload_cutoff -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_UPLOAD_CUTOFF -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 8M - -####\ \-\-drive\-chunk\-size - -Upload\ chunk\ size.\ Must\ a\ power\ of\ 2\ >=\ 256k. - -Making\ this\ larger\ will\ improve\ performance,\ but\ note\ that\ each\ chunk -is\ buffered\ in\ memory\ one\ per\ transfer. - -Reducing\ this\ will\ reduce\ memory\ usage\ but\ decrease\ performance. - -\-\ Config:\ \ \ \ \ \ chunk_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_CHUNK_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ 8M - -####\ \-\-drive\-acknowledge\-abuse - -Set\ to\ allow\ files\ which\ return\ cannotDownloadAbusiveFile\ to\ be\ downloaded. - -If\ downloading\ a\ file\ returns\ the\ error\ "This\ file\ has\ been\ identified -as\ malware\ or\ spam\ and\ cannot\ be\ downloaded"\ with\ the\ error\ code -"cannotDownloadAbusiveFile"\ then\ supply\ this\ flag\ to\ rclone\ to -indicate\ you\ acknowledge\ the\ risks\ of\ downloading\ the\ file\ and\ rclone -will\ download\ it\ anyway. - -\-\ Config:\ \ \ \ \ \ acknowledge_abuse -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_ACKNOWLEDGE_ABUSE -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-keep\-revision\-forever - -Keep\ new\ head\ revision\ of\ each\ file\ forever. - -\-\ Config:\ \ \ \ \ \ keep_revision_forever -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_KEEP_REVISION_FOREVER -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-size\-as\-quota - -Show\ storage\ quota\ usage\ for\ file\ size. - -The\ storage\ used\ by\ a\ file\ is\ the\ size\ of\ the\ current\ version\ plus\ any -older\ versions\ that\ have\ been\ set\ to\ keep\ forever. - -\-\ Config:\ \ \ \ \ \ size_as_quota -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SIZE_AS_QUOTA -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-v2\-download\-min\-size - -If\ Object\[aq]s\ are\ greater,\ use\ drive\ v2\ API\ to\ download. - -\-\ Config:\ \ \ \ \ \ v2_download_min_size -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE -\-\ Type:\ \ \ \ \ \ \ \ SizeSuffix -\-\ Default:\ \ \ \ \ off - -####\ \-\-drive\-pacer\-min\-sleep - -Minimum\ time\ to\ sleep\ between\ API\ calls. - -\-\ Config:\ \ \ \ \ \ pacer_min_sleep -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_PACER_MIN_SLEEP -\-\ Type:\ \ \ \ \ \ \ \ Duration -\-\ Default:\ \ \ \ \ 100ms - -####\ \-\-drive\-pacer\-burst - -Number\ of\ API\ calls\ to\ allow\ without\ sleeping. - -\-\ Config:\ \ \ \ \ \ pacer_burst -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_PACER_BURST -\-\ Type:\ \ \ \ \ \ \ \ int -\-\ Default:\ \ \ \ \ 100 - -####\ \-\-drive\-server\-side\-across\-configs - -Allow\ server\ side\ operations\ (eg\ copy)\ to\ work\ across\ different\ drive\ configs. - -This\ can\ be\ useful\ if\ you\ wish\ to\ do\ a\ server\ side\ copy\ between\ two -different\ Google\ drives.\ \ Note\ that\ this\ isn\[aq]t\ enabled\ by\ default -because\ it\ isn\[aq]t\ easy\ to\ tell\ if\ it\ will\ work\ between\ any\ two -configurations. - -\-\ Config:\ \ \ \ \ \ server_side_across_configs -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_SERVER_SIDE_ACROSS_CONFIGS -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ false - -####\ \-\-drive\-disable\-http2 - -Disable\ drive\ using\ http2 - -There\ is\ currently\ an\ unsolved\ issue\ with\ the\ google\ drive\ backend\ and -HTTP/2.\ \ HTTP/2\ is\ therefore\ disabled\ by\ default\ for\ the\ drive\ backend -but\ can\ be\ re\-enabled\ here.\ \ When\ the\ issue\ is\ solved\ this\ flag\ will -be\ removed. - -See:\ https://github.com/rclone/rclone/issues/3631 - - - -\-\ Config:\ \ \ \ \ \ disable_http2 -\-\ Env\ Var:\ \ \ \ \ RCLONE_DRIVE_DISABLE_HTTP2 -\-\ Type:\ \ \ \ \ \ \ \ bool -\-\ Default:\ \ \ \ \ true - - - -###\ Limitations\ ### - -Drive\ has\ quite\ a\ lot\ of\ rate\ limiting.\ \ This\ causes\ rclone\ to\ be -limited\ to\ transferring\ about\ 2\ files\ per\ second\ only.\ \ Individual -files\ may\ be\ transferred\ much\ faster\ at\ 100s\ of\ MBytes/s\ but\ lots\ of -small\ files\ can\ take\ a\ long\ time. - -Server\ side\ copies\ are\ also\ subject\ to\ a\ separate\ rate\ limit.\ If\ you -see\ User\ rate\ limit\ exceeded\ errors,\ wait\ at\ least\ 24\ hours\ and\ retry. -You\ can\ disable\ server\ side\ copies\ with\ `\-\-disable\ copy`\ to\ download -and\ upload\ the\ files\ if\ you\ prefer. - -####\ Limitations\ of\ Google\ Docs\ #### - -Google\ docs\ will\ appear\ as\ size\ \-1\ in\ `rclone\ ls`\ and\ as\ size\ 0\ in -anything\ which\ uses\ the\ VFS\ layer,\ eg\ `rclone\ mount`,\ `rclone\ serve`. - -This\ is\ because\ rclone\ can\[aq]t\ find\ out\ the\ size\ of\ the\ Google\ docs -without\ downloading\ them. - -Google\ docs\ will\ transfer\ correctly\ with\ `rclone\ sync`,\ `rclone\ copy` -etc\ as\ rclone\ knows\ to\ ignore\ the\ size\ when\ doing\ the\ transfer. - -However\ an\ unfortunate\ consequence\ of\ this\ is\ that\ you\ may\ not\ be\ able -to\ download\ Google\ docs\ using\ `rclone\ mount`.\ If\ it\ doesn\[aq]t\ work\ you -will\ get\ a\ 0\ sized\ file.\ \ If\ you\ try\ again\ the\ doc\ may\ gain\ its -correct\ size\ and\ be\ downloadable.\ Whther\ it\ will\ work\ on\ not\ depends -on\ the\ application\ accessing\ the\ mount\ and\ the\ OS\ you\ are\ running\ \- -experiment\ to\ find\ out\ if\ it\ does\ work\ for\ you! - -###\ Duplicated\ files\ ### - -Sometimes,\ for\ no\ reason\ I\[aq]ve\ been\ able\ to\ track\ down,\ drive\ will -duplicate\ a\ file\ that\ rclone\ uploads.\ \ Drive\ unlike\ all\ the\ other -remotes\ can\ have\ duplicated\ files. - -Duplicated\ files\ cause\ problems\ with\ the\ syncing\ and\ you\ will\ see -messages\ in\ the\ log\ about\ duplicates. - -Use\ `rclone\ dedupe`\ to\ fix\ duplicated\ files. - -Note\ that\ this\ isn\[aq]t\ just\ a\ problem\ with\ rclone,\ even\ Google\ Photos\ on -Android\ duplicates\ files\ on\ drive\ sometimes. - -###\ Rclone\ appears\ to\ be\ re\-copying\ files\ it\ shouldn\[aq]t\ ### - -The\ most\ likely\ cause\ of\ this\ is\ the\ duplicated\ file\ issue\ above\ \-\ run -`rclone\ dedupe`\ and\ check\ your\ logs\ for\ duplicate\ object\ or\ directory -messages. - -This\ can\ also\ be\ caused\ by\ a\ delay/caching\ on\ google\ drive\[aq]s\ end\ when -comparing\ directory\ listings.\ Specifically\ with\ team\ drives\ used\ in -combination\ with\ \-\-fast\-list.\ Files\ that\ were\ uploaded\ recently\ may -not\ appear\ on\ the\ directory\ list\ sent\ to\ rclone\ when\ using\ \-\-fast\-list. - -Waiting\ a\ moderate\ period\ of\ time\ between\ attempts\ (estimated\ to\ be -approximately\ 1\ hour)\ and/or\ not\ using\ \-\-fast\-list\ both\ seem\ to\ be -effective\ in\ preventing\ the\ problem. - -###\ Making\ your\ own\ client_id\ ### - -When\ you\ use\ rclone\ with\ Google\ drive\ in\ its\ default\ configuration\ you -are\ using\ rclone\[aq]s\ client_id.\ \ This\ is\ shared\ between\ all\ the\ rclone -users.\ \ There\ is\ a\ global\ rate\ limit\ on\ the\ number\ of\ queries\ per -second\ that\ each\ client_id\ can\ do\ set\ by\ Google.\ \ rclone\ already\ has\ a -high\ quota\ and\ I\ will\ continue\ to\ make\ sure\ it\ is\ high\ enough\ by -contacting\ Google. - -It\ is\ strongly\ recommended\ to\ use\ your\ own\ client\ ID\ as\ the\ default\ rclone\ ID\ is\ heavily\ used.\ If\ you\ have\ multiple\ services\ running,\ it\ is\ recommended\ to\ use\ an\ API\ key\ for\ each\ service.\ The\ default\ Google\ quota\ is\ 10\ transactions\ per\ second\ so\ it\ is\ recommended\ to\ stay\ under\ that\ number\ as\ if\ you\ use\ more\ than\ that,\ it\ will\ cause\ rclone\ to\ rate\ limit\ and\ make\ things\ slower. - -Here\ is\ how\ to\ create\ your\ own\ Google\ Drive\ client\ ID\ for\ rclone: - -1.\ Log\ into\ the\ [Google\ API -Console](https://console.developers.google.com/)\ with\ your\ Google -account.\ It\ doesn\[aq]t\ matter\ what\ Google\ account\ you\ use.\ (It\ need\ not -be\ the\ same\ account\ as\ the\ Google\ Drive\ you\ want\ to\ access) - -2.\ Select\ a\ project\ or\ create\ a\ new\ project. - -3.\ Under\ "ENABLE\ APIS\ AND\ SERVICES"\ search\ for\ "Drive",\ and\ enable\ the -"Google\ Drive\ API". - -4.\ Click\ "Credentials"\ in\ the\ left\-side\ panel\ (not\ "Create -credentials",\ which\ opens\ the\ wizard),\ then\ "Create\ credentials",\ then -"OAuth\ client\ ID".\ \ It\ will\ prompt\ you\ to\ set\ the\ OAuth\ consent\ screen -product\ name,\ if\ you\ haven\[aq]t\ set\ one\ already. - -5.\ Choose\ an\ application\ type\ of\ "other",\ and\ click\ "Create".\ (the -default\ name\ is\ fine) - -6.\ It\ will\ show\ you\ a\ client\ ID\ and\ client\ secret.\ \ Use\ these\ values -in\ rclone\ config\ to\ add\ a\ new\ remote\ or\ edit\ an\ existing\ remote. - -(Thanks\ to\ \@balazer\ on\ github\ for\ these\ instructions.) - -Google\ Photos -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- - -The\ rclone\ backend\ for\ [Google\ Photos](https://www.google.com/photos/about/)\ is -a\ specialized\ backend\ for\ transferring\ photos\ and\ videos\ to\ and\ from -Google\ Photos. - -**NB**\ The\ Google\ Photos\ API\ which\ rclone\ uses\ has\ quite\ a\ few -limitations,\ so\ please\ read\ the\ [limitations\ section](#limitations) -carefully\ to\ make\ sure\ it\ is\ suitable\ for\ your\ use. - -##\ Configuring\ Google\ Photos - -The\ initial\ setup\ for\ google\ cloud\ storage\ involves\ getting\ a\ token\ from\ Google\ Photos -which\ you\ need\ to\ do\ in\ your\ browser.\ \ `rclone\ config`\ walks\ you -through\ it. - -Here\ is\ an\ example\ of\ how\ to\ make\ a\ remote\ called\ `remote`.\ \ First\ run: - -\ \ \ \ \ rclone\ config - -This\ will\ guide\ you\ through\ an\ interactive\ setup\ process: -\f[] -.fi -.PP -No remotes found \- make a new one n) New remote s) Set configuration -password q) Quit config n/s/q> n name> remote Type of storage to -configure. -Enter a string value. -Press Enter for the default ("\[lq]). Choose a number from below, or -type in your own value [snip] XX / Google Photos \ \[rq]google photos" -[snip] Storage> google photos ** See help for google photos backend at: -https://rclone.org/googlephotos/ ** -.PP -Google Application Client Id Leave blank normally. -Enter a string value. -Press Enter for the default ("\[lq]). client_id> Google Application -Client Secret Leave blank normally. Enter a string value. Press Enter -for the default (\[rq]"). -client_secret> Set to make the Google Photos backend read only. -.PP -If you choose read only then rclone will only request read only access -to your photos, otherwise rclone will request full access. -Enter a boolean value (true or false). -Press Enter for the default (\[lq]false\[rq]). -read_only> Edit advanced config? -(y/n) y) Yes n) No y/n> n Remote config Use auto config? -* Say Y if not sure * Say N if you are working on a remote or headless -machine y) Yes n) No y/n> y If your browser doesn't open automatically -go to the following link: http://127.0.0.1:53682/auth Log in and -authorize rclone for access Waiting for code\&... Got code -.PP -*** IMPORTANT: All media items uploaded to Google Photos with rclone *** -are stored in full resolution at original quality. -These uploads *** will count towards storage in your Google Account. +Here is an overview of the major features of each cloud storage system. .PP .TS tab(@); -lw(20.4n). +l c c c c c. T{ -[remote] type = google photos token = -{\[lq]access_token\[rq]:\[lq]XXX\[rq],\[lq]token_type\[rq]:\[lq]Bearer\[rq],\[lq]refresh_token\[rq]:\[lq]XXX\[rq],\[lq]expiry\[rq]:\[lq]2019\-06\-28T17:38:04.644930156+01:00\[rq]} +Name +T}@T{ +Hash +T}@T{ +ModTime +T}@T{ +Case Insensitive +T}@T{ +Duplicate Files +T}@T{ +MIME Type T} _ T{ -y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y ``` -T} -T{ -Note that rclone runs a webserver on your local machine to collect the -token as returned from Google if you use auto config mode. -This only runs from the moment it opens your browser to the moment you -get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this may require you to -unblock it temporarily if you are running a host firewall, or use manual -mode. -T} -T{ -This remote is called \f[C]remote\f[] and can now be used like this -T} -T{ -See all the albums in your photos -T} -T{ -rclone lsd remote:album -T} -T{ -Make a new album -T} -T{ -rclone mkdir remote:album/newAlbum -T} -T{ -List the contents of an album -T} -T{ -rclone ls remote:album/newAlbum -T} -T{ -Sync \f[C]/home/local/images\f[] to the Google Photos, removing any -excess files in the album. -T} -T{ -rclone sync /home/local/image remote:album/newAlbum -T} -T{ -## Layout -T} -T{ -As Google Photos is not a general purpose cloud storage system the -backend is laid out to help you navigate it. -T} -T{ -The directories under \f[C]media\f[] 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 \f[C]remote:media/by\-month\f[]. -(\f[B]NB\f[] \f[C]remote:media/by\-day\f[] is rather slow at the moment -so avoid for syncing.) -T} -T{ -Note that all your photos and videos will appear somewhere under -\f[C]media\f[], but they may not appear under \f[C]album\f[] unless -you've put them into albums. -T} -T{ -\f[C]/\ \-\ upload\ \-\ file1.jpg\ \-\ file2.jpg\ \-\ ...\ \-\ media\ \-\ all\ \-\ file1.jpg\ \-\ file2.jpg\ \-\ ...\ \-\ by\-year\ \-\ 2000\ \-\ file1.jpg\ \-\ ...\ \-\ 2001\ \-\ file2.jpg\ \-\ ...\ \-\ ...\ \-\ by\-month\ \-\ 2000\ \-\ 2000\-01\ \-\ file1.jpg\ \-\ ...\ \-\ 2000\-02\ \-\ file2.jpg\ \-\ ...\ \-\ ...\ \-\ by\-day\ \-\ 2000\ \-\ 2000\-01\-01\ \-\ file1.jpg\ \-\ ...\ \-\ 2000\-01\-02\ \-\ file2.jpg\ \-\ ...\ \-\ ...\ \-\ album\ \-\ album\ name\ \-\ album\ name/sub\ \-\ shared\-album\ \-\ album\ name\ \-\ album\ name/sub\f[] -T} -T{ -There are two writable parts of the tree, the \f[C]upload\f[] directory -and sub directories of the the \f[C]album\f[] directory. -T} -T{ -The \f[C]upload\f[] directory is for uploading files you don't want to -put into albums. -This will be empty to start with and will contain the files you've -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 \f[C]album\f[] will work better. -T} -T{ -Directories within the \f[C]album\f[] directory are also writeable and -you may create new directories (albums) under \f[C]album\f[]. -If you copy files with a directory hierarchy in there then rclone will -create albums with the \f[C]/\f[] character in them. -For example if you do -T} -T{ -rclone copy /path/to/images remote:album/images -T} -T{ -and the images directory contains -T} -T{ -\f[C]images\ \-\ file1.jpg\ dir\ file2.jpg\ dir2\ dir3\ file3.jpg\f[] -T} -T{ -Then rclone will create the following albums with the following files in -T} -T{ -\- images \- file1.jpg \- images/dir \- file2.jpg \- images/dir2/dir3 \- -file3.jpg -T} -T{ -This means that you can use the \f[C]album\f[] path pretty much like a -normal filesystem and it is a good target for repeated syncing. -T} -T{ -The \f[C]shared\-album\f[] directory shows albums shared with you or by -you. -This is similar to the Sharing tab in the Google Photos web interface. -T} -T{ -## Limitations -T} -T{ -Only images and videos can be uploaded. -If you attempt to upload non videos or images or formats that Google -Photos doesn't understand, rclone will upload the file, then Google -Photos will give an error when it is put turned into a media item. -T} -T{ -Note that all media items uploaded to Google Photos through the API are -stored in full resolution at \[lq]original quality\[rq] and -\f[B]will\f[] count towards your storage quota in your Google Account. -The API does \f[B]not\f[] offer a way to upload in \[lq]high -quality\[rq] mode.. -T} -T{ -### Downloading Images -T} -T{ -When Images are downloaded this strips EXIF location (according to the -docs and my tests). -This is a limitation of the Google Photos API and is covered by bug -#112096115 (https://issuetracker.google.com/issues/112096115). -T} -T{ -\f[B]The current google API does not allow photos to be downloaded at -original resolution. This is very important if you are, for example, -relying on \[lq]Google Photos\[rq] as a backup of your photos. You will -not be able to use rclone to redownload original images. You could use -`google takeout' to recover the original photos as a last resort\f[] -T} -T{ -### Downloading Videos -T} -T{ -When videos are downloaded they are downloaded in a really compressed -version of the video compared to downloading it via the Google Photos -web interface. -This is covered by bug -#113672044 (https://issuetracker.google.com/issues/113672044). -T} -T{ -### Duplicates -T} -T{ -If a file name is duplicated in a directory then rclone will add the -file ID into its name. -So two files called \f[C]file.jpg\f[] would then appear as -\f[C]file\ {123456}.jpg\f[] and \f[C]file\ {ABCDEF}.jpg\f[] (the actual -IDs are a lot longer alas!). -T} -T{ -If you upload the same image (with the same binary data) twice then -Google Photos will deduplicate it. -However it will retain the filename from the first upload which may -confuse rclone. -For example if you uploaded an image to \f[C]upload\f[] then uploaded -the same image to \f[C]album/my_album\f[] the filename of the image in -\f[C]album/my_album\f[] will be what it was uploaded with initially, not -what you uploaded it with to \f[C]album\f[]. -In practise this shouldn't cause too many problems. -T} -T{ -### Modified time -T} -T{ -The date shown of media in Google Photos is the creation date as -determined by the EXIF information, or the upload date if that is not -known. -T} -T{ -This is not changeable by rclone and is not the modification date of the -media on local disk. -This means that rclone cannot use the dates from Google Photos for -syncing purposes. -T} -T{ -### Size -T} -T{ -The Google Photos API does not return the size of media. -This means that when syncing to Google Photos, rclone can only do a file -existence check. -T} -T{ -It is possible to read the size of the media, but this needs an extra -HTTP HEAD request per media item so is \f[B]very slow\f[] and uses up a -lot of transactions. -This can be enabled with the \f[C]\-\-gphotos\-read\-size\f[] option or -the \f[C]read_size\ =\ true\f[] config parameter. -T} -T{ -If you want to use the backend with \f[C]rclone\ mount\f[] you may need -to enable this flag (depending on your OS and application using the -photos) otherwise you may not be able to read media off the mount. -You'll need to experiment to see if it works for you without the flag. -T} -T{ -### Albums -T} -T{ -Rclone can only upload files to albums it created. -This is a limitation of the Google Photos -API (https://developers.google.com/photos/library/guides/manage-albums). -T} -T{ -Rclone can remove files it uploaded from albums it created only. -T} -T{ -### Deleting files -T} -T{ -Rclone can remove files from albums it created, but note that the Google -Photos API does not allow media to be deleted permanently so this media -will still remain. -See bug #109759781 (https://issuetracker.google.com/issues/109759781). -T} -T{ -Rclone cannot delete files anywhere except under \f[C]album\f[]. -T} -T{ -### Deleting albums -T} -T{ -The Google Photos API does not support deleting albums \- see bug -#135714733 (https://issuetracker.google.com/issues/135714733). -T} -T{ - ### Standard Options -T} -T{ -Here are the standard options specific to google photos (Google Photos). -T} -T{ -#### \[en]gphotos\-client\-id -T} -T{ -Google Application Client Id Leave blank normally. -T} -T{ -\- Config: client_id \- Env Var: RCLONE_GPHOTOS_CLIENT_ID \- Type: -string \- Default: "" -T} -T{ -#### \[en]gphotos\-client\-secret -T} -T{ -Google Application Client Secret Leave blank normally. -T} -T{ -\- Config: client_secret \- Env Var: RCLONE_GPHOTOS_CLIENT_SECRET \- -Type: string \- Default: "" -T} -T{ -#### \[en]gphotos\-read\-only -T} -T{ -Set to make the Google Photos backend read only. -T} -T{ -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{ -Here are the advanced options specific to google photos (Google Photos). -T} -T{ -#### \[en]gphotos\-read\-size -T} -T{ -Set to read the size of media items. -T} -T{ -Normally rclone does not read the size of media items since this takes -another transaction. -This isn't necessary for syncing. -However rclone mount needs to know the size of files in advance of -reading them, so setting this flag when using rclone mount is -recommended if you want to read the media. -T} -T{ -\- Config: read_size \- Env Var: RCLONE_GPHOTOS_READ_SIZE \- Type: bool -\- Default: false -T} -T{ +1Fichier +T}@T{ +Whirlpool +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +Amazon Drive +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +Amazon S3 +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Backblaze B2 +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Box +T}@T{ +SHA1 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Citrix ShareFile +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Dropbox +T}@T{ +DBHASH \[dg] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +FTP +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Google Cloud Storage +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Google Drive +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +R/W +T} +T{ +Google Photos +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +R T} T{ HTTP +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +R +T} +T{ +Hubic +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Jottacloud +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R/W +T} +T{ +Koofr +T}@T{ +MD5 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mail.ru Cloud +T}@T{ +Mailru \[dd]\[dd]\[dd] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Mega +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +\- +T} +T{ +Memory +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +Microsoft Azure Blob Storage +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +Microsoft OneDrive +T}@T{ +SHA1 \[dd]\[dd] +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +OpenDrive +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +\- +T} +T{ +Openstack Swift +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +pCloud +T}@T{ +MD5, SHA1 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +W +T} +T{ +premiumize.me +T}@T{ +\- +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +R +T} +T{ +put.io +T}@T{ +CRC\-32 +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +R +T} +T{ +QingStor +T}@T{ +MD5 +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +SFTP +T}@T{ +MD5, SHA1 \[dd] +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +T{ +SugarSync +T}@T{ +\- +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +\- +T} +T{ +WebDAV +T}@T{ +MD5, SHA1 \[dg]\[dg] +T}@T{ +Yes \[dg]\[dg]\[dg] +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +T{ +Yandex Disk +T}@T{ +MD5 +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +R/W +T} +T{ +The local filesystem +T}@T{ +All +T}@T{ +Yes +T}@T{ +Depends +T}@T{ +No +T}@T{ +\- +T} +.TE +.SS Hash +.PP +The cloud storage system supports various hash types of the objects. +The hashes are used when transferring data as an integrity check and can +be specifically used with the \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. +.PP +\[dg] Note that Dropbox supports its own custom +hash (https://www.dropbox.com/developers/reference/content-hash). +This is an SHA256 sum of all the 4MB block SHA256s. +.PP +\[dd] SFTP supports checksums if the same login has shell access and +\f[C]md5sum\f[R] or \f[C]sha1sum\f[R] as well as \f[C]echo\f[R] are in +the remote\[cq]s PATH. +.PP +\[dg]\[dg] WebDAV supports hashes when used with Owncloud and Nextcloud +only. +.PP +\[dg]\[dg]\[dg] WebDAV supports modtimes when used with Owncloud and +Nextcloud only. +.PP +\[dd]\[dd] Microsoft OneDrive Personal supports SHA1 hashes, whereas +OneDrive for business and SharePoint server support Microsoft\[cq]s own +QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). +.PP +\[dd]\[dd]\[dd] Mail.ru uses its own modified SHA1 hash +.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. +.SS Case Insensitive +.PP +If a cloud storage systems is case sensitive then it is possible to have +two files which differ only in case, eg \f[C]file.txt\f[R] and +\f[C]FILE.txt\f[R]. +If a cloud storage system is case insensitive then that isn\[cq]t +possible. +.PP +This can cause problems when syncing between a case insensitive system +and a case sensitive system. +The symptom of this is that no matter how many times you run the sync it +never completes fully. +.PP +The local filesystem and SFTP may or may not be case sensitive depending +on OS. +.IP \[bu] 2 +Windows \- usually case insensitive, though case is preserved +.IP \[bu] 2 +OSX \- usually case insensitive, though it is possible to format case +sensitive +.IP \[bu] 2 +Linux \- usually case sensitive, but there are case insensitive file +systems (eg FAT formatted USB keys) +.PP +Most of the time this doesn\[cq]t cause any problems as people tend to +avoid files whose name differs only by case even on case sensitive +systems. +.SS Duplicate files +.PP +If a cloud storage system allows duplicate files then it can have two +objects with the same name. +.PP +This confuses rclone greatly when syncing \- use the +\f[C]rclone dedupe\f[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 \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. +.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 +\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. +.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 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!) +The default encoding will also encode these file names as they are +problematic with many cloud storage systems. .PP -Paths are specified as \f[C]remote:\f[] or \f[C]remote:path/to/dir\f[]. +.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 -Here is an example of how to make a remote called \f[C]remote\f[]. +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 \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 (/local/#filenames) section for details. +.SS Encoding option +.PP +Most backends have an encoding options, specified as a flag +\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\[cq]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). +.PP +However this can be incorrect in some scenarios, for example if you have +a Windows file system with characters such as \f[C]\[uFF0A]\f[R] and +\f[C]\[uFF1F]\f[R] that you want to remain as those characters on the +remote rather than being translated to \f[C]*\f[R] and \f[C]?\f[R]. +.PP +The \f[C]\-\-backend\-encoding\f[R] flags allow you to change that. +You can disable the encoding completely with +\f[C]\-\-backend\-encoding None\f[R] or set \f[C]encoding = None\f[R] in +the config file. +.PP +Encoding takes a comma separated list of encodings. +You can see the list of all available characters by passing an invalid +value to this flag, eg \f[C]\-\-local\-encoding \[dq]help\[dq]\f[R] and +\f[C]rclone help flags encoding\f[R] will show you the defaults for the +backends. +.PP +.TS +tab(@); +l l. +T{ +Encoding +T}@T{ +Characters +T} +_ +T{ +Asterisk +T}@T{ +\f[C]*\f[R] +T} +T{ +BackQuote +T}@T{ +\f[C]\[ga]\f[R] +T} +T{ +BackSlash +T}@T{ +\f[C]\[rs]\f[R] +T} +T{ +Colon +T}@T{ +\f[C]:\f[R] +T} +T{ +CrLf +T}@T{ +CR 0x0D, LF 0x0A +T} +T{ +Ctl +T}@T{ +All control characters 0x00\-0x1F +T} +T{ +Del +T}@T{ +DEL 0x7F +T} +T{ +Dollar +T}@T{ +\f[C]$\f[R] +T} +T{ +Dot +T}@T{ +\f[C].\f[R] +T} +T{ +DoubleQuote +T}@T{ +\f[C]\[dq]\f[R] +T} +T{ +Hash +T}@T{ +\f[C]#\f[R] +T} +T{ +InvalidUtf8 +T}@T{ +An invalid UTF\-8 character (eg latin1) +T} +T{ +LeftCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A,HT 0x09, VT 0x0B on the left of a string +T} +T{ +LeftPeriod +T}@T{ +\f[C].\f[R] on the left of a string +T} +T{ +LeftSpace +T}@T{ +SPACE on the left of a string +T} +T{ +LeftTilde +T}@T{ +\f[C]\[ti]\f[R] on the left of a string +T} +T{ +LtGt +T}@T{ +\f[C]<\f[R], \f[C]>\f[R] +T} +T{ +None +T}@T{ +No characters are encoded +T} +T{ +Percent +T}@T{ +\f[C]%\f[R] +T} +T{ +Pipe +T}@T{ +| +T} +T{ +Question +T}@T{ +\f[C]?\f[R] +T} +T{ +RightCrLfHtVt +T}@T{ +CR 0x0D, LF 0x0A, HT 0x09, VT 0x0B on the right of a string +T} +T{ +RightPeriod +T}@T{ +\f[C].\f[R] on the right of a string +T} +T{ +RightSpace +T}@T{ +SPACE on the right of a string +T} +T{ +SingleQuote +T}@T{ +\f[C]\[aq]\f[R] +T} +T{ +Slash +T}@T{ +\f[C]/\f[R] +T} +.TE +.PP +To take a specific example, the FTP backend\[cq]s default encoding is +.IP +.nf +\f[C] +\-\-ftp\-encoding \[dq]Slash,Del,Ctl,RightSpace,Dot\[dq] +\f[R] +.fi +.PP +However, let\[cq]s say the FTP server is running on Windows and +can\[cq]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: +.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\[cq]s say you have a Windows server but you want to preserve +\f[C]\[uFF0A]\f[R] and \f[C]\[uFF1F]\f[R], you would then have this as +the encoding (the Windows encoding minus \f[C]Asterisk\f[R] and +\f[C]Question\f[R]). +.IP +.nf +\f[C] +Slash,LtGt,DoubleQuote,Colon,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot +\f[R] +.fi +.PP +This can be specified using the \f[C]\-\-local\-encoding\f[R] flag or +using an \f[C]encoding\f[R] parameter in the config file. +.SS MIME Type +.PP +MIME types (also known as media types) classify types of documents using +a simple text classification, eg \f[C]text/html\f[R] or +\f[C]application/pdf\f[R]. +.PP +Some cloud storage systems support reading (\f[C]R\f[R]) the MIME type +of objects and some support writing (\f[C]W\f[R]) the MIME type of +objects. +.PP +The MIME type can be important if you are serving files directly to HTTP +from the storage system. +.PP +If you are copying from a remote which supports reading (\f[C]R\f[R]) to +a remote which supports writing (\f[C]W\f[R]) then rclone will preserve +the MIME types. +Otherwise they will be guessed from the extension, or the remote itself +may assign the MIME type. +.SS Optional Features +.PP +All the remotes support a basic set of features, but there are some +optional features supported by some remotes used to make some operations +more efficient. +.PP +.TS +tab(@); +l c c c c c c c c c c. +T{ +Name +T}@T{ +Purge +T}@T{ +Copy +T}@T{ +Move +T}@T{ +DirMove +T}@T{ +CleanUp +T}@T{ +ListR +T}@T{ +StreamUpload +T}@T{ +LinkSharing +T}@T{ +About +T}@T{ +EmptyDir +T} +_ +T{ +1Fichier +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon Drive +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Amazon S3 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Backblaze B2 +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T} +T{ +Box +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T} +T{ +Citrix ShareFile +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Dropbox +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +FTP +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Google Cloud Storage +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Google Drive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Google Photos +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T} +T{ +HTTP +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +Yes +T} +T{ +Hubic +T}@T{ +Yes \[dg] +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +No +T} +T{ +Jottacloud +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +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{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +Microsoft OneDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No #575 (https://github.com/rclone/rclone/issues/575) +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +OpenDrive +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T} +T{ +Openstack Swift +T}@T{ +Yes \[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{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +premiumize.me +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +put.io +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +QingStor +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +No +T}@T{ +No +T} +T{ +SFTP +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +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{ +WebDAV +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes \[dd] +T}@T{ +No #2178 (https://github.com/rclone/rclone/issues/2178) +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +Yandex Disk +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +Yes +T} +T{ +The local filesystem +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T}@T{ +No +T}@T{ +No +T}@T{ +Yes +T}@T{ +No +T}@T{ +Yes +T}@T{ +Yes +T} +.TE +.SS Purge +.PP +This deletes a directory quicker than just deleting all the files in the +directory. +.PP +\[dg] Note Swift and Hubic implement this in order to delete directory +markers but they don\[cq]t actually have a quicker way of deleting files +other than deleting them individually. +.PP +\[dd] StreamUpload is not supported with Nextcloud +.SS Copy +.PP +Used when copying an object to and from the same remote. +This known as a server side copy so you can copy a file without +downloading it and uploading it again. +It is used if you use \f[C]rclone copy\f[R] or \f[C]rclone move\f[R] if +the remote doesn\[cq]t support \f[C]Move\f[R] directly. +.PP +If the server doesn\[cq]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\[cq]t support +\f[C]DirMove\f[R]. +.PP +If the server isn\[cq]t capable of \f[C]Move\f[R] then rclone simulates +it with \f[C]Copy\f[R] then delete. +If the server doesn\[cq]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\[cq]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\[cq]t do \f[C]CleanUp\f[R] then +\f[C]rclone cleanup\f[R] will return an error. +.SS ListR +.PP +The remote supports a recursive list to list all the contents beneath a +directory quickly. +This enables the \f[C]\-\-fast\-list\f[R] flag to work. +See the rclone docs (/docs/#fast-list) for more details. +.SS StreamUpload +.PP +Some remotes allow files to be uploaded without knowing the file size in +advance. +This allows certain operations to work without spooling the file to +local disk first, e.g.\ \f[C]rclone rcat\f[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\[cq]t have an +account on the particular cloud provider. +.SS About +.PP +This is used to fetch quota information from the remote, like bytes +used/free/quota and bytes used in the trash. +.PP +This is also used to return the space used, available for +\f[C]rclone mount\f[R]. +.PP +If the server can\[cq]t do \f[C]About\f[R] then \f[C]rclone about\f[R] +will return an error. +.SS EmptyDir +.PP +The remote supports empty directories. +See Limitations (/bugs/#limitations) for details. +Most Object/Bucket based remotes do not support this. +.SH Global Flags +.PP +This describes the global flags available to every rclone command split +into two groups, non backend and backend flags. +.SS Non Backend Flags +.PP +These flags are available for every command. +.IP +.nf +\f[C] + \-\-ask\-password Allow prompt for password for encrypted configuration. (default true) + \-\-auto\-confirm If enabled, do not request console confirmation. + \-\-backup\-dir string Make backups into hierarchy based in DIR. + \-\-bind string Local address to bind to for outgoing connections, IPv4, IPv6 or name. + \-\-buffer\-size SizeSuffix In memory buffer size when reading files for each \-\-transfer. (default 16M) + \-\-bwlimit BwTimetable Bandwidth limit in kBytes/s, or use suffix b|k|M|G or a full timetable. + \-\-ca\-cert string CA certificate used to verify servers + \-\-cache\-dir string Directory rclone will use for caching. (default \[dq]$HOME/.cache/rclone\[dq]) + \-\-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 + \-\-delete\-after When synchronizing, delete files on destination after transferring (default) + \-\-delete\-before When synchronizing, delete files on destination before transferring + \-\-delete\-during When synchronizing, delete files during transfer + \-\-delete\-excluded Delete files on dest excluded from sync + \-\-disable string Disable a comma separated list of features. Use help to see a list. + \-n, \-\-dry\-run Do a trial run with no permanent changes + \-\-dump DumpFlags List of items to dump from: headers,bodies,requests,responses,auth,filters,goroutines,openfiles + \-\-dump\-bodies Dump HTTP headers and bodies \- may contain sensitive info + \-\-dump\-headers Dump HTTP headers \- may contain sensitive info + \-\-exclude stringArray Exclude files matching pattern + \-\-exclude\-from stringArray Read exclude patterns from file + \-\-exclude\-if\-present string Exclude directories if filename is present + \-\-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 + \-f, \-\-filter stringArray Add a file\-filtering rule + \-\-filter\-from stringArray Read filtering patterns from a file + \-\-ignore\-case Ignore case in filters (case insensitive) + \-\-ignore\-case\-sync Ignore case when synchronizing + \-\-ignore\-checksum Skip post copy check of checksums. + \-\-ignore\-errors delete even if there are I/O errors + \-\-ignore\-existing Skip all files that exist on destination + \-\-ignore\-size Ignore size when skipping use mod\-time or checksum. + \-I, \-\-ignore\-times Don\[aq]t skip files that match size and time \- transfer all files + \-\-immutable Do not modify files. Fail if existing files have been modified. + \-\-include stringArray Include files matching pattern + \-\-include\-from stringArray Read include patterns from file + \-\-log\-file string Log everything to this file + \-\-log\-format string Comma separated list of log format options (default \[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\-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\-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\-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 + \-\-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 + \-\-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.51.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 Amazon Application Client ID. + \-\-acd\-client\-secret string Amazon Application 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\-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\-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\-sas\-url string SAS URL for container level access only + \-\-azureblob\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (<= 256MB). (default 256M) + \-\-azureblob\-use\-emulator Uses local storage emulator if provided as \[aq]true\[aq] (leave blank if using real azure storage endpoint) + \-\-b2\-account string Account ID or Application Key ID + \-\-b2\-chunk\-size SizeSuffix Upload chunk size. Must fit in memory. (default 96M) + \-\-b2\-disable\-checksum Disable checksums for large (> upload cutoff) files + \-\-b2\-download\-auth\-duration Duration Time before the authorization token will expire in s or suffix ms|s|m|h|d. (default 1w) + \-\-b2\-download\-url string Custom endpoint for downloads. + \-\-b2\-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\-test\-mode string A flag string for X\-Bz\-Test\-Mode header for debugging. + \-\-b2\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload. (default 200M) + \-\-b2\-versions Include old versions in directory listings. + \-\-box\-box\-config\-file string Box App config.json location + \-\-box\-box\-sub\-type string (default \[dq]user\[dq]) + \-\-box\-client\-id string Box App Client Id. + \-\-box\-client\-secret string Box App Client Secret + \-\-box\-commit\-retries int Max number of times to try committing a multipart file. (default 100) + \-\-box\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot) + \-\-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 verifications when connecting to the Plex server + \-\-cache\-plex\-password string The password of the Plex user + \-\-cache\-plex\-url string The URL of the Plex server + \-\-cache\-plex\-username string The username of the Plex user + \-\-cache\-read\-retries int How many times to retry a read from a cache storage. (default 10) + \-\-cache\-remote string Remote to cache. + \-\-cache\-rps int Limits the number of requests per second to the source FS (\-1 to disable) (default \-1) + \-\-cache\-tmp\-upload\-path string Directory to keep temporary files until they are uploaded. + \-\-cache\-tmp\-wait\-time Duration How long should files be stored in local cache before being uploaded (default 15s) + \-\-cache\-workers int How many workers should run in parallel to download chunks. (default 4) + \-\-cache\-writes Cache file data on writes through the FS + \-\-chunker\-chunk\-size SizeSuffix Files larger than chunk size will be split in chunks. (default 2G) + \-\-chunker\-fail\-hard Choose how chunker should handle files with missing or invalid chunks. + \-\-chunker\-hash\-type string Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. (default \[dq]md5\[dq]) + \-\-chunker\-meta\-format string Format of the metadata object or \[dq]none\[dq]. By default \[dq]simplejson\[dq]. (default \[dq]simplejson\[dq]) + \-\-chunker\-name\-format string String format of chunk file names. (default \[dq]*.rclone_chunk.###\[dq]) + \-\-chunker\-remote string Remote to chunk/unchunk. + \-\-chunker\-start\-from int Minimum valid chunk number. Usually 0 or 1. (default 1) + \-L, \-\-copy\-links Follow symlinks and copy the pointed to item. + \-\-crypt\-directory\-name\-encryption Option to either encrypt directory names or leave them intact. (default true) + \-\-crypt\-filename\-encryption string How to encrypt the filenames. (default \[dq]standard\[dq]) + \-\-crypt\-password string Password or pass phrase for encryption. + \-\-crypt\-password2 string Password or pass phrase for salt. Optional but recommended. + \-\-crypt\-remote string Remote to encrypt/decrypt. + \-\-crypt\-show\-mapping For all files listed show how the names encrypt. + \-\-drive\-acknowledge\-abuse Set to allow files which return cannotDownloadAbusiveFile to be downloaded. + \-\-drive\-allow\-import\-name\-change Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time. + \-\-drive\-alternate\-export Use alternate export URLs for google documents export., + \-\-drive\-auth\-owner\-only Only consider files owned by the authenticated user. + \-\-drive\-chunk\-size SizeSuffix Upload chunk size. Must a power of 2 >= 256k. (default 8M) + \-\-drive\-client\-id string Google Application Client Id + \-\-drive\-client\-secret string Google Application Client Secret + \-\-drive\-disable\-http2 Disable drive using http2 (default true) + \-\-drive\-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\-stop\-on\-upload\-limit Make upload limit errors be fatal + \-\-drive\-team\-drive string ID of the Team Drive + \-\-drive\-trashed\-only Only show files that are in the trash. + \-\-drive\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 8M) + \-\-drive\-use\-created\-date Use file created date instead of modified date., + \-\-drive\-use\-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\-chunk\-size SizeSuffix Upload chunk size. (< 150M). (default 48M) + \-\-dropbox\-client\-id string Dropbox App Client Id + \-\-dropbox\-client\-secret string Dropbox App Client Secret + \-\-dropbox\-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. + \-\-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\-host string FTP host to connect to + \-\-ftp\-no\-check\-certificate Do not verify the TLS certificate of the server + \-\-ftp\-pass string FTP password + \-\-ftp\-port string FTP port, leave blank to use default (21) + \-\-ftp\-tls Use FTP over TLS (Implicit) + \-\-ftp\-user string FTP username, leave blank for current username, $USER + \-\-gcs\-bucket\-acl string Access Control List for new buckets. + \-\-gcs\-bucket\-policy\-only Access checks should use bucket\-level IAM policies. + \-\-gcs\-client\-id string Google Application Client Id + \-\-gcs\-client\-secret string Google Application Client Secret + \-\-gcs\-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. + \-\-gphotos\-client\-id string Google Application Client Id + \-\-gphotos\-client\-secret string Google Application Client Secret + \-\-gphotos\-read\-only Set to make the Google Photos backend read only. + \-\-gphotos\-read\-size Set to read the size of media items. + \-\-http\-headers CommaSepList Set HTTP headers for all transactions + \-\-http\-no\-head Don\[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\-chunk\-size SizeSuffix Above this size files will be chunked into a _segments container. (default 5G) + \-\-hubic\-client\-id string Hubic Client Id + \-\-hubic\-client\-secret string Hubic Client Secret + \-\-hubic\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,InvalidUtf8) + \-\-hubic\-no\-chunk Don\[aq]t chunk files during streaming upload. + \-\-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\-unlink Remove existing public link to file/folder with link command rather than creating. + \-\-jottacloud\-upload\-resume\-limit SizeSuffix Files bigger than this can be resumed if the upload fail\[aq]s. (default 10M) + \-\-koofr\-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) + \-\-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\-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 + \-\-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. + \-\-mega\-user string User name + \-x, \-\-one\-file\-system Don\[aq]t cross filesystem boundaries (unix/macOS only). + \-\-onedrive\-chunk\-size SizeSuffix Chunk size to upload files with \- must be multiple of 320k (327,680 bytes). (default 10M) + \-\-onedrive\-client\-id string Microsoft App Client Id + \-\-onedrive\-client\-secret string Microsoft App Client Secret + \-\-onedrive\-drive\-id string The ID of the drive to use + \-\-onedrive\-drive\-type string The type of the drive ( personal | business | documentLibrary ) + \-\-onedrive\-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. + \-\-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. + \-\-opendrive\-username string Username + \-\-pcloud\-client\-id string Pcloud App Client Id + \-\-pcloud\-client\-secret string Pcloud App Client Secret + \-\-pcloud\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot) + \-\-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 a endpoint URL to connection QingStor API. + \-\-qingstor\-env\-auth Get QingStor credentials from runtime. Only applies if access_key_id and secret_access_key is blank. + \-\-qingstor\-secret\-access\-key string QingStor Secret Access Key (password) + \-\-qingstor\-upload\-concurrency int Concurrency for multipart uploads. (default 1) + \-\-qingstor\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-qingstor\-zone string Zone to connect to. + \-\-s3\-access\-key\-id string AWS Access Key ID. + \-\-s3\-acl string Canned ACL used when creating buckets and storing or copying objects. + \-\-s3\-bucket\-acl string Canned ACL used when creating buckets. + \-\-s3\-chunk\-size SizeSuffix Chunk size to use for uploading. (default 5M) + \-\-s3\-copy\-cutoff SizeSuffix Cutoff for switching to multipart copy (default 5G) + \-\-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\-provider string Choose your S3 provider. + \-\-s3\-region string Region to connect to. + \-\-s3\-secret\-access\-key string AWS Secret Access Key (password) + \-\-s3\-server\-side\-encryption string The server\-side encryption algorithm used when storing this object in S3. + \-\-s3\-session\-token string An AWS session token + \-\-s3\-sse\-kms\-key\-id string If using KMS ID you must provide the ARN of Key. + \-\-s3\-storage\-class string The storage class to use when storing new objects in S3. + \-\-s3\-upload\-concurrency int Concurrency for multipart uploads. (default 4) + \-\-s3\-upload\-cutoff SizeSuffix Cutoff for switching to chunked upload (default 200M) + \-\-s3\-use\-accelerate\-endpoint If true use the AWS S3 accelerated endpoint. + \-\-s3\-v2\-auth If true use v2 authentication. + \-\-sftp\-ask\-password Allow asking for SFTP password when needed. + \-\-sftp\-disable\-hashcheck Disable the execution of SSH commands to determine if remote file hashing is available. + \-\-sftp\-host string SSH host to connect to + \-\-sftp\-key\-file string Path to PEM\-encoded private key file, leave blank or set key\-use\-agent to use ssh\-agent. + \-\-sftp\-key\-file\-pass string The passphrase to decrypt the PEM\-encoded private key file. + \-\-sftp\-key\-use\-agent When set forces the usage of the ssh\-agent. + \-\-sftp\-md5sum\-command string The command used to read md5 hashes. Leave blank for autodetect. + \-\-sftp\-pass string SSH password, leave blank to use ssh\-agent. + \-\-sftp\-path\-override string Override path used by SSH connection. + \-\-sftp\-port string SSH port, leave blank to use default (22) + \-\-sftp\-set\-modtime Set the modified time on the remote if set. (default true) + \-\-sftp\-sha1sum\-command string The command used to read sha1 hashes. Leave blank for autodetect. + \-\-sftp\-skip\-links Set to skip any symlinks and any other non regular files. + \-\-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). + \-\-union\-remotes string List of space separated remotes. + \-\-webdav\-bearer\-token string Bearer token instead of user/pass (eg a Macaroon) + \-\-webdav\-bearer\-token\-command string Command to run to get a bearer token + \-\-webdav\-pass string Password. + \-\-webdav\-url string URL of http host to connect to + \-\-webdav\-user string User name + \-\-webdav\-vendor string Name of the Webdav site/service/software you are using + \-\-yandex\-client\-id string Yandex Client Id + \-\-yandex\-client\-secret string Yandex Client Secret + \-\-yandex\-encoding MultiEncoder This sets the encoding for the backend. (default Slash,Del,Ctl,InvalidUtf8,Dot) + \-\-yandex\-unlink Remove existing public link to file/folder with link command rather than creating. +\f[R] +.fi +.SS 1Fichier +.PP +This is a backend for the 1ficher (https://1fichier.com) cloud storage +service. +Note that a Premium subscription is required to use the API. +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.PP +The initial setup for 1Fichier involves getting the API key from the +website which you need to do in your browser. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] -\ rclone\ config -\f[] + 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 +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\ /\ http\ Connection -\ \ \ \\\ "http" +XX / 1Fichier + \[rs] \[dq]fichier\[dq] [snip] -Storage>\ http -URL\ of\ http\ host\ to\ connect\ to -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Connect\ to\ example.com -\ \ \ \\\ "https://example.com" -url>\ https://beta.rclone.org -Remote\ config +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 (\[dq]\[dq]). +api_key> example_key + +Edit advanced config? (y/n) +y) Yes +n) No +y/n> +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -url\ =\ https://beta.rclone.org +type = fichier +api_key = example_key \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -Current\ remotes: - -Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Type -====\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ==== -remote\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ http - -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[] +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[] and can now be used like this +Once configured you can then use \f[C]rclone\f[R] like this, .PP -See all the top level directories +List directories in top level of your 1Fichier account .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your 1Fichier account +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to a 1Fichier directory called backup +.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. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/overview/#restricted-characters) the following characters are also +replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[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{ +\[cq] +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 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} +.TE +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can\[cq]t be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to fichier (1Fichier). +.SS \[en]fichier\-api\-key +.PP +Your API Key, get it from https://1fichier.com/console/params.pl +.IP \[bu] 2 +Config: api_key +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_API_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to fichier (1Fichier). +.SS \[en]fichier\-shared\-folder +.PP +If you want to download a shared folder, add this parameter +.IP \[bu] 2 +Config: shared_folder +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_SHARED_FOLDER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]fichier\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FICHIER_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot +.SS Alias +.PP +The \f[C]alias\f[R] remote provides a new name for another remote. +.PP +Paths may be as deep as required or a local path, eg +\f[C]remote:directory/subdirectory\f[R] or +\f[C]/directory/subdirectory\f[R]. +.PP +During the initial setup with \f[C]rclone config\f[R] you will specify +the target remote. +The target remote can either be a local path or another remote. +.PP +Subfolders can be used in target remote. +Assume a 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 a alias called \f[C]remote\f[R] for +local folder. +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 / 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: + +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 \[en]alias\-remote +.PP +Remote or path to alias. +Can be \[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq], +\[lq]myremote:\[rq] or \[lq]/local/path\[rq]. +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_ALIAS_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Amazon Drive +.PP +Amazon Drive, formerly known as Amazon Cloud Drive, is a cloud storage +service run by Amazon for consumers. +.SS Status +.PP +\f[B]Important:\f[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\[cq]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\[cq]s very secure App Engine environment and +doesn\[cq]t store any credentials which pass through it. +.PP +Since rclone doesn\[cq]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 a third party ouath +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\[cq]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] + 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 \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 +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your Amazon Drive +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an Amazon Drive directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Modified time and MD5SUMs +.PP +Amazon Drive doesn\[cq]t allow modification times to be changed via the +API so these won\[cq]t be accurate or used for syncing. +.PP +It does store MD5SUMs so for a more accurate sync, you can use the +\f[C]\-\-checksum\f[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 (/overview/#invalid-utf8), as +they can\[cq]t be used in JSON strings. +.SS Deleting files +.PP +Any files you delete with rclone will end up in the trash. +Amazon don\[cq]t provide an API to permanently delete files, nor to +empty the trash, so you will have to do that with one of Amazon\[cq]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\[cq]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 \[en]acd\-client\-id +.PP +Amazon Application Client ID. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]acd\-client\-secret +.PP +Amazon Application Client Secret. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_ACD_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to amazon cloud drive (Amazon +Drive). +.SS \[en]acd\-auth\-url +.PP +Auth server URL. +Leave blank to use Amazon\[cq]s. +.IP \[bu] 2 +Config: auth_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_AUTH_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]acd\-token\-url +.PP +Token server url. +leave blank to use Amazon\[cq]s. +.IP \[bu] 2 +Config: token_url +.IP \[bu] 2 +Env Var: RCLONE_ACD_TOKEN_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]acd\-checkpoint +.PP +Checkpoint for internal polling (debug). +.IP \[bu] 2 +Config: checkpoint +.IP \[bu] 2 +Env Var: RCLONE_ACD_CHECKPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]acd\-upload\-wait\-per\-gb +.PP +Additional time per GB to wait after a failed complete upload to see if +it appears. +.PP +Sometimes Amazon Drive gives an error when a file has been fully +uploaded but the file appears anyway after a little while. +This happens sometimes for files over 1GB in size and nearly every time +for files bigger than 10GB. +This parameter controls the time rclone waits for the file to appear. +.PP +The default value for this parameter is 3 minutes per GB, so by default +it will wait 3 minutes for every GB uploaded to see if the file appears. +.PP +You can disable this feature by setting it to 0. +This may cause conflict errors as rclone retries the failed upload but +the file will most likely appear correctly eventually. +.PP +These values were determined empirically by observing lots of uploads of +big files for a range of file sizes. +.PP +Upload with the \[lq]\-v\[rq] flag to see more info about what rclone is +doing in this situation. +.IP \[bu] 2 +Config: upload_wait_per_gb +.IP \[bu] 2 +Env Var: RCLONE_ACD_UPLOAD_WAIT_PER_GB +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 3m0s +.SS \[en]acd\-templink\-threshold +.PP +Files >= this size will be downloaded via their tempLink. +.PP +Files this size or more will be downloaded via their \[lq]tempLink\[rq]. +This is to work around a problem with Amazon Drive which blocks +downloads of files bigger than about 10GB. +The default for this is 9GB which shouldn\[cq]t need to be changed. +.PP +To download files above this threshold, rclone requests a +\[lq]tempLink\[rq] which downloads the file through a temporary URL +directly from the underlying S3 storage. +.IP \[bu] 2 +Config: templink_threshold +.IP \[bu] 2 +Env Var: RCLONE_ACD_TEMPLINK_THRESHOLD +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 9G +.SS \[en]acd\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/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\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.PP +Amazon Drive has rate limiting so you may notice errors in the sync (429 +errors). +rclone will automatically retry the sync up to 3 times by default (see +\f[C]\-\-retries\f[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 \f[C]\-\-max\-size 50000M\f[R] option to +limit the maximum size of uploaded files. +Note that \f[C]\-\-max\-size\f[R] does not split files into segments, it +only ignores files over this size. +.SS Amazon S3 Storage Providers +.PP +The S3 backend can be used with a number of different providers: +.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 +Wasabi +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +Once you have made a remote (see the provider specific section above) +you can use it like this: +.PP +See all buckets +.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 /home/local/directory remote:bucket +\f[R] +.fi +.SS AWS S3 +.PP +Here is an example of making an s3 configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 Compliant Storage Providers (AWS, Ceph, Dreamhost, IBM COS, Minio) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] + 3 / Digital Ocean Spaces + \[rs] \[dq]DigitalOcean\[dq] + 4 / Dreamhost DreamObjects + \[rs] \[dq]Dreamhost\[dq] + 5 / IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 6 / Minio Object Storage + \[rs] \[dq]Minio\[dq] + 7 / Wasabi Object Storage + \[rs] \[dq]Wasabi\[dq] + 8 / Any other S3 compatible provider + \[rs] \[dq]Other\[dq] +provider> 1 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> XXX +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YYY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] + / US East (Ohio) Region + 2 | Needs location constraint us\-east\-2. + \[rs] \[dq]us\-east\-2\[dq] + / US West (Oregon) Region + 3 | Needs location constraint us\-west\-2. + \[rs] \[dq]us\-west\-2\[dq] + / US West (Northern California) Region + 4 | Needs location constraint us\-west\-1. + \[rs] \[dq]us\-west\-1\[dq] + / Canada (Central) Region + 5 | Needs location constraint ca\-central\-1. + \[rs] \[dq]ca\-central\-1\[dq] + / EU (Ireland) Region + 6 | Needs location constraint EU or eu\-west\-1. + \[rs] \[dq]eu\-west\-1\[dq] + / EU (London) Region + 7 | Needs location constraint eu\-west\-2. + \[rs] \[dq]eu\-west\-2\[dq] + / EU (Frankfurt) Region + 8 | Needs location constraint eu\-central\-1. + \[rs] \[dq]eu\-central\-1\[dq] + / Asia Pacific (Singapore) Region + 9 | Needs location constraint ap\-southeast\-1. + \[rs] \[dq]ap\-southeast\-1\[dq] + / Asia Pacific (Sydney) Region +10 | Needs location constraint ap\-southeast\-2. + \[rs] \[dq]ap\-southeast\-2\[dq] + / Asia Pacific (Tokyo) Region +11 | Needs location constraint ap\-northeast\-1. + \[rs] \[dq]ap\-northeast\-1\[dq] + / Asia Pacific (Seoul) +12 | Needs location constraint ap\-northeast\-2. + \[rs] \[dq]ap\-northeast\-2\[dq] + / Asia Pacific (Mumbai) +13 | Needs location constraint ap\-south\-1. + \[rs] \[dq]ap\-south\-1\[dq] + / Asia Patific (Hong Kong) Region +14 | Needs location constraint ap\-east\-1. + \[rs] \[dq]ap\-east\-1\[dq] + / South America (Sao Paulo) Region +15 | Needs location constraint sa\-east\-1. + \[rs] \[dq]sa\-east\-1\[dq] +region> 1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +endpoint> +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \[rs] \[dq]\[dq] + 2 / US East (Ohio) Region. + \[rs] \[dq]us\-east\-2\[dq] + 3 / US West (Oregon) Region. + \[rs] \[dq]us\-west\-2\[dq] + 4 / US West (Northern California) Region. + \[rs] \[dq]us\-west\-1\[dq] + 5 / Canada (Central) Region. + \[rs] \[dq]ca\-central\-1\[dq] + 6 / EU (Ireland) Region. + \[rs] \[dq]eu\-west\-1\[dq] + 7 / EU (London) Region. + \[rs] \[dq]eu\-west\-2\[dq] + 8 / EU Region. + \[rs] \[dq]EU\[dq] + 9 / Asia Pacific (Singapore) Region. + \[rs] \[dq]ap\-southeast\-1\[dq] +10 / Asia Pacific (Sydney) Region. + \[rs] \[dq]ap\-southeast\-2\[dq] +11 / Asia Pacific (Tokyo) Region. + \[rs] \[dq]ap\-northeast\-1\[dq] +12 / Asia Pacific (Seoul) + \[rs] \[dq]ap\-northeast\-2\[dq] +13 / Asia Pacific (Mumbai) + \[rs] \[dq]ap\-south\-1\[dq] +14 / Asia Pacific (Hong Kong) + \[rs] \[dq]ap\-east\-1\[dq] +15 / South America (Sao Paulo) Region. + \[rs] \[dq]sa\-east\-1\[dq] +location_constraint> 1 +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. + 3 | Granting this on a bucket is generally not recommended. + \[rs] \[dq]public\-read\-write\[dq] + 4 / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. + \[rs] \[dq]authenticated\-read\[dq] + / Object owner gets FULL_CONTROL. Bucket owner gets READ access. + 5 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-read\[dq] + / Both the object owner and the bucket owner get FULL_CONTROL over the object. + 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it. + \[rs] \[dq]bucket\-owner\-full\-control\[dq] +acl> 1 +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> 1 +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] + 5 / One Zone Infrequent Access storage class + \[rs] \[dq]ONEZONE_IA\[dq] + 6 / Glacier storage class + \[rs] \[dq]GLACIER\[dq] + 7 / Glacier Deep Archive storage class + \[rs] \[dq]DEEP_ARCHIVE\[dq] + 8 / Intelligent\-Tiering storage class + \[rs] \[dq]INTELLIGENT_TIERING\[dq] +storage_class> 1 +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = s3 +provider = AWS +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> +\f[R] +.fi +.SS \[en]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 (/docs/#fast-list) for more details. +.SS \[en]update and \[en]use\-server\-modtime +.PP +As noted below, the modified time is stored on metadata on the object. +It is used by default for all operations that require checking the time +a file was last updated. +It allows rclone to treat the remote more like a true filesystem, but it +is inefficient because it requires an extra API call to retrieve the +metadata. +.PP +For many operations, the time the object was last uploaded to the remote +is sufficient to determine if it is \[lq]dirty\[rq]. +By using \f[C]\-\-update\f[R] along with +\f[C]\-\-use\-server\-modtime\f[R], you can avoid the extra API call and +simply upload files whose local modtime is newer than the time it was +last uploaded. +.SS Modified time +.PP +The modified time is stored as metadata on the object as +\f[C]X\-Amz\-Meta\-Mtime\f[R] as floating point since the epoch accurate +to 1 ns. +.PP +If the modification time needs to be updated rclone will attempt to +perform a server side copy to update the modification if the object can +be copied in a single part. +In the case the object is larger than 5Gb or is in Glacier or Glacier +Deep Archive storage the object will be uploaded rather than copied. +.SS Restricted filename characters +.PP +S3 allows any valid UTF\-8 string as a key. +.PP +Invalid UTF\-8 bytes will be replaced (/overview/#invalid-utf8), as they +can\[cq]t be used in XML. +.PP +The following characters are replaced since these are problematic when +dealing with the REST API: +.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\[cq]t seem to +work with the SDK properly: +.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 \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 +\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. +.PP +Increasing \f[C]\-\-s3\-upload\-concurrency\f[R] will increase +throughput (8 would be a sensible value) and increasing +\f[C]\-\-s3\-chunk\-size\f[R] also increases throughput (16M would be +sensible). +Increasing either of these will use more memory. +The default values are high enough to gain most of the possible +performance without using too much memory. +.SS Buckets and Regions +.PP +With Amazon S3 you can list buckets (\f[C]rclone lsd\f[R]) using any +region, but you can only access the content of a bucket from the region +it was created in. +If you attempt to access a bucket from the wrong region, you will get an +error, +\f[C]incorrect region, the bucket is not in \[aq]XXX\[aq] region\f[R]. +.SS Authentication +.PP +There are a number of ways to supply \f[C]rclone\f[R] with a set of AWS +credentials, with and without using the environment. +.PP +The different authentication methods are tried in this order: +.IP \[bu] 2 +Directly in the rclone configuration file (\f[C]env_auth = false\f[R] in +the config file): +.RS 2 +.IP \[bu] 2 +\f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] are required. +.IP \[bu] 2 +\f[C]session_token\f[R] can be optionally set when using AWS STS. +.RE +.IP \[bu] 2 +Runtime configuration (\f[C]env_auth = true\f[R] in the config file): +.RS 2 +.IP \[bu] 2 +Export the following environment variables before running +\f[C]rclone\f[R]: +.RS 2 +.IP \[bu] 2 +Access Key ID: \f[C]AWS_ACCESS_KEY_ID\f[R] or \f[C]AWS_ACCESS_KEY\f[R] +.IP \[bu] 2 +Secret Access Key: \f[C]AWS_SECRET_ACCESS_KEY\f[R] or +\f[C]AWS_SECRET_KEY\f[R] +.IP \[bu] 2 +Session Token: \f[C]AWS_SESSION_TOKEN\f[R] (optional) +.RE +.IP \[bu] 2 +Or, use a named +profile (https://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html): +.RS 2 +.IP \[bu] 2 +Profile files are standard files used by AWS CLI tools +.IP \[bu] 2 +By default it will use the profile in your home directory (eg +\f[C]\[ti]/.aws/credentials\f[R] on unix based systems) file and the +\[lq]default\[rq] profile, to change set these environment variables: +.RS 2 +.IP \[bu] 2 +\f[C]AWS_SHARED_CREDENTIALS_FILE\f[R] to control which file. +.IP \[bu] 2 +\f[C]AWS_PROFILE\f[R] to control which profile to use. +.RE +.RE +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an ECS task with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] on an EC2 instance with an IAM role (AWS only). +.IP \[bu] 2 +Or, run \f[C]rclone\f[R] in an EKS pod with an IAM role that is +associated with a service account (AWS only). +.RE +.PP +If none of these option actually end up providing \f[C]rclone\f[R] with +AWS credentials then S3 interaction will be non\-authenticated (see +below). +.SS S3 Permissions +.PP +When using the \f[C]sync\f[R] subcommand of \f[C]rclone\f[R] the +following minimum permissions are required to be available on the bucket +being written to: +.IP \[bu] 2 +\f[C]ListBucket\f[R] +.IP \[bu] 2 +\f[C]DeleteObject\f[R] +.IP \[bu] 2 +\f[C]GetObject\f[R] +.IP \[bu] 2 +\f[C]PutObject\f[R] +.IP \[bu] 2 +\f[C]PutObjectACL\f[R] +.PP +When using the \f[C]lsd\f[R] subcommand, the \f[C]ListAllMyBuckets\f[R] +permission is required. +.PP +Example policy: +.IP +.nf +\f[C] +{ + \[dq]Version\[dq]: \[dq]2012\-10\-17\[dq], + \[dq]Statement\[dq]: [ + { + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Principal\[dq]: { + \[dq]AWS\[dq]: \[dq]arn:aws:iam::USER_SID:user/USER_NAME\[dq] + }, + \[dq]Action\[dq]: [ + \[dq]s3:ListBucket\[dq], + \[dq]s3:DeleteObject\[dq], + \[dq]s3:GetObject\[dq], + \[dq]s3:PutObject\[dq], + \[dq]s3:PutObjectAcl\[dq] + ], + \[dq]Resource\[dq]: [ + \[dq]arn:aws:s3:::BUCKET_NAME/*\[dq], + \[dq]arn:aws:s3:::BUCKET_NAME\[dq] + ] + }, + { + \[dq]Effect\[dq]: \[dq]Allow\[dq], + \[dq]Action\[dq]: \[dq]s3:ListAllMyBuckets\[dq], + \[dq]Resource\[dq]: \[dq]arn:aws:s3:::*\[dq] + } + ] +} +\f[R] +.fi +.PP +Notes on above: +.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\[cq]s objects. +.PP +For reference, here\[cq]s an Ansible +script (https://gist.github.com/ebridges/ebfc9042dd7c756cd101cfa807b7ae2b) +that will generate one or more buckets that will work with +\f[C]rclone sync\f[R]. +.SS Key Management System (KMS) +.PP +If you are using server side encryption with KMS then you will find you +can\[cq]t transfer small objects. +As a work\-around you can use the \f[C]\-\-ignore\-checksum\f[R] flag. +.PP +A proper fix is being worked on in issue +#1824 (https://github.com/rclone/rclone/issues/1824). +.SS Glacier and Glacier Deep Archive +.PP +You can upload objects using the glacier storage class or transition +them to glacier using a lifecycle +policy (http://docs.aws.amazon.com/AmazonS3/latest/user-guide/create-lifecycle.html). +The bucket can still be synced or copied into normally, but if rclone +tries to access data from the glacier storage class you will see an +error like below. +.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 Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, etc)). +.SS \[en]s3\-provider +.PP +Choose your S3 provider. +.IP \[bu] 2 +Config: provider +.IP \[bu] 2 +Env Var: RCLONE_S3_PROVIDER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]AWS\[rq] +.RS 2 +.IP \[bu] 2 +Amazon Web Services (AWS) S3 +.RE +.IP \[bu] 2 +\[lq]Alibaba\[rq] +.RS 2 +.IP \[bu] 2 +Alibaba Cloud Object Storage System (OSS) formerly Aliyun +.RE +.IP \[bu] 2 +\[lq]Ceph\[rq] +.RS 2 +.IP \[bu] 2 +Ceph Object Storage +.RE +.IP \[bu] 2 +\[lq]DigitalOcean\[rq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces +.RE +.IP \[bu] 2 +\[lq]Dreamhost\[rq] +.RS 2 +.IP \[bu] 2 +Dreamhost DreamObjects +.RE +.IP \[bu] 2 +\[lq]IBMCOS\[rq] +.RS 2 +.IP \[bu] 2 +IBM COS S3 +.RE +.IP \[bu] 2 +\[lq]Minio\[rq] +.RS 2 +.IP \[bu] 2 +Minio Object Storage +.RE +.IP \[bu] 2 +\[lq]Netease\[rq] +.RS 2 +.IP \[bu] 2 +Netease Object Storage (NOS) +.RE +.IP \[bu] 2 +\[lq]Wasabi\[rq] +.RS 2 +.IP \[bu] 2 +Wasabi Object Storage +.RE +.IP \[bu] 2 +\[lq]Other\[rq] +.RS 2 +.IP \[bu] 2 +Any other S3 compatible provider +.RE +.RE +.SS \[en]s3\-env\-auth +.PP +Get AWS credentials from runtime (environment variables or EC2/ECS meta +data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +.IP \[bu] 2 +Config: env_auth +.IP \[bu] 2 +Env Var: RCLONE_S3_ENV_AUTH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]false\[rq] +.RS 2 +.IP \[bu] 2 +Enter AWS credentials in the next step +.RE +.IP \[bu] 2 +\[lq]true\[rq] +.RS 2 +.IP \[bu] 2 +Get AWS credentials from the environment (env vars or IAM) +.RE +.RE +.SS \[en]s3\-access\-key\-id +.PP +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +.IP \[bu] 2 +Config: access_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_ACCESS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]s3\-secret\-access\-key +.PP +AWS Secret Access Key (password) Leave blank for anonymous access or +runtime credentials. +.IP \[bu] 2 +Config: secret_access_key +.IP \[bu] 2 +Env Var: RCLONE_S3_SECRET_ACCESS_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]s3\-region +.PP +Region to connect to. +.IP \[bu] 2 +Config: region +.IP \[bu] 2 +Env Var: RCLONE_S3_REGION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]us\-east\-1\[rq] +.RS 2 +.IP \[bu] 2 +The default endpoint \- a good choice if you are unsure. +.IP \[bu] 2 +US Region, Northern Virginia or Pacific Northwest. +.IP \[bu] 2 +Leave location constraint empty. +.RE +.IP \[bu] 2 +\[lq]us\-east\-2\[rq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region +.IP \[bu] 2 +Needs location constraint us\-east\-2. +.RE +.IP \[bu] 2 +\[lq]us\-west\-2\[rq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region +.IP \[bu] 2 +Needs location constraint us\-west\-2. +.RE +.IP \[bu] 2 +\[lq]us\-west\-1\[rq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region +.IP \[bu] 2 +Needs location constraint us\-west\-1. +.RE +.IP \[bu] 2 +\[lq]ca\-central\-1\[rq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region +.IP \[bu] 2 +Needs location constraint ca\-central\-1. +.RE +.IP \[bu] 2 +\[lq]eu\-west\-1\[rq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region +.IP \[bu] 2 +Needs location constraint EU or eu\-west\-1. +.RE +.IP \[bu] 2 +\[lq]eu\-west\-2\[rq] +.RS 2 +.IP \[bu] 2 +EU (London) Region +.IP \[bu] 2 +Needs location constraint eu\-west\-2. +.RE +.IP \[bu] 2 +\[lq]eu\-north\-1\[rq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region +.IP \[bu] 2 +Needs location constraint eu\-north\-1. +.RE +.IP \[bu] 2 +\[lq]eu\-central\-1\[rq] +.RS 2 +.IP \[bu] 2 +EU (Frankfurt) Region +.IP \[bu] 2 +Needs location constraint eu\-central\-1. +.RE +.IP \[bu] 2 +\[lq]ap\-southeast\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-1. +.RE +.IP \[bu] 2 +\[lq]ap\-southeast\-2\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region +.IP \[bu] 2 +Needs location constraint ap\-southeast\-2. +.RE +.IP \[bu] 2 +\[lq]ap\-northeast\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region +.IP \[bu] 2 +Needs location constraint ap\-northeast\-1. +.RE +.IP \[bu] 2 +\[lq]ap\-northeast\-2\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) +.IP \[bu] 2 +Needs location constraint ap\-northeast\-2. +.RE +.IP \[bu] 2 +\[lq]ap\-south\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) +.IP \[bu] 2 +Needs location constraint ap\-south\-1. +.RE +.IP \[bu] 2 +\[lq]ap\-east\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Patific (Hong Kong) Region +.IP \[bu] 2 +Needs location constraint ap\-east\-1. +.RE +.IP \[bu] 2 +\[lq]sa\-east\-1\[rq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region +.IP \[bu] 2 +Needs location constraint sa\-east\-1. +.RE +.RE +.SS \[en]s3\-region +.PP +Region to connect to. +Leave blank if you are using an S3 clone and you don\[cq]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 +\[lq]other\-v2\-signature\[rq] +.RS 2 +.IP \[bu] 2 +Use this only if v4 signatures don\[cq]t work, eg pre Jewel/v10 CEPH. +.RE +.RE +.SS \[en]s3\-endpoint +.PP +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]s3\-endpoint +.PP +Endpoint for IBM COS S3 API. +Specify if using an IBM COS On Premise. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]s3\-api.us\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Dallas Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Washington DC Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region San Jose Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.us\-east.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Region East Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.us\-east.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Region East Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.us\-south.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +US Region South Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.us\-south.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +US Region South Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.eu\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.fra\-eu\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.mil\-eu\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.ams\-eu\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.eu\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.fra\-eu\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Frankfurt Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.mil\-eu\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Milan Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.ams\-eu\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Amsterdam Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.eu\-gb.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.eu\-gb.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.ap\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.tok\-ap\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.hkg\-ap\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.seo\-ap\-geo.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.ap\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.tok\-ap\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Tokyo Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.hkg\-ap\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional HongKong Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.seo\-ap\-geo.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cross Regional Seoul Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.mel01.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.mel01.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Single Site Private Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.tor01.objectstorage.softlayer.net\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Endpoint +.RE +.IP \[bu] 2 +\[lq]s3.tor01.objectstorage.service.networklayer.com\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Single Site Private Endpoint +.RE +.RE +.SS \[en]s3\-endpoint +.PP +Endpoint for OSS API. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]oss\-cn\-hangzhou.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +East China 1 (Hangzhou) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-shanghai.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +East China 2 (Shanghai) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-qingdao.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +North China 1 (Qingdao) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-beijing.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +North China 2 (Beijing) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-zhangjiakou.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +North China 3 (Zhangjiakou) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-huhehaote.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +North China 5 (Huhehaote) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-shenzhen.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +South China 1 (Shenzhen) +.RE +.IP \[bu] 2 +\[lq]oss\-cn\-hongkong.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Hong Kong (Hong Kong) +.RE +.IP \[bu] 2 +\[lq]oss\-us\-west\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +US West 1 (Silicon Valley) +.RE +.IP \[bu] 2 +\[lq]oss\-us\-east\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +US East 1 (Virginia) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-southeast\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 1 (Singapore) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-southeast\-2.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 2 (Sydney) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-southeast\-3.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Southeast Asia Southeast 3 (Kuala Lumpur) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-southeast\-5.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Southeast 5 (Jakarta) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-northeast\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific Northeast 1 (Japan) +.RE +.IP \[bu] 2 +\[lq]oss\-ap\-south\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific South 1 (Mumbai) +.RE +.IP \[bu] 2 +\[lq]oss\-eu\-central\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Central Europe 1 (Frankfurt) +.RE +.IP \[bu] 2 +\[lq]oss\-eu\-west\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +West Europe (London) +.RE +.IP \[bu] 2 +\[lq]oss\-me\-east\-1.aliyuncs.com\[rq] +.RS 2 +.IP \[bu] 2 +Middle East 1 (Dubai) +.RE +.RE +.SS \[en]s3\-endpoint +.PP +Endpoint for S3 API. +Required when using an S3 clone. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]objects\-us\-east\-1.dream.io\[rq] +.RS 2 +.IP \[bu] 2 +Dream Objects endpoint +.RE +.IP \[bu] 2 +\[lq]nyc3.digitaloceanspaces.com\[rq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces New York 3 +.RE +.IP \[bu] 2 +\[lq]ams3.digitaloceanspaces.com\[rq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Amsterdam 3 +.RE +.IP \[bu] 2 +\[lq]sgp1.digitaloceanspaces.com\[rq] +.RS 2 +.IP \[bu] 2 +Digital Ocean Spaces Singapore 1 +.RE +.IP \[bu] 2 +\[lq]s3.wasabisys.com\[rq] +.RS 2 +.IP \[bu] 2 +Wasabi US East endpoint +.RE +.IP \[bu] 2 +\[lq]s3.us\-west\-1.wasabisys.com\[rq] +.RS 2 +.IP \[bu] 2 +Wasabi US West endpoint +.RE +.IP \[bu] 2 +\[lq]s3.eu\-central\-1.wasabisys.com\[rq] +.RS 2 +.IP \[bu] 2 +Wasabi EU Central endpoint +.RE +.RE +.SS \[en]s3\-location\-constraint +.PP +Location constraint \- must be set to match the Region. +Used when creating buckets only. +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[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 +\[lq]us\-east\-2\[rq] +.RS 2 +.IP \[bu] 2 +US East (Ohio) Region. +.RE +.IP \[bu] 2 +\[lq]us\-west\-2\[rq] +.RS 2 +.IP \[bu] 2 +US West (Oregon) Region. +.RE +.IP \[bu] 2 +\[lq]us\-west\-1\[rq] +.RS 2 +.IP \[bu] 2 +US West (Northern California) Region. +.RE +.IP \[bu] 2 +\[lq]ca\-central\-1\[rq] +.RS 2 +.IP \[bu] 2 +Canada (Central) Region. +.RE +.IP \[bu] 2 +\[lq]eu\-west\-1\[rq] +.RS 2 +.IP \[bu] 2 +EU (Ireland) Region. +.RE +.IP \[bu] 2 +\[lq]eu\-west\-2\[rq] +.RS 2 +.IP \[bu] 2 +EU (London) Region. +.RE +.IP \[bu] 2 +\[lq]eu\-north\-1\[rq] +.RS 2 +.IP \[bu] 2 +EU (Stockholm) Region. +.RE +.IP \[bu] 2 +\[lq]EU\[rq] +.RS 2 +.IP \[bu] 2 +EU Region. +.RE +.IP \[bu] 2 +\[lq]ap\-southeast\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Singapore) Region. +.RE +.IP \[bu] 2 +\[lq]ap\-southeast\-2\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Sydney) Region. +.RE +.IP \[bu] 2 +\[lq]ap\-northeast\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Tokyo) Region. +.RE +.IP \[bu] 2 +\[lq]ap\-northeast\-2\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Seoul) +.RE +.IP \[bu] 2 +\[lq]ap\-south\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Mumbai) +.RE +.IP \[bu] 2 +\[lq]ap\-east\-1\[rq] +.RS 2 +.IP \[bu] 2 +Asia Pacific (Hong Kong) +.RE +.IP \[bu] 2 +\[lq]sa\-east\-1\[rq] +.RS 2 +.IP \[bu] 2 +South America (Sao Paulo) Region. +.RE +.RE +.SS \[en]s3\-location\-constraint +.PP +Location constraint \- must match endpoint when using IBM Cloud Public. +For on\-prem COS, do not make a selection from this list, hit enter +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]us\-standard\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Standard +.RE +.IP \[bu] 2 +\[lq]us\-vault\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Vault +.RE +.IP \[bu] 2 +\[lq]us\-cold\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Cold +.RE +.IP \[bu] 2 +\[lq]us\-flex\[rq] +.RS 2 +.IP \[bu] 2 +US Cross Region Flex +.RE +.IP \[bu] 2 +\[lq]us\-east\-standard\[rq] +.RS 2 +.IP \[bu] 2 +US East Region Standard +.RE +.IP \[bu] 2 +\[lq]us\-east\-vault\[rq] +.RS 2 +.IP \[bu] 2 +US East Region Vault +.RE +.IP \[bu] 2 +\[lq]us\-east\-cold\[rq] +.RS 2 +.IP \[bu] 2 +US East Region Cold +.RE +.IP \[bu] 2 +\[lq]us\-east\-flex\[rq] +.RS 2 +.IP \[bu] 2 +US East Region Flex +.RE +.IP \[bu] 2 +\[lq]us\-south\-standard\[rq] +.RS 2 +.IP \[bu] 2 +US South Region Standard +.RE +.IP \[bu] 2 +\[lq]us\-south\-vault\[rq] +.RS 2 +.IP \[bu] 2 +US South Region Vault +.RE +.IP \[bu] 2 +\[lq]us\-south\-cold\[rq] +.RS 2 +.IP \[bu] 2 +US South Region Cold +.RE +.IP \[bu] 2 +\[lq]us\-south\-flex\[rq] +.RS 2 +.IP \[bu] 2 +US South Region Flex +.RE +.IP \[bu] 2 +\[lq]eu\-standard\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Standard +.RE +.IP \[bu] 2 +\[lq]eu\-vault\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Vault +.RE +.IP \[bu] 2 +\[lq]eu\-cold\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Cold +.RE +.IP \[bu] 2 +\[lq]eu\-flex\[rq] +.RS 2 +.IP \[bu] 2 +EU Cross Region Flex +.RE +.IP \[bu] 2 +\[lq]eu\-gb\-standard\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Standard +.RE +.IP \[bu] 2 +\[lq]eu\-gb\-vault\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Vault +.RE +.IP \[bu] 2 +\[lq]eu\-gb\-cold\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Cold +.RE +.IP \[bu] 2 +\[lq]eu\-gb\-flex\[rq] +.RS 2 +.IP \[bu] 2 +Great Britain Flex +.RE +.IP \[bu] 2 +\[lq]ap\-standard\[rq] +.RS 2 +.IP \[bu] 2 +APAC Standard +.RE +.IP \[bu] 2 +\[lq]ap\-vault\[rq] +.RS 2 +.IP \[bu] 2 +APAC Vault +.RE +.IP \[bu] 2 +\[lq]ap\-cold\[rq] +.RS 2 +.IP \[bu] 2 +APAC Cold +.RE +.IP \[bu] 2 +\[lq]ap\-flex\[rq] +.RS 2 +.IP \[bu] 2 +APAC Flex +.RE +.IP \[bu] 2 +\[lq]mel01\-standard\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Standard +.RE +.IP \[bu] 2 +\[lq]mel01\-vault\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Vault +.RE +.IP \[bu] 2 +\[lq]mel01\-cold\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Cold +.RE +.IP \[bu] 2 +\[lq]mel01\-flex\[rq] +.RS 2 +.IP \[bu] 2 +Melbourne Flex +.RE +.IP \[bu] 2 +\[lq]tor01\-standard\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Standard +.RE +.IP \[bu] 2 +\[lq]tor01\-vault\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Vault +.RE +.IP \[bu] 2 +\[lq]tor01\-cold\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Cold +.RE +.IP \[bu] 2 +\[lq]tor01\-flex\[rq] +.RS 2 +.IP \[bu] 2 +Toronto Flex +.RE +.RE +.SS \[en]s3\-location\-constraint +.PP +Location constraint \- must be set to match the Region. +Leave blank if not sure. +Used when creating buckets only. +.IP \[bu] 2 +Config: location_constraint +.IP \[bu] 2 +Env Var: RCLONE_S3_LOCATION_CONSTRAINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]s3\-acl +.PP +Canned ACL used when creating buckets and storing or copying objects. +.PP +This ACL is used for creating objects and if bucket_acl isn\[cq]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\[cq]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 +\[lq]private\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[lq]public\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[lq]public\-read\-write\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[lq]authenticated\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.IP \[bu] 2 +\[lq]bucket\-owner\-read\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets FULL_CONTROL. +Bucket owner gets READ access. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[lq]bucket\-owner\-full\-control\[rq] +.RS 2 +.IP \[bu] 2 +Both the object owner and the bucket owner get FULL_CONTROL over the +object. +.IP \[bu] 2 +If you specify this canned ACL when creating a bucket, Amazon S3 ignores +it. +.RE +.IP \[bu] 2 +\[lq]private\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise COS +.RE +.IP \[bu] 2 +\[lq]public\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), +On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[lq]public\-read\-write\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +This acl is available on IBM Cloud (Infra), On\-Premise IBM COS +.RE +.IP \[bu] 2 +\[lq]authenticated\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +Not supported on Buckets. +This acl is available on IBM Cloud (Infra) and On\-Premise IBM COS +.RE +.RE +.SS \[en]s3\-server\-side\-encryption +.PP +The server\-side encryption algorithm used when storing this object in +S3. +.IP \[bu] 2 +Config: server_side_encryption +.IP \[bu] 2 +Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +None +.RE +.IP \[bu] 2 +\[lq]AES256\[rq] +.RS 2 +.IP \[bu] 2 +AES256 +.RE +.IP \[bu] 2 +\[lq]aws:kms\[rq] +.RS 2 +.IP \[bu] 2 +aws:kms +.RE +.RE +.SS \[en]s3\-sse\-kms\-key\-id +.PP +If using KMS ID you must provide the ARN of Key. +.IP \[bu] 2 +Config: sse_kms_key_id +.IP \[bu] 2 +Env Var: RCLONE_S3_SSE_KMS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[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 \[en]s3\-storage\-class +.PP +The storage class to use when storing new objects in S3. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[lq]STANDARD\[rq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[lq]REDUCED_REDUNDANCY\[rq] +.RS 2 +.IP \[bu] 2 +Reduced redundancy storage class +.RE +.IP \[bu] 2 +\[lq]STANDARD_IA\[rq] +.RS 2 +.IP \[bu] 2 +Standard Infrequent Access storage class +.RE +.IP \[bu] 2 +\[lq]ONEZONE_IA\[rq] +.RS 2 +.IP \[bu] 2 +One Zone Infrequent Access storage class +.RE +.IP \[bu] 2 +\[lq]GLACIER\[rq] +.RS 2 +.IP \[bu] 2 +Glacier storage class +.RE +.IP \[bu] 2 +\[lq]DEEP_ARCHIVE\[rq] +.RS 2 +.IP \[bu] 2 +Glacier Deep Archive storage class +.RE +.IP \[bu] 2 +\[lq]INTELLIGENT_TIERING\[rq] +.RS 2 +.IP \[bu] 2 +Intelligent\-Tiering storage class +.RE +.RE +.SS \[en]s3\-storage\-class +.PP +The storage class to use when storing new objects in OSS. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_S3_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[lq]STANDARD\[rq] +.RS 2 +.IP \[bu] 2 +Standard storage class +.RE +.IP \[bu] 2 +\[lq]GLACIER\[rq] +.RS 2 +.IP \[bu] 2 +Archive storage mode. +.RE +.IP \[bu] 2 +\[lq]STANDARD_IA\[rq] +.RS 2 +.IP \[bu] 2 +Infrequent access storage mode. +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to s3 (Amazon S3 Compliant +Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, +Minio, etc)). +.SS \[en]s3\-bucket\-acl +.PP +Canned ACL used when creating buckets. +.PP +For more info visit +https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +.PP +Note that this ACL is applied when only when creating buckets. +If it isn\[cq]t set then \[lq]acl\[rq] is used instead. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_S3_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]private\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +No one else has access rights (default). +.RE +.IP \[bu] 2 +\[lq]public\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ access. +.RE +.IP \[bu] 2 +\[lq]public\-read\-write\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AllUsers group gets READ and WRITE access. +.IP \[bu] 2 +Granting this on a bucket is generally not recommended. +.RE +.IP \[bu] 2 +\[lq]authenticated\-read\[rq] +.RS 2 +.IP \[bu] 2 +Owner gets FULL_CONTROL. +The AuthenticatedUsers group gets READ access. +.RE +.RE +.SS \[en]s3\-upload\-cutoff +.PP +Cutoff for switching to chunked upload +.PP +Any files larger than this will be uploaded in chunks of chunk_size. +The minimum is 0 and the maximum is 5GB. +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_S3_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \[en]s3\-chunk\-size +.PP +Chunk size to use for uploading. +.PP +When uploading files larger than upload_cutoff or files with unknown +size (eg from \[lq]rclone rcat\[rq] or uploaded with \[lq]rclone +mount\[rq] or google photos or google docs) they will be uploaded as +multipart uploads using this chunk size. +.PP +Note that \[lq]\[en]s3\-upload\-concurrency\[rq] chunks of this size are +buffered in memory per transfer. +.PP +If you are transferring large files over high speed links and you have +enough memory, then increasing this will speed up the transfers. +.PP +Rclone will automatically increase the chunk size when uploading a large +file of known size to stay below the 10,000 chunks limit. +.PP +Files of unknown size are uploaded with the configured chunk_size. +Since the default chunk size is 5MB and there can be at most 10,000 +chunks, this means that by default the maximum size of file you can +stream upload is 48GB. +If you wish to stream upload larger files then you will need to increase +chunk_size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_S3_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.SS \[en]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: 5G +.SS \[en]s3\-disable\-checksum +.PP +Don\[cq]t store MD5 checksum with object metadata +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_S3_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]s3\-session\-token +.PP +An AWS session token +.IP \[bu] 2 +Config: session_token +.IP \[bu] 2 +Env Var: RCLONE_S3_SESSION_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]s3\-upload\-concurrency +.PP +Concurrency for multipart uploads. +.PP +This is the number of chunks of the same file that are uploaded +concurrently. +.PP +If you are uploading small numbers of large file over high speed link +and these uploads do not fully utilize your bandwidth, then increasing +this may help to speed up the transfers. +.IP \[bu] 2 +Config: upload_concurrency +.IP \[bu] 2 +Env Var: RCLONE_S3_UPLOAD_CONCURRENCY +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 4 +.SS \[en]s3\-force\-path\-style +.PP +If true use path style access if false use virtual hosted style. +.PP +If this is true (the default) then rclone will use path style access, if +false then rclone will use virtual path style. +See the AWS S3 +docs (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro) +for more info. +.PP +Some providers (eg AWS, Aliyun OSS or Netease 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 \[en]s3\-v2\-auth +.PP +If true use v2 authentication. +.PP +If this is false (the default) then rclone will use v4 authentication. +If it is set then rclone will use v2 authentication. +.PP +Use this only if v4 signatures don\[cq]t work, eg pre Jewel/v10 CEPH. +.IP \[bu] 2 +Config: v2_auth +.IP \[bu] 2 +Env Var: RCLONE_S3_V2_AUTH +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]s3\-use\-accelerate\-endpoint +.PP +If true use the AWS S3 accelerated endpoint. +.PP +See: AWS S3 Transfer +acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html) +.IP \[bu] 2 +Config: use_accelerate_endpoint +.IP \[bu] 2 +Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]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 \[en]s3\-list\-chunk +.PP +Size of listing chunk (response list for each ListObject S3 request). +.PP +This option is also known as \[lq]MaxKeys\[rq], \[lq]max\-items\[rq], or +\[lq]page\-size\[rq] 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 \[lq]rgw list buckets max +chunk\[rq] 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 \[en]s3\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/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 Anonymous access to public buckets +.PP +If you want to use rclone to access a public bucket, configure with a +blank \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R]. +Your config should end up looking like this: +.IP +.nf +\f[C] +[anons3] +type = s3 +provider = AWS +env_auth = false +access_key_id = +secret_access_key = +region = us\-east\-1 +endpoint = +location_constraint = +acl = private +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +Then use it as normal with the name of the public bucket, eg +.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. +.SS Ceph +.PP +Ceph (https://ceph.com/) is an open source unified, distributed storage +system designed for excellent performance, reliability and scalability. +It has an S3 compatible object storage interface. +.PP +To use rclone with Ceph, configure as above but leave the region blank +and set the endpoint. +You should end up with something like this in your config: +.IP +.nf +\f[C] +[ceph] +type = s3 +provider = Ceph +env_auth = false +access_key_id = XXX +secret_access_key = YYY +region = +endpoint = https://ceph.endpoint.example.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +If you are using an older version of CEPH, eg 10.2.x Jewel, then you may +need to supply the parameter \f[C]\-\-s3\-upload\-cutoff 0\f[R] or put +this in the config file as \f[C]upload_cutoff 0\f[R] to work around a +bug which causes uploading of small files to fail. +.PP +Note also that Ceph sometimes puts \f[C]/\f[R] in the passwords it gives +users. +If you read the secret access key using the command line tools you will +get a JSON blob with the \f[C]/\f[R] escaped as \f[C]\[rs]/\f[R]. +Make sure you only write \f[C]/\f[R] in the secret access key. +.PP +Eg the dump from Ceph looks something like this (irrelevant keys +removed). +.IP +.nf +\f[C] +{ + \[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 +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] +[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 \[lq]Applications & +API (https://cloud.digitalocean.com/settings/api/tokens)\[rq] page of +the DigitalOcean control panel. +They will be needed when promted by \f[C]rclone config\f[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 +The resulting configuration file should look like: +.IP +.nf +\f[C] +[spaces] +type = s3 +provider = DigitalOcean +env_auth = false +access_key_id = YOUR_ACCESS_KEY +secret_access_key = YOUR_SECRET_KEY +region = +endpoint = nyc3.digitaloceanspaces.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.PP +Once configured, you can create a new Space and begin copying files. +For example: +.IP +.nf +\f[C] +rclone mkdir spaces:my\-new\-space +rclone copy /path/to/files spaces:my\-new\-space +\f[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: +.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 + 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 \[lq]s3\[rq] storage. +.IP +.nf +\f[C] +Choose a number from below, or type in your own value + 1 / Alias for an existing remote + \[rs] \[dq]alias\[dq] + 2 / Amazon Drive + \[rs] \[dq]amazon cloud drive\[dq] + 3 / Amazon S3 Complaint Storage Providers (Dreamhost, Ceph, Minio, IBM COS) + \[rs] \[dq]s3\[dq] + 4 / Backblaze B2 + \[rs] \[dq]b2\[dq] +[snip] + 23 / http Connection + \[rs] \[dq]http\[dq] +Storage> 3 +\f[R] +.fi +.IP "4." 3 +Select IBM COS as the S3 Storage Provider. +.IP +.nf +\f[C] +Choose the S3 provider. +Choose a number from below, or type in your own value + 1 / Choose this option to configure Storage to AWS S3 + \[rs] \[dq]AWS\[dq] + 2 / Choose this option to configure Storage to Ceph Systems + \[rs] \[dq]Ceph\[dq] + 3 / Choose this option to configure Storage to Dreamhost + \[rs] \[dq]Dreamhost\[dq] + 4 / Choose this option to the configure Storage to IBM COS S3 + \[rs] \[dq]IBMCOS\[dq] + 5 / Choose this option to the configure Storage to Minio + \[rs] \[dq]Minio\[dq] + Provider>4 +\f[R] +.fi +.IP "5." 3 +Enter the Access Key and Secret. +.IP +.nf +\f[C] + AWS Access Key ID \- leave blank for anonymous access or runtime credentials. + access_key_id> <> + AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. + secret_access_key> <> +\f[R] +.fi +.IP "6." 3 +Specify the endpoint for IBM COS. +For Public IBM COS, choose from the option below. +For On Premise IBM COS, enter an enpoint address. +.IP +.nf +\f[C] + Endpoint for IBM COS S3 API. + Specify if using an IBM COS On Premise. + Choose a number from below, or type in your own value + 1 / US Cross Region Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.softlayer.net\[dq] + 2 / US Cross Region Dallas Endpoint + \[rs] \[dq]s3\-api.dal.us\-geo.objectstorage.softlayer.net\[dq] + 3 / US Cross Region Washington DC Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.softlayer.net\[dq] + 4 / US Cross Region San Jose Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.softlayer.net\[dq] + 5 / US Cross Region Private Endpoint + \[rs] \[dq]s3\-api.us\-geo.objectstorage.service.networklayer.com\[dq] + 6 / US Cross Region Dallas Private Endpoint + \[rs] \[dq]s3\-api.dal\-us\-geo.objectstorage.service.networklayer.com\[dq] + 7 / US Cross Region Washington DC Private Endpoint + \[rs] \[dq]s3\-api.wdc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 8 / US Cross Region San Jose Private Endpoint + \[rs] \[dq]s3\-api.sjc\-us\-geo.objectstorage.service.networklayer.com\[dq] + 9 / US Region East Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.softlayer.net\[dq] + 10 / US Region East Private Endpoint + \[rs] \[dq]s3.us\-east.objectstorage.service.networklayer.com\[dq] + 11 / US Region South Endpoint +[snip] + 34 / Toronto Single Site Private Endpoint + \[rs] \[dq]s3.tor01.objectstorage.service.networklayer.com\[dq] + endpoint>1 +\f[R] +.fi +.IP "7." 3 +Specify a IBM COS Location Constraint. +The location constraint must match endpoint when using IBM Cloud Public. +For on\-prem COS, do not make a selection from this list, hit enter +.IP +.nf +\f[C] + 1 / US Cross Region Standard + \[rs] \[dq]us\-standard\[dq] + 2 / US Cross Region Vault + \[rs] \[dq]us\-vault\[dq] + 3 / US Cross Region Cold + \[rs] \[dq]us\-cold\[dq] + 4 / US Cross Region Flex + \[rs] \[dq]us\-flex\[dq] + 5 / US East Region Standard + \[rs] \[dq]us\-east\-standard\[dq] + 6 / US East Region Vault + \[rs] \[dq]us\-east\-vault\[dq] + 7 / US East Region Cold + \[rs] \[dq]us\-east\-cold\[dq] + 8 / US East Region Flex + \[rs] \[dq]us\-east\-flex\[dq] + 9 / US South Region Standard + \[rs] \[dq]us\-south\-standard\[dq] + 10 / US South Region Vault + \[rs] \[dq]us\-south\-vault\[dq] +[snip] + 32 / Toronto Flex + \[rs] \[dq]tor01\-flex\[dq] +location_constraint>1 +\f[R] +.fi +.IP "9." 3 +Specify a canned ACL. +IBM Cloud (Strorage) supports \[lq]public\-read\[rq] and +\[lq]private\[rq]. +IBM Cloud(Infra) supports all the canned ACLs. +On\-Premise COS supports all the canned ACLs. +.IP +.nf +\f[C] +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On\-Premise COS + \[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 +\[lq]remote\[rq] then quit. +The config file should look like this +.IP +.nf +\f[C] + [xxx] + type = s3 + Provider = IBMCOS + access_key_id = xxx + secret_access_key = yyy + endpoint = s3\-api.us\-geo.objectstorage.softlayer.net + location_constraint = us\-standard + acl = private +\f[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 +env_auth = false +endpoint = s3.nl\-ams.scw.cloud +access_key_id = SCWXXXXXXXXXXXXXX +secret_access_key = 1111111\-2222\-3333\-44444\-55555555555555 +region = nl\-ams +location_constraint = +acl = private +force_path_style = false +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Wasabi +.PP +Wasabi (https://wasabi.com) is a cloud\-based object storage service for +a broad range of applications and use cases. +Wasabi is designed for individuals and organizations that require a +high\-performance, reliable, and secure data storage infrastructure at +minimal cost. +.PP +Wasabi provides an S3 interface which can be configured for use with +rclone like this. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +n/s> n +name> wasabi +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Amazon S3 (also Dreamhost, Ceph, Minio) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> YOURACCESSKEY +AWS Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> YOURSECRETACCESSKEY +Region to connect to. +Choose a number from below, or type in your own value + / The default endpoint \- a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \[rs] \[dq]us\-east\-1\[dq] +[snip] +region> us\-east\-1 +Endpoint for S3 API. +Leave blank if using AWS to use the default endpoint for the region. +Specify if using an S3 clone such as Ceph. +endpoint> s3.wasabisys.com +Location constraint \- must be set to match the Region. Used when creating buckets only. +Choose a number from below, or type in your own value + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \[rs] \[dq]\[dq] +[snip] +location_constraint> +Canned ACL used when creating buckets and/or storing objects in S3. +For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl\-overview.html#canned\-acl +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] +[snip] +acl> +The server\-side encryption algorithm used when storing this object in S3. +Choose a number from below, or type in your own value + 1 / None + \[rs] \[dq]\[dq] + 2 / AES256 + \[rs] \[dq]AES256\[dq] +server_side_encryption> +The storage class to use when storing objects in S3. +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Reduced redundancy storage class + \[rs] \[dq]REDUCED_REDUNDANCY\[dq] + 4 / Standard Infrequent Access storage class + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[wasabi] +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = us\-east\-1 +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +This will leave the config file looking like this. +.IP +.nf +\f[C] +[wasabi] +type = s3 +provider = Wasabi +env_auth = false +access_key_id = YOURACCESSKEY +secret_access_key = YOURSECRETACCESSKEY +region = +endpoint = s3.wasabisys.com +location_constraint = +acl = +server_side_encryption = +storage_class = +\f[R] +.fi +.SS Alibaba OSS +.PP +Here is an example of making an Alibaba Cloud (Aliyun) +OSS (https://www.alibabacloud.com/product/oss/) configuration. +First run: +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> oss +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] + 4 / Amazon S3 Compliant Storage Provider (AWS, Alibaba, Ceph, Digital Ocean, Dreamhost, IBM COS, Minio, etc) + \[rs] \[dq]s3\[dq] +[snip] +Storage> s3 +Choose your S3 provider. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Amazon Web Services (AWS) S3 + \[rs] \[dq]AWS\[dq] + 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun + \[rs] \[dq]Alibaba\[dq] + 3 / Ceph Object Storage + \[rs] \[dq]Ceph\[dq] +[snip] +provider> Alibaba +Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). +Only applies if access_key_id and secret_access_key is blank. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +Choose a number from below, or type in your own value + 1 / Enter AWS credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get AWS credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +AWS Access Key ID. +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> accesskeyid +AWS Secret Access Key (password) +Leave blank for anonymous access or runtime credentials. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +secret_access_key> secretaccesskey +Endpoint for OSS API. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / East China 1 (Hangzhou) + \[rs] \[dq]oss\-cn\-hangzhou.aliyuncs.com\[dq] + 2 / East China 2 (Shanghai) + \[rs] \[dq]oss\-cn\-shanghai.aliyuncs.com\[dq] + 3 / North China 1 (Qingdao) + \[rs] \[dq]oss\-cn\-qingdao.aliyuncs.com\[dq] +[snip] +endpoint> 1 +Canned ACL used when creating buckets and storing or copying objects. + +Note that this ACL is applied when server side copying objects as S3 +doesn\[aq]t copy the ACL from the source but rather writes a fresh one. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Owner gets FULL_CONTROL. No one else has access rights (default). + \[rs] \[dq]private\[dq] + 2 / Owner gets FULL_CONTROL. The AllUsers group gets READ access. + \[rs] \[dq]public\-read\[dq] + / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. +[snip] +acl> 1 +The storage class to use when storing new objects in OSS. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Default + \[rs] \[dq]\[dq] + 2 / Standard storage class + \[rs] \[dq]STANDARD\[dq] + 3 / Archive storage mode. + \[rs] \[dq]GLACIER\[dq] + 4 / Infrequent access storage mode. + \[rs] \[dq]STANDARD_IA\[dq] +storage_class> 1 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[oss] +type = s3 +provider = Alibaba +env_auth = false +access_key_id = accesskeyid +secret_access_key = secretaccesskey +endpoint = oss\-cn\-hangzhou.aliyuncs.com +acl = private +storage_class = Standard +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Netease NOS +.PP +For Netease NOS configure as per the configurator +\f[C]rclone config\f[R] setting the provider \f[C]Netease\f[R]. +This will automatically set \f[C]force_path_style = false\f[R] which is +necessary for it to run properly. +.SS Backblaze B2 +.PP +B2 is Backblaze\[cq]s cloud storage +system (https://www.backblaze.com/b2/). +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +Here is an example of making a b2 configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +To authenticate you will either need your Account ID (a short hex +number) and Master Application Key (a long hex number) OR an Application +Key, which is the recommended method. +See below for further details on generating and using an Application +Key. +.IP +.nf +\f[C] +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 +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +Create 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 /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\[cq]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\[cq]t use the master Account ID. +If you try then B2 will return 401 errors. +.SS \[en]fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (/docs/#fast-list) for more details. +.SS Modified time +.PP +The modified time is stored as metadata on the object as +\f[C]X\-Bz\-Info\-src_last_modified_millis\f[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 (/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 (/overview/#invalid-utf8), as +they can\[cq]t be used in JSON strings. +.SS SHA1 checksums +.PP +The SHA1 checksums of the files are checked on upload and download and +will be used in the syncing process. +.PP +Large files (bigger than the limit in \f[C]\-\-b2\-upload\-cutoff\f[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 (/overview/#features) for exactly which remotes support +SHA1. +.PP +Sources which don\[cq]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 +\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 \[lq]hard delete\[rq] 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 \[en]backup\-dir (/docs/#backup-dir-dir) with rclone is the +recommended way of working around this. +.PP +If you wish to remove all the old versions then you can use the +\f[C]rclone cleanup remote:bucket\f[R] command which will delete all the +old versions of files, leaving the current ones intact. +You can also supply a path and only old versions under that path will be +deleted, eg \f[C]rclone cleanup remote:bucket/path/to/stuff\f[R]. +.PP +Note that \f[C]cleanup\f[R] will remove partially uploaded files from +the bucket if they are more than a day old. +.PP +When you \f[C]purge\f[R] a bucket, the current and the old versions will +be deleted then the bucket will be deleted. +.PP +However \f[C]delete\f[R] will cause the current versions of the files to +become hidden old versions. +.PP +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 +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 +.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\[cq]ve gone. +.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 +It is useful to know how many requests are sent to the server in +different scenarios. +.PP +All copy commands send the following 4 requests: +.IP +.nf +\f[C] +/b2api/v1/b2_authorize_account +/b2api/v1/b2_create_bucket +/b2api/v1/b2_list_buckets +/b2api/v1/b2_list_file_names +\f[R] +.fi +.PP +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: +.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: +.IP +.nf +\f[C] +/b2api/v1/b2_start_large_file +/b2api/v1/b2_get_upload_part_url +/b2api/v1/b2_upload_part/ +/b2api/v1/b2_finish_large_file +\f[R] +.fi +.SS Versions +.PP +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 +.IP +.nf +\f[C] +$ rclone \-q \-\-b2\-versions ls b2:cleanup\-test + 9 one.txt + 8 one\-v2016\-07\-04\-141032\-000.txt + 16 one\-v2016\-07\-04\-141003\-000.txt + 15 one\-v2016\-07\-02\-155621\-000.txt +\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\[cq]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: +.IP +.nf +\f[C] +\&./rclone link B2:bucket/path/to/file.txt +https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx +\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 +\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 +\f[R] +.fi +.SS Standard Options +.PP +Here are the standard options specific to b2 (Backblaze B2). +.SS \[en]b2\-account +.PP +Account ID or Application Key ID +.IP \[bu] 2 +Config: account +.IP \[bu] 2 +Env Var: RCLONE_B2_ACCOUNT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]b2\-key +.PP +Application Key +.IP \[bu] 2 +Config: key +.IP \[bu] 2 +Env Var: RCLONE_B2_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]b2\-hard\-delete +.PP +Permanently delete files on remote removal, otherwise hide files. +.IP \[bu] 2 +Config: hard_delete +.IP \[bu] 2 +Env Var: RCLONE_B2_HARD_DELETE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to b2 (Backblaze B2). +.SS \[en]b2\-endpoint +.PP +Endpoint for the service. +Leave blank normally. +.IP \[bu] 2 +Config: endpoint +.IP \[bu] 2 +Env Var: RCLONE_B2_ENDPOINT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]b2\-test\-mode +.PP +A flag string for X\-Bz\-Test\-Mode header for debugging. +.PP +This is for debugging purposes only. +Setting it to one of the strings below will cause b2 to return specific +errors: +.IP \[bu] 2 +\[lq]fail_some_uploads\[rq] +.IP \[bu] 2 +\[lq]expire_some_account_authorization_tokens\[rq] +.IP \[bu] 2 +\[lq]force_cap_exceeded\[rq] +.PP +These will be set in the \[lq]X\-Bz\-Test\-Mode\[rq] header which is +documented in the b2 integrations +checklist (https://www.backblaze.com/b2/docs/integration_checklist.html). +.IP \[bu] 2 +Config: test_mode +.IP \[bu] 2 +Env Var: RCLONE_B2_TEST_MODE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]b2\-versions +.PP +Include old versions in directory listings. +Note that when using this no file write operations are permitted, so you +can\[cq]t upload files or delete them. +.IP \[bu] 2 +Config: versions +.IP \[bu] 2 +Env Var: RCLONE_B2_VERSIONS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]b2\-upload\-cutoff +.PP +Cutoff for switching to chunked upload. +.PP +Files above this size will be uploaded in chunks of +\[lq]\[en]b2\-chunk\-size\[rq]. +.PP +This value should be set no larger than 4.657GiB (== 5GB). +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_B2_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 200M +.SS \[en]b2\-chunk\-size +.PP +Upload chunk size. +Must fit in memory. +.PP +When uploading large files, chunk the file into this size. +Note that these chunks are buffered in memory and there might a maximum +of \[lq]\[en]transfers\[rq] chunks in progress at once. +5,000,000 Bytes is the minimum size. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_B2_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 96M +.SS \[en]b2\-disable\-checksum +.PP +Disable checksums for large (> upload cutoff) files +.IP \[bu] 2 +Config: disable_checksum +.IP \[bu] 2 +Env Var: RCLONE_B2_DISABLE_CHECKSUM +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]b2\-download\-url +.PP +Custom endpoint for downloads. +.PP +This is usually set to a Cloudflare CDN URL as Backblaze offers free +egress for data downloaded through the Cloudflare network. +This is probably only useful for a public bucket. +Leave blank if you want to use the endpoint provided by Backblaze. +.IP \[bu] 2 +Config: download_url +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]b2\-download\-auth\-duration +.PP +Time before the authorization token will expire in s or suffix +ms|s|m|h|d. +.PP +The duration before the download authorization token will expire. +The minimum value is 1 second. +The maximum value is one week. +.IP \[bu] 2 +Config: download_auth_duration +.IP \[bu] 2 +Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1w +.SS \[en]b2\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_B2_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot +.SS Box +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.PP +The initial setup for Box involves getting a token from Box which you +can do either in your browser, or with a config.json downloaded from Box +to use JWT authentication. +\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. +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. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +config_json> +\[aq]enterprise\[aq] or \[aq]user\[aq] depending on the type of token being requested. +Enter a string value. Press Enter for the default (\[dq]user\[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 +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 \[lq]Enterprise\[rq] account type with Box with single +sign on (SSO), you need to create a password to use Box with rclone. +This can be done at your Enterprise Box account by going to Settings, +\[lq]Account\[rq] Tab, and then set the password in the +\[lq]Authentication\[rq] field. +.PP +Once you have done this, you can setup your Enterprise Box account using +the same procedure detailed above in the, using the password you have +just set. +.SS Invalid refresh token +.PP +According to the box +docs (https://developer.box.com/v2.0/docs/oauth-20#section-6-using-the-access-and-refresh-tokens): +.RS +.PP +Each refresh_token is valid for one use in 60 days. +.RE +.PP +This means that if you +.IP \[bu] 2 +Don\[cq]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 (/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 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 (/overview/#invalid-utf8), as +they can\[cq]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. +.SS Standard Options +.PP +Here are the standard options specific to box (Box). +.SS \[en]box\-client\-id +.PP +Box App Client Id. +Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]box\-client\-secret +.PP +Box App Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_BOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]box\-box\-config\-file +.PP +Box App config.json location Leave blank normally. +.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 \[en]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: \[lq]user\[rq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]user\[rq] +.RS 2 +.IP \[bu] 2 +Rclone should act on behalf of a user +.RE +.IP \[bu] 2 +\[lq]enterprise\[rq] +.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 \[en]box\-upload\-cutoff +.PP +Cutoff for switching to multipart upload (>= 50MB). +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_BOX_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 50M +.SS \[en]box\-commit\-retries +.PP +Max number of times to try committing a multipart file. +.IP \[bu] 2 +Config: commit_retries +.IP \[bu] 2 +Env Var: RCLONE_BOX_COMMIT_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \[en]box\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/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\[cq]t have a file called +\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.PP +Box file names can\[cq]t have the \f[C]\[rs]\f[R] character in. +rclone maps this to and from an identical looking unicode equivalent +\f[C]\[uFF3C]\f[R]. +.PP +Box only supports filenames up to 255 characters in length. +.SS Cache (BETA) +.PP +The \f[C]cache\f[R] remote wraps another existing remote and stores file +structure and its data for long running tasks like +\f[C]rclone mount\f[R]. +.PP +To get started you just need to have an existing remote which can be +configured with \f[C]cache\f[R]. +.PP +Here is an example of how to make a remote called \f[C]test\-cache\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> test\-cache +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Cache a remote + \[rs] \[dq]cache\[dq] +[snip] +Storage> cache +Remote to cache. +Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +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 +.IP +.nf +\f[C] +rclone lsd test\-cache: +\f[R] +.fi +.PP +List all the files in your drive +.IP +.nf +\f[C] +rclone ls test\-cache: +\f[R] +.fi +.PP +To start a cached mount +.IP +.nf +\f[C] +rclone mount \-\-allow\-other test\-cache: /var/tmp/test\-cache +\f[R] +.fi +.SS Write Features +.SS Offline uploading +.PP +In an effort to make writing through cache more reliable, the backend +now supports this feature which can be activated by specifying a +\f[C]cache\-tmp\-upload\-path\f[R]. +.PP +A files goes through these states when using this feature: +.IP "1." 3 +An upload is started (usually by copying a file on the cache remote) +.IP "2." 3 +When the copy to the temporary location is complete the file is part of +the cached remote and looks and behaves like any other file (reading +included) +.IP "3." 3 +After \f[C]cache\-tmp\-wait\-time\f[R] passes and the file is next in +line, \f[C]rclone move\f[R] is used to move the file to the cloud +provider +.IP "4." 3 +Reading the file still works during the upload but most modifications on +it will be prohibited +.IP "5." 3 +Once the move is complete the file is unlocked for modifications as it +becomes as any other regular file +.IP "6." 3 +If the file is being read through \f[C]cache\f[R] when it\[cq]s actually +deleted from the temporary path then \f[C]cache\f[R] will simply swap +the source to the cloud provider without interrupting the reading (small +blip can happen though) +.PP +Files are uploaded in sequence and only one file is uploaded at a time. +Uploads will be stored in a queue and be processed based on the order +they were added. +The queue and the temporary storage is persistent across restarts but +can be cleared on startup with the \f[C]\-\-cache\-db\-purge\f[R] flag. +.SS Write Support +.PP +Writes are supported through \f[C]cache\f[R]. +One caveat is that a mounted cache remote does not add any retry or +fallback mechanism to the upload operation. +This will depend on the implementation of the wrapped remote. +Consider using \f[C]Offline uploading\f[R] for reliable writes. +.PP +One special case is covered with \f[C]cache\-writes\f[R] which will +cache the file data at the same time as the upload when it is enabled +making it available from the cache store immediately once the upload is +finished. +.SS Read Features +.SS Multiple connections +.PP +To counter the high latency between a local PC where rclone is running +and cloud providers, the cache remote can split multiple requests to the +cloud provider for smaller file chunks and combines them together +locally where they can be available almost immediately before the reader +usually needs them. +.PP +This is similar to buffering when media files are played online. +Rclone will stay around the current marker but always try its best to +stay ahead and prepare the data before. +.SS Plex Integration +.PP +There is a direct integration with Plex which allows cache to detect +during reading if the file is in playback or not. +This helps cache to adapt how it queries the cloud provider depending on +what is needed for. +.PP +Scans will have a minimum amount of workers (1) while in a confirmed +playback cache will deploy the configured number of workers. +.PP +This integration opens the doorway to additional performance +improvements which will be explored in the near future. +.PP +\f[B]Note:\f[R] If Plex options are not configured, \f[C]cache\f[R] will +function with its configured options without adapting any of its +settings. +.PP +How to enable? +Run \f[C]rclone config\f[R] and add all the Plex options (endpoint, +username and password) in your remote and it will be automatically +enabled. +.PP +Affected settings: \- \f[C]cache\-workers\f[R]: \f[I]Configured +value\f[R] during confirmed playback or \f[I]1\f[R] all the other times +.SS Certificate Validation +.PP +When the Plex server is configured to only accept secure connections, it +is possible to use \f[C].plex.direct\f[R] URL\[cq]s to ensure +certificate validation succeeds. +These URL\[cq]s are used by Plex internally to connect to the Plex +server securely. +.PP +The format for this URL\[cq]s is the following: +.PP +https://ip\-with\-dots\-replaced.server\-hash.plex.direct:32400/ +.PP +The \f[C]ip\-with\-dots\-replaced\f[R] part can be any IPv4 address, +where the dots have been replaced with dashes, e.g.\ \f[C]127.0.0.1\f[R] +becomes \f[C]127\-0\-0\-1\f[R]. +.PP +To get the \f[C]server\-hash\f[R] part, the easiest way is to visit +.PP +https://plex.tv/api/resources?includeHttps=1&X\-Plex\-Token=your\-plex\-token +.PP +This page will list all the available Plex servers for your account with +at least one \f[C].plex.direct\f[R] link for each. +Copy one URL and replace the IP address with the desired address. +This can be used as the \f[C]plex_url\f[R] value. +.SS Known issues +.SS Mount and \[en]dir\-cache\-time +.PP +\[en]dir\-cache\-time controls the first layer of directory caching +which works at the mount layer. +Being an independent caching mechanism from the \f[C]cache\f[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 dependant +on them. +.PP +Any reports or feedback on how cache behaves on this OS is greatly +appreciated. +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1935 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1907 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1834 +.SS Risk of throttling +.PP +Future iterations of the cache backend will make use of the pooling +functionality of the cloud provider to synchronize and at the same time +make writing through it more tolerant to failures. +.PP +There are a couple of enhancements in track to add these but in the +meantime there is a valid concern that the expiring cache listings can +lead to cloud provider throttles or bans due to repeated queries on it +for very large mounts. +.PP +Some recommendations: \- don\[cq]t use a very small interval for entry +informations (\f[C]\-\-cache\-info\-age\f[R]) \- while writes aren\[cq]t +yet optimised, you can still write through \f[C]cache\f[R] which gives +you the advantage of adding the file in the cache at the same time if +configured to do so. +.PP +Future enhancements: +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1937 +.IP \[bu] 2 +https://github.com/rclone/rclone/issues/1936 +.SS cache and crypt +.PP +One common scenario is to keep your data encrypted in the cloud provider +using the \f[C]crypt\f[R] remote. +\f[C]crypt\f[R] uses a similar technique to wrap around an existing +remote and handles this translation in a seamless way. +.PP +There is an issue with wrapping the remotes in this order: \f[B]cloud +remote\f[R] \-> \f[B]crypt\f[R] \-> \f[B]cache\f[R] +.PP +During testing, I experienced a lot of bans with the remotes in this +order. +I suspect it might be related to how crypt opens files on the cloud +provider which makes it think we\[cq]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 (\[en]rc) +.PP +Cache supports the new \f[C]\-\-rc\f[R] mode in rclone and can be remote +controlled through the following end points: By default, the listener is +disabled if you do not add the flag. +.SS rc cache/expire +.PP +Purge a remote from the cache backend. +Supports either a directory or a file. +It supports both encrypted and unencrypted file names if cache is +wrapped by crypt. +.PP +Params: \- \f[B]remote\f[R] = path to remote \f[B](required)\f[R] \- +\f[B]withData\f[R] = true/false to delete cached data (chunks) as well +\f[I](optional, false by default)\f[R] +.SS Standard Options +.PP +Here are the standard options specific to cache (Cache a remote). +.SS \[en]cache\-remote +.PP +Remote to cache. +Normally should contain a `:' and a path, eg +\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe +\[lq]myremote:\[rq] (not recommended). +.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 \[en]cache\-plex\-url +.PP +The URL of the Plex server +.IP \[bu] 2 +Config: plex_url +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_URL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-plex\-username +.PP +The username of the Plex user +.IP \[bu] 2 +Config: plex_username +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_USERNAME +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-plex\-password +.PP +The password of the Plex user +.IP \[bu] 2 +Config: plex_password +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-chunk\-size +.PP +The size of a chunk (partial file data). +.PP +Use lower numbers for slower connections. +If the chunk size is changed, any downloaded chunks will be invalid and +cache\-chunk\-path will need to be cleared or unexpected EOF errors will +occur. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 5M +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]1m\[rq] +.RS 2 +.IP \[bu] 2 +1MB +.RE +.IP \[bu] 2 +\[lq]5M\[rq] +.RS 2 +.IP \[bu] 2 +5 MB +.RE +.IP \[bu] 2 +\[lq]10M\[rq] +.RS 2 +.IP \[bu] 2 +10 MB +.RE +.RE +.SS \[en]cache\-info\-age +.PP +How long to cache file structure information (directory listings, file +size, times etc). +If all write operations are done through the cache then you can safely +make this value very large as the cache store will also be updated in +real time. +.IP \[bu] 2 +Config: info_age +.IP \[bu] 2 +Env Var: RCLONE_CACHE_INFO_AGE +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 6h0m0s +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]1h\[rq] +.RS 2 +.IP \[bu] 2 +1 hour +.RE +.IP \[bu] 2 +\[lq]24h\[rq] +.RS 2 +.IP \[bu] 2 +24 hours +.RE +.IP \[bu] 2 +\[lq]48h\[rq] +.RS 2 +.IP \[bu] 2 +48 hours +.RE +.RE +.SS \[en]cache\-chunk\-total\-size +.PP +The total size that the chunks can take up on the local disk. +.PP +If the cache exceeds this value then it will start to delete the oldest +chunks until it goes under this value. +.IP \[bu] 2 +Config: chunk_total_size +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 10G +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]500M\[rq] +.RS 2 +.IP \[bu] 2 +500 MB +.RE +.IP \[bu] 2 +\[lq]1G\[rq] +.RS 2 +.IP \[bu] 2 +1 GB +.RE +.IP \[bu] 2 +\[lq]10G\[rq] +.RS 2 +.IP \[bu] 2 +10 GB +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to cache (Cache a remote). +.SS \[en]cache\-plex\-token +.PP +The plex token for authentication \- auto set normally +.IP \[bu] 2 +Config: plex_token +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-plex\-insecure +.PP +Skip all certificate verifications when connecting to the Plex server +.IP \[bu] 2 +Config: plex_insecure +.IP \[bu] 2 +Env Var: RCLONE_CACHE_PLEX_INSECURE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-db\-path +.PP +Directory to store file structure metadata DB. +The remote name is used as the DB file name. +.IP \[bu] 2 +Config: db_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] +.SS \[en]cache\-chunk\-path +.PP +Directory to cache chunk files. +.PP +Path to where partial file data (chunks) are stored locally. +The remote name is appended to the final path. +.PP +This config follows the \[lq]\[en]cache\-db\-path\[rq]. +If you specify a custom location for \[lq]\[en]cache\-db\-path\[rq] and +don\[cq]t specify one for \[lq]\[en]cache\-chunk\-path\[rq] then +\[lq]\[en]cache\-chunk\-path\[rq] will use the same path as +\[lq]\[en]cache\-db\-path\[rq]. +.IP \[bu] 2 +Config: chunk_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[lq]$HOME/.cache/rclone/cache\-backend\[rq] +.SS \[en]cache\-db\-purge +.PP +Clear all the cached data for this remote on start. +.IP \[bu] 2 +Config: db_purge +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_PURGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]cache\-chunk\-clean\-interval +.PP +How often should the cache perform cleanups of the chunk storage. +The default value should be ok for most people. +If you find that the cache goes over \[lq]cache\-chunk\-total\-size\[rq] +too often then try to lower this value to force it to perform cleanups +more often. +.IP \[bu] 2 +Config: chunk_clean_interval +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_CLEAN_INTERVAL +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1m0s +.SS \[en]cache\-read\-retries +.PP +How many times to retry a read from a cache storage. +.PP +Since reading from a cache stream is independent from downloading file +data, readers can get to a point where there\[cq]s no more data in the +cache. +Most of the times this can indicate a connectivity issue if cache +isn\[cq]t able to provide file data anymore. +.PP +For really slow connections, increase this to a point where the stream +is able to provide data but your experience will be very stuttering. +.IP \[bu] 2 +Config: read_retries +.IP \[bu] 2 +Env Var: RCLONE_CACHE_READ_RETRIES +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 10 +.SS \[en]cache\-workers +.PP +How many workers should run in parallel to download chunks. +.PP +Higher values will mean more parallel processing (better CPU needed) and +more concurrent requests on the cloud provider. +This impacts several aspects like the cloud provider API limits, more +stress on the hardware that rclone runs on but it also means that +streams will be more fluid and data will be available much more faster +to readers. +.PP +\f[B]Note\f[R]: If the optional Plex integration is enabled then this +setting will adapt to the type of reading performed and the value +specified here will be used as a maximum number of workers to use. +.IP \[bu] 2 +Config: workers +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WORKERS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 4 +.SS \[en]cache\-chunk\-no\-memory +.PP +Disable the in\-memory cache for storing chunks during streaming. +.PP +By default, cache will keep file data during streaming in RAM as well to +provide it to readers as fast as possible. +.PP +This transient data is evicted as soon as it is read and the number of +chunks stored doesn\[cq]t exceed the number of workers. +However, depending on other settings like \[lq]cache\-chunk\-size\[rq] +and \[lq]cache\-workers\[rq] this footprint can increase if there are +parallel streams too (multiple files being read at the same time). +.PP +If the hardware permits it, use this feature to provide an overall +better performance during streaming but it can also be disabled if RAM +is not available on the local machine. +.IP \[bu] 2 +Config: chunk_no_memory +.IP \[bu] 2 +Env Var: RCLONE_CACHE_CHUNK_NO_MEMORY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]cache\-rps +.PP +Limits the number of requests per second to the source FS (\-1 to +disable) +.PP +This setting places a hard limit on the number of requests per second +that cache will be doing to the cloud provider remote and try to respect +that value by setting waits between reads. +.PP +If you find that you\[cq]re getting banned or limited on the cloud +provider through cache and know that a smaller number of requests per +second will allow you to work with it then you can use this setting for +that. +.PP +A good balance of all the other settings should make this setting +useless but it is available to set for more special cases. +.PP +\f[B]NOTE\f[R]: This will limit the number of requests during streams +but other API calls to the cloud provider like directory listings will +still pass. +.IP \[bu] 2 +Config: rps +.IP \[bu] 2 +Env Var: RCLONE_CACHE_RPS +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: \-1 +.SS \[en]cache\-writes +.PP +Cache file data on writes through the FS +.PP +If you need to read files immediately after you upload them through +cache you can enable this flag to have their data stored in the cache +store at the same time during upload. +.IP \[bu] 2 +Config: writes +.IP \[bu] 2 +Env Var: RCLONE_CACHE_WRITES +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]cache\-tmp\-upload\-path +.PP +Directory to keep temporary files until they are uploaded. +.PP +This is the path where cache will use as a temporary storage for new +files that need to be uploaded to the cloud provider. +.PP +Specifying a value will enable this feature. +Without it, it is completely disabled and files will be uploaded +directly to the cloud provider +.IP \[bu] 2 +Config: tmp_upload_path +.IP \[bu] 2 +Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]cache\-tmp\-wait\-time +.PP +How long should files be stored in local cache before being uploaded +.PP +This is the duration that a file must wait in the temporary location +\f[I]cache\-tmp\-upload\-path\f[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 \[en]cache\-db\-wait\-time +.PP +How long to wait for the DB to be available \- 0 is unlimited +.PP +Only one process can have the DB open at any one time, so rclone waits +for this duration for the DB to become available before it gives an +error. +.PP +If you set it to 0 then it will wait forever. +.IP \[bu] 2 +Config: db_wait_time +.IP \[bu] 2 +Env Var: RCLONE_CACHE_DB_WAIT_TIME +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 1s +.SS 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\[cq]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\[cq]t. +This means that if you are using a bucket based remote (eg S3, B2, +swift) then you should probably put the bucket in the remote +\f[C]s3:bucket\f[R]. +.PP +Now configure \f[C]chunker\f[R] using \f[C]rclone config\f[R]. +We will call this one \f[C]overlay\f[R] to separate it from the +\f[C]remote\f[R] itself. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> overlay +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Transparently chunk/split large files + \[rs] \[dq]chunker\[dq] +[snip] +Storage> chunker +Remote to chunk/unchunk. +Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +remote> remote:path +Files larger than chunk size will be split in chunks. +Enter a size with suffix k,M,G,T. Press Enter for the default (\[dq]2G\[dq]). +chunk_size> 100M +Choose how chunker handles hash sums. All modes but \[dq]none\[dq] require metadata. +Enter a string value. Press Enter for the default (\[dq]md5\[dq]). +Choose a number from below, or type in your own value + 1 / Pass any hash supported by wrapped remote for non\-chunked files, return nothing otherwise + \[rs] \[dq]none\[dq] + 2 / MD5 for composite files + \[rs] \[dq]md5\[dq] + 3 / SHA1 for composite files + \[rs] \[dq]sha1\[dq] + 4 / MD5 for all files + \[rs] \[dq]md5all\[dq] + 5 / SHA1 for all files + \[rs] \[dq]sha1all\[dq] + 6 / Copying a file to chunker will request MD5 from the source falling back to SHA1 if unsupported + \[rs] \[dq]md5quick\[dq] + 7 / Similar to \[dq]md5quick\[dq] but prefers SHA1 over MD5 + \[rs] \[dq]sha1quick\[dq] +hash_type> md5 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[overlay] +type = chunker +remote = remote:bucket +chunk_size = 100M +hash_type = md5 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.SS Specifying the remote +.PP +In normal use, make sure the remote has a \f[C]:\f[R] in. +If you specify the remote without a \f[C]:\f[R] then rclone will use a +local directory of that name. +So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone +will chunk stuff in that directory. +If you use a remote of \f[C]name\f[R] then rclone will put files in a +directory called \f[C]name\f[R] in the current directory. +.SS Chunking +.PP +When rclone starts a file upload, chunker checks the file size. +If it doesn\[cq]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. +.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. +.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 \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. +.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. +.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\[cq]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. +This method is more prone to missing chunk errors (especially missing +last chunk) than format with metadata enabled. +.SS Hashsums +.PP +Chunker supports hashsums only when a compatible metadata is present. +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. +You will see the empty string as a hashsum of requested type for small +files if the wrapped remote doesn\[cq]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 +look coherent. +.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\[cq]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 expence of sidecar meta objects by setting eg. +\f[C]chunk_type=sha1all\f[R] to force hashsums and +\f[C]chunk_size=1P\f[R] to effectively disable chunking. +.PP +Normally, when a file is copied to chunker controlled remote, chunker +will ask the file source for compatible file hash and revert to +on\-the\-fly calculation if none is found. +This involves some CPU overhead but provides a guarantee that given +hashsum is available. +Also, chunker will reject a server\-side copy or move operation if +source and destination hashsum types are different resulting in the +extra network bandwidth, too. +In some rare cases this may be undesired, so chunker provides two +optional choices: \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. +.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 \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: +.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 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 \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 \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\[cq]s crypt remote as a base file system limits file name +by 143 characters. +Thus, maximum name length is 231 for most files and 119 for +chunker\-over\-crypt. +A user in need can change name format to eg. +\f[C]*.rcc##\f[R] and save 10 characters (provided at most 99 chunks per +file). +.PP +Note that a move implemented using the copy\-and\-delete method may +incur double charging with some cloud storage providers. +.PP +Chunker will not automatically rename existing chunks when you run +\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 setings, 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\[cq]t have a file called \[lq]Hello.doc\[rq] +and \[lq]hello.doc\[rq] in the same directory). +.SS Standard Options +.PP +Here are the standard options specific to chunker (Transparently +chunk/split large files). +.SS \[en]chunker\-remote +.PP +Remote to chunk/unchunk. +Normally should contain a `:' and a path, eg +\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe +\[lq]myremote:\[rq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]chunker\-chunk\-size +.PP +Files larger than chunk size will be split in chunks. +.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 \[en]chunker\-hash\-type +.PP +Choose how chunker handles hash sums. +All modes but \[lq]none\[rq] 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: \[lq]md5\[rq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]none\[rq] +.RS 2 +.IP \[bu] 2 +Pass any hash supported by wrapped remote for non\-chunked files, return +nothing otherwise +.RE +.IP \[bu] 2 +\[lq]md5\[rq] +.RS 2 +.IP \[bu] 2 +MD5 for composite files +.RE +.IP \[bu] 2 +\[lq]sha1\[rq] +.RS 2 +.IP \[bu] 2 +SHA1 for composite files +.RE +.IP \[bu] 2 +\[lq]md5all\[rq] +.RS 2 +.IP \[bu] 2 +MD5 for all files +.RE +.IP \[bu] 2 +\[lq]sha1all\[rq] +.RS 2 +.IP \[bu] 2 +SHA1 for all files +.RE +.IP \[bu] 2 +\[lq]md5quick\[rq] +.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 +\[lq]sha1quick\[rq] +.RS 2 +.IP \[bu] 2 +Similar to \[lq]md5quick\[rq] 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 \[en]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. +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. +.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 \[en]chunker\-start\-from +.PP +Minimum valid chunk number. +Usually 0 or 1. +By default chunk numbers start from 1. +.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 \[en]chunker\-meta\-format +.PP +Format of the metadata object or \[lq]none\[rq]. +By default \[lq]simplejson\[rq]. +Metadata is a small JSON file named after the composite file. +.IP \[bu] 2 +Config: meta_format +.IP \[bu] 2 +Env Var: RCLONE_CHUNKER_META_FORMAT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[lq]simplejson\[rq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]none\[rq] +.RS 2 +.IP \[bu] 2 +Do not use metadata files at all. +Requires hash type \[lq]none\[rq]. +.RE +.IP \[bu] 2 +\[lq]simplejson\[rq] +.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 \[en]chunker\-fail\-hard +.PP +Choose how chunker should handle files with missing or invalid chunks. +.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 +\[lq]true\[rq] +.RS 2 +.IP \[bu] 2 +Report errors and abort current command. +.RE +.IP \[bu] 2 +\[lq]false\[rq] +.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. +\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 +XX / Citrix Sharefile + \[rs] \[dq]sharefile\[dq] +Storage> sharefile +** See help for sharefile backend at: https://rclone.org/sharefile/ ** + +ID of the root folder + +Leave blank to access \[dq]Personal Folders\[dq]. You can use one of the +standard values here or any folder ID (long hex number ID). +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Access the Personal Folders. (Default) + \[rs] \[dq]\[dq] + 2 / Access the Favorites folder. + \[rs] \[dq]favorites\[dq] + 3 / Access all the shared folders. + \[rs] \[dq]allshared\[dq] + 4 / Access all the individual connectors. + \[rs] \[dq]connectors\[dq] + 5 / Access the home, favorites, and shared folders as well as the connectors. + \[rs] \[dq]top\[dq] +root_folder_id> +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX +Log in and authorize rclone for access +Waiting for code... +Got code +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = sharefile +endpoint = https://XXX.sharefile.com +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2019\-09\-30T19:41:45.878561877+01:00\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +See the remote setup docs (https://rclone.org/remote_setup/) for how to +set it up on a machine with no Internet browser available. +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Citrix ShareFile. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \f[C]http://127.0.0.1:53682/\f[R] and this it may require you +to unblock it temporarily if you are running a host firewall. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories in top level of your ShareFile +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your ShareFile +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to an ShareFile directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.SS Modified time and hashes +.PP +ShareFile allows modification times to be set on objects accurate to 1 +second. +These will be used to detect whether objects need syncing or not. +.PP +ShareFile supports MD5 type hashes, so you can use the +\f[C]\-\-checksum\f[R] flag. +.SS Transfers +.PP +For files above 128MB rclone will use a chunked transfer. +Rclone will upload up to \f[C]\-\-transfers\f[R] chunks at the same time +(shared among all the multipart uploads). +Chunks are buffered in memory and are normally 64MB so increasing +\f[C]\-\-transfers\f[R] will increase memory use. +.SS Limitations +.PP +Note that ShareFile is case insensitive so you can\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.PP +ShareFile only supports filenames up to 256 characters in length. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/overview/#restricted-characters) the following characters are also +replaced: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +\[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 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 (/overview/#invalid-utf8), as +they can\[cq]t be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to sharefile (Citrix Sharefile). +.SS \[en]sharefile\-root\-folder\-id +.PP +ID of the root folder +.PP +Leave blank to access \[lq]Personal Folders\[rq]. +You can use one of the standard values here or any folder ID (long hex +number ID). +.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 +\[lq]favorites\[rq] +.RS 2 +.IP \[bu] 2 +Access the Favorites folder. +.RE +.IP \[bu] 2 +\[lq]allshared\[rq] +.RS 2 +.IP \[bu] 2 +Access all the shared folders. +.RE +.IP \[bu] 2 +\[lq]connectors\[rq] +.RS 2 +.IP \[bu] 2 +Access all the individual connectors. +.RE +.IP \[bu] 2 +\[lq]top\[rq] +.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). +.SS \[en]sharefile\-upload\-cutoff +.PP +Cutoff for switching to multipart upload. +.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 \[en]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. +.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 \[en]sharefile\-endpoint +.PP +Endpoint for API calls. +.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 \[en]sharefile\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_SHAREFILE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot +.SS Crypt +.PP +The \f[C]crypt\f[R] remote encrypts and decrypts another remote. +.PP +To use it first set up the underlying remote following the config +instructions for that remote. +You can also use a local pathname instead of a remote which will encrypt +and decrypt from that directory which might be useful for encrypting +onto a USB stick for example. +.PP +First check your chosen remote is working \- we\[cq]ll call it +\f[C]remote:path\f[R] in these docs. +Note that anything inside \f[C]remote:path\f[R] will be encrypted and +anything outside won\[cq]t. +This means that if you are using a bucket based remote (eg S3, B2, +swift) then you should probably put the bucket in the remote +\f[C]s3:bucket\f[R]. +If you just use \f[C]s3:\f[R] then rclone will make encrypted bucket +names too (if using file name encryption) which may or may not be what +you want. +.PP +Now configure \f[C]crypt\f[R] using \f[C]rclone config\f[R]. +We will call this one \f[C]secret\f[R] to differentiate it from the +\f[C]remote\f[R]. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> secret +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Encrypt/Decrypt a remote + \[rs] \[dq]crypt\[dq] +[snip] +Storage> crypt +Remote to encrypt/decrypt. +Normally should contain a \[aq]:\[aq] and a path, eg \[dq]myremote:path/to/dir\[dq], +\[dq]myremote:bucket\[dq] or maybe \[dq]myremote:\[dq] (not recommended). +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. + \[rs] \[dq]off\[dq] + 2 / Encrypt the filenames see the docs for the details. + \[rs] \[dq]standard\[dq] + 3 / Very simple filename obfuscation. + \[rs] \[dq]obfuscate\[dq] +filename_encryption> 2 +Option to either encrypt directory names or leave them intact. +Choose a number from below, or type in your own value + 1 / Encrypt directory names. + \[rs] \[dq]true\[dq] + 2 / Don\[aq]t encrypt directory names, leave them intact. + \[rs] \[dq]false\[dq] +filename_encryption> 1 +Password or pass phrase for encryption. +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 +\f[R] +.fi +.PP +\f[B]Important\f[R] The password is stored in the config file is lightly +obscured so it isn\[cq]t immediately obvious what it is. +It is in no way secure unless you use config file encryption. +.PP +A long passphrase is recommended, or you can use a random one. +Note that if you reconfigure rclone with the same passwords/passphrases +elsewhere it will be compatible \- all the secrets used are derived from +those two passwords/passphrases. +.PP +Note that rclone does not encrypt +.IP \[bu] 2 +file length \- this can be calcuated within 16 bytes +.IP \[bu] 2 +modification time \- used for syncing +.SS Specifying the remote +.PP +In normal use, make sure the remote has a \f[C]:\f[R] in. +If you specify the remote without a \f[C]:\f[R] then rclone will use a +local directory of that name. +So if you use a remote of \f[C]/path/to/secret/files\f[R] then rclone +will encrypt stuff to that directory. +If you use a remote of \f[C]name\f[R] then rclone will put files in a +directory called \f[C]name\f[R] in the current directory. +.PP +If you specify the remote as \f[C]remote:path/to/dir\f[R] then rclone +will store encrypted files in \f[C]path/to/dir\f[R] on the remote. +If you are using file name encryption, then when you save files to +\f[C]secret:subdir/subfile\f[R] this will store them in the unencrypted +path \f[C]path/to/dir\f[R] but the \f[C]subdir/subpath\f[R] bit will be +encrypted. +.PP +Note that unless you want encrypted bucket names (which are difficult to +manage because you won\[cq]t know what directory they represent in web +interfaces etc), you should probably specify a bucket, eg +\f[C]remote:secretbucket\f[R] when using bucket based remotes such as +S3, Swift, Hubic, B2, GCS. +.SS Example +.PP +To test I made a little directory of files using \[lq]standard\[rq] file +name encryption. +.IP +.nf +\f[C] +plaintext/ +\[u251C]\[u2500]\[u2500] file0.txt +\[u251C]\[u2500]\[u2500] file1.txt +\[u2514]\[u2500]\[u2500] subdir + \[u251C]\[u2500]\[u2500] file2.txt + \[u251C]\[u2500]\[u2500] file3.txt + \[u2514]\[u2500]\[u2500] subsubdir + \[u2514]\[u2500]\[u2500] file4.txt +\f[R] +.fi +.PP +Copy these to the remote and list them back +.IP +.nf +\f[C] +$ rclone \-q copy plaintext secret: +$ rclone \-q ls secret: + 7 file1.txt + 6 file0.txt + 8 subdir/file2.txt + 10 subdir/subsubdir/file4.txt + 9 subdir/file3.txt +\f[R] +.fi +.PP +Now see what that looked like when encrypted +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 55 hagjclgavj2mbiqm6u6cnjjqcg + 54 v05749mltvv1tf4onltun46gls + 57 86vhrsv86mpbtd3a0akjuqslj8/dlj7fkq4kdq72emafg7a7s41uo + 58 86vhrsv86mpbtd3a0akjuqslj8/7uu829995du6o42n32otfhjqp4/b9pausrfansjth5ob3jkdqd4lc + 56 86vhrsv86mpbtd3a0akjuqslj8/8njh1sk437gttmep3p70g81aps +\f[R] +.fi +.PP +Note that this retains the directory structure which means you can do +this +.IP +.nf +\f[C] +$ rclone \-q ls secret:subdir + 8 file2.txt + 9 file3.txt + 10 subsubdir/file4.txt +\f[R] +.fi +.PP +If don\[cq]t use file name encryption then the remote will look like +this \- note the \f[C].bin\f[R] extensions added to prevent the cloud +provider attempting to interpret the data. +.IP +.nf +\f[C] +$ rclone \-q ls remote:path + 54 file0.txt.bin + 57 subdir/file3.txt.bin + 56 subdir/file2.txt.bin + 58 subdir/subsubdir/file4.txt.bin + 55 file1.txt.bin +\f[R] +.fi +.SS File name encryption modes +.PP +Here are some of the features of the file name encryption modes +.PP +Off +.IP \[bu] 2 +doesn\[cq]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\[cq]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 \[lq]rotate\[rq] of the filename, with each file having +a rot distance based on the filename. +We store the distance at the beginning of the filename. +So a file called \[lq]hello\[rq] may become \[lq]53.jgnnq\[rq] +.PP +This is not a strong encryption of filenames, but it may stop automated +scanning tools from picking up on filename patterns. +As such it\[cq]s an intermediate between \[lq]off\[rq] and +\[lq]standard\[rq]. +The advantage is that it allows for longer path segment names. +.PP +There is a possibility with some unicode based filenames that the +obfuscation is weak and may map lower case characters to upper case +equivalents. +You can not rely on this for strong protection. +.IP \[bu] 2 +file names very lightly obfuscated +.IP \[bu] 2 +file names can be longer than standard encryption +.IP \[bu] 2 +can use sub paths and copy single files +.IP \[bu] 2 +directory structure visible +.IP \[bu] 2 +identical files names will have identical uploaded names +.PP +Cloud storage systems have various limits on file name length and total +path length which you are more likely to hit using \[lq]Standard\[rq] +file name encryption. +If you keep your file names to below 156 characters in length then you +should be OK on all providers. +.PP +There may be an even more secure file name encryption mode in the future +which will address the long file name problem. +.SS Directory name encryption +.PP +Crypt offers the option of encrypting dir names or leaving them intact. +There are two options: +.PP +True +.PP +Encrypts the whole file path including directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]p0e52nreeaj0a5ea7s64m4j72s/l42g6771hnv3an9cgc8cr2n1ng/qgm4avr35m5loi1th53ato71v0\f[R] +.PP +False +.PP +Only encrypts file names, skips directory names Example: +\f[C]1/12/123.txt\f[R] is encrypted to +\f[C]1/12/qgm4avr35m5loi1th53ato71v0\f[R] +.SS Modified time and hashes +.PP +Crypt stores modification times using the underlying remote so support +depends on that. +.PP +Hashes are not stored for crypt. +However the data integrity is protected by an extremely strong crypto +authenticator. +.PP +Note that you should use the \f[C]rclone cryptcheck\f[R] command to +check the integrity of a crypted remote instead of +\f[C]rclone check\f[R] which can\[cq]t check the checksums properly. +.SS Standard Options +.PP +Here are the standard options specific to crypt (Encrypt/Decrypt a +remote). +.SS \[en]crypt\-remote +.PP +Remote to encrypt/decrypt. +Normally should contain a `:' and a path, eg +\[lq]myremote:path/to/dir\[rq], \[lq]myremote:bucket\[rq] or maybe +\[lq]myremote:\[rq] (not recommended). +.IP \[bu] 2 +Config: remote +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_REMOTE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]crypt\-filename\-encryption +.PP +How to encrypt the filenames. +.IP \[bu] 2 +Config: filename_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_FILENAME_ENCRYPTION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[lq]standard\[rq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]standard\[rq] +.RS 2 +.IP \[bu] 2 +Encrypt the filenames see the docs for the details. +.RE +.IP \[bu] 2 +\[lq]obfuscate\[rq] +.RS 2 +.IP \[bu] 2 +Very simple filename obfuscation. +.RE +.IP \[bu] 2 +\[lq]off\[rq] +.RS 2 +.IP \[bu] 2 +Don\[cq]t encrypt the file names. +Adds a \[lq].bin\[rq] extension only. +.RE +.RE +.SS \[en]crypt\-directory\-name\-encryption +.PP +Option to either encrypt directory names or leave them intact. +.IP \[bu] 2 +Config: directory_name_encryption +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_DIRECTORY_NAME_ENCRYPTION +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: true +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]true\[rq] +.RS 2 +.IP \[bu] 2 +Encrypt directory names. +.RE +.IP \[bu] 2 +\[lq]false\[rq] +.RS 2 +.IP \[bu] 2 +Don\[cq]t encrypt directory names, leave them intact. +.RE +.RE +.SS \[en]crypt\-password +.PP +Password or pass phrase for encryption. +.IP \[bu] 2 +Config: password +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]crypt\-password2 +.PP +Password or pass phrase for salt. +Optional but recommended. +Should be different to the previous password. +.IP \[bu] 2 +Config: password2 +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_PASSWORD2 +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to crypt (Encrypt/Decrypt a +remote). +.SS \[en]crypt\-show\-mapping +.PP +For all files listed show how the names encrypt. +.PP +If this flag is set then for each file that the remote is asked to list, +it will log (at level INFO) a line stating the decrypted file name and +the encrypted file name. +.PP +This is so you can work out which encrypted names are which decrypted +names just in case you need to do something with the encrypted file +names, or for debugging purposes. +.IP \[bu] 2 +Config: show_mapping +.IP \[bu] 2 +Env Var: RCLONE_CRYPT_SHOW_MAPPING +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Backing up a crypted remote +.PP +If you wish to backup a crypted remote, it it recommended that you use +\f[C]rclone sync\f[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 +.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\[cq]t decrypt and encrypt unnecessarily +.PP +For example, let\[cq]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 +.IP +.nf +\f[C] +rclone sync remote:crypt remote2:crypt +\f[R] +.fi +.PP +And to check the integrity you would do +.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: +.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\[cq]t be too +big. +.PP +This uses a 32 byte (256 bit key) key derived from the user password. +.SS Examples +.PP +1 byte file will encrypt to +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +17 bytes data chunk +.PP +49 bytes total +.PP +1MB (1048576 bytes) file will encrypt to +.IP \[bu] 2 +32 bytes header +.IP \[bu] 2 +16 chunks of 65568 bytes +.PP +1049120 bytes total (a 0.05% overhead). +This is the overhead for big files. +.SS Name encryption +.PP +File names are encrypted segment by segment \- the path is broken up +into \f[C]/\f[R] separated strings and these are encrypted individually. +.PP +File segments are padded using using PKCS#7 to a multiple of 16 bytes +before encryption. +.PP +They are then encrypted with EME using AES with 256 bit key. +EME (ECB\-Mix\-ECB) is a wide\-block encryption mode presented in the +2003 paper \[lq]A Parallelizable Enciphering Mode\[rq] by Halevi and +Rogaway. +.PP +This makes for deterministic encryption which is what we want \- the +same filename must encrypt to the same thing otherwise we can\[cq]t find +it on the cloud storage system. +.PP +This means that +.IP \[bu] 2 +filenames with the same name will encrypt the same +.IP \[bu] 2 +filenames which start the same won\[cq]t have a common prefix +.PP +This uses a 32 byte key (256 bits) and a 16 byte (128 bits) IV both of +which are derived from the user password. +.PP +After encryption they are written out using a modified version of +standard \f[C]base32\f[R] encoding as described in RFC4648. +The standard encoding is modified in two ways: +.IP \[bu] 2 +it becomes lower case (no\-one likes upper case filenames!) +.IP \[bu] 2 +we strip the padding character \f[C]=\f[R] +.PP +\f[C]base32\f[R] is used rather than the more efficient \f[C]base64\f[R] +so rclone can be used on case insensitive remotes (eg Windows, Amazon +Drive). +.SS Key derivation +.PP +Rclone uses \f[C]scrypt\f[R] with parameters \f[C]N=16384, r=8, p=1\f[R] +with an optional user supplied salt (password2) to derive the 32+32+16 = +80 bytes of key material required. +If the user doesn\[cq]t supply a salt then rclone uses an internal one. +.PP +\f[C]scrypt\f[R] makes it impractical to mount a dictionary attack on +rclone encrypted data. +For full protection against this you should always use a salt. +.SS Dropbox +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Dropbox paths may be as deep as required, eg +\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 = +token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +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 +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your dropbox +.IP +.nf +\f[C] +rclone ls remote: +\f[R] +.fi +.PP +To copy a local directory to a dropbox directory called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.SS Dropbox for business +.PP +Rclone supports Dropbox for business and Team Folders. +.PP +When using Dropbox for business \f[C]remote:\f[R] and +\f[C]remote:path/to/file\f[R] will refer to your personal folder. +.PP +If you wish to see Team Folders you must use a leading \f[C]/\f[R] in +the path, so \f[C]rclone lsd remote:/\f[R] will refer to the root and +show you all Team Folders and your User Folder. +.PP +You can then use team folders like this \f[C]remote:/TeamFolder\f[R] and +\f[C]remote:/TeamFolder/path/to/file\f[R]. +.PP +A leading \f[C]/\f[R] for a Dropbox personal account will do nothing, +but it will take an extra HTTP transaction so it should be avoided. +.SS Modified time and Hashes +.PP +Dropbox supports modified times, but the only way to set a modification +time is to re\-upload the file. +.PP +This means that if you uploaded your data with an older version of +rclone which didn\[cq]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\[cq]t want this to happen use \f[C]\-\-size\-only\f[R] or +\f[C]\-\-checksum\f[R] flag to stop it. +.PP +Dropbox supports its own hash +type (https://www.dropbox.com/developers/reference/content-hash) which +is checked for all transfers. +.SS Restricted filename characters +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +NUL +T}@T{ +0x00 +T}@T{ +\[u2400] +T} +T{ +/ +T}@T{ +0x2F +T}@T{ +\[uFF0F] +T} +T{ +DEL +T}@T{ +0x7F +T}@T{ +\[u2421] +T} +T{ +\[rs] +T}@T{ +0x5C +T}@T{ +\[uFF3C] +T} +.TE +.PP +File names can also not end with the following characters. +These only get replaced if they are 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 (/overview/#invalid-utf8), as +they can\[cq]t be used in JSON strings. +.SS Standard Options +.PP +Here are the standard options specific to dropbox (Dropbox). +.SS \[en]dropbox\-client\-id +.PP +Dropbox App Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]dropbox\-client\-secret +.PP +Dropbox App Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to dropbox (Dropbox). +.SS \[en]dropbox\-chunk\-size +.PP +Upload chunk size. +(< 150M). +.PP +Any files larger than this will be uploaded in chunks of this size. +.PP +Note that chunks are buffered in memory (one at a time) so rclone can +deal with retries. +Setting this larger will increase the speed slightly (at most 10% for +128MB in tests) at the cost of using more memory. +It can be set smaller if you are tight on memory. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 48M +.SS \[en]dropbox\-impersonate +.PP +Impersonate this user when using a business account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DROPBOX_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]dropbox\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/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\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +.PP +There are some file names such as \f[C]thumbs.db\f[R] which Dropbox +can\[cq]t store. +There is a full list of them in the \[lq]Ignored Files\[rq] section of +this document (https://www.dropbox.com/en/help/145). +Rclone will issue an error message +\f[C]File name disallowed \- not uploading\f[R] if it attempts to upload +one of those file names, but the sync won\[cq]t fail. +.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\[cq]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 => Full Dropbox or App Folder +.IP "4." 3 +Name your App +.IP "5." 3 +Click the button \f[C]Create App\f[R] +.IP "6." 3 +Find the \f[C]App key\f[R] and \f[C]App secret\f[R] Use these values in +rclone config to add a new remote or edit an existing remote. +.SS FTP +.PP +FTP is the File Transfer Protocol. +FTP support is provided using the +github.com/jlaffaye/ftp (https://godoc.org/github.com/jlaffaye/ftp) +package. +.PP +Here is an example of making an FTP configuration. +First run +.IP +.nf +\f[C] +rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process. +An FTP remote only needs a host together with and a username and a +password. +With anonymous FTP server, you will need to use \f[C]anonymous\f[R] as +username and your email address as the password. +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value +[snip] +XX / FTP Connection + \[rs] \[dq]ftp\[dq] +[snip] +Storage> ftp +** See help for ftp backend at: https://rclone.org/ftp/ ** + +FTP host to connect to +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value + 1 / Connect to ftp.example.com + \[rs] \[dq]ftp.example.com\[dq] +host> ftp.example.com +FTP username, leave blank for current username, ncw +Enter a string value. Press Enter for the default (\[dq]\[dq]). +user> +FTP port, leave blank to use default (21) +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> +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 +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all directories in the home directory +.IP +.nf +\f[C] +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:directory -\f[] +rclone ls remote:path/to/directory +\f[R] .fi .PP -Sync the remote \f[C]directory\f[] to \f[C]/home/local/directory\f[], +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 /home/local/directory remote:directory +\f[R] +.fi +.SS Modified time +.PP +FTP does not support modified times. +Any times you see on the server will be time of upload. +.SS Checksums +.PP +FTP does not support any checksums. +.SS Restricted filename characters +.PP +In addition to the default restricted characters +set (/overview/#restricted-characters) the following characters are also +replaced: +.PP +File names can also not end with the following characters. +These only get replaced if they are last character in the name: +.PP +.TS +tab(@); +l c c. +T{ +Character +T}@T{ +Value +T}@T{ +Replacement +T} +_ +T{ +SP +T}@T{ +0x20 +T}@T{ +\[u2420] +T} +.TE +.PP +Note that not all FTP servers can have all characters in file names, for +example: +.PP +.TS +tab(@); +l c. +T{ +FTP Server +T}@T{ +Forbidden characters +T} +_ +T{ +proftpd +T}@T{ +\f[C]*\f[R] +T} +T{ +pureftpd +T}@T{ +\f[C]\[rs] [ ]\f[R] +T} +.TE +.SS Implicit TLS +.PP +FTP supports implicit FTP over TLS servers (FTPS). +This has to be enabled in the config for the remote. +The default FTPS port is \f[C]990\f[R] so the port will likely have to +be explictly set in the config for the remote. +.SS Standard Options +.PP +Here are the standard options specific to ftp (FTP Connection). +.SS \[en]ftp\-host +.PP +FTP host to connect to +.IP \[bu] 2 +Config: host +.IP \[bu] 2 +Env Var: RCLONE_FTP_HOST +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]ftp.example.com\[rq] +.RS 2 +.IP \[bu] 2 +Connect to ftp.example.com +.RE +.RE +.SS \[en]ftp\-user +.PP +FTP username, leave blank for current username, $USER +.IP \[bu] 2 +Config: user +.IP \[bu] 2 +Env Var: RCLONE_FTP_USER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]ftp\-port +.PP +FTP port, leave blank to use default (21) +.IP \[bu] 2 +Config: port +.IP \[bu] 2 +Env Var: RCLONE_FTP_PORT +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]ftp\-pass +.PP +FTP password +.IP \[bu] 2 +Config: pass +.IP \[bu] 2 +Env Var: RCLONE_FTP_PASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]ftp\-tls +.PP +Use FTP over TLS (Implicit) +.IP \[bu] 2 +Config: tls +.IP \[bu] 2 +Env Var: RCLONE_FTP_TLS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to ftp (FTP Connection). +.SS \[en]ftp\-concurrency +.PP +Maximum number of FTP simultaneous connections, 0 for unlimited +.IP \[bu] 2 +Config: concurrency +.IP \[bu] 2 +Env Var: RCLONE_FTP_CONCURRENCY +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 0 +.SS \[en]ftp\-no\-check\-certificate +.PP +Do not verify the TLS certificate of the server +.IP \[bu] 2 +Config: no_check_certificate +.IP \[bu] 2 +Env Var: RCLONE_FTP_NO_CHECK_CERTIFICATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]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 \[en]ftp\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_FTP_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Del,Ctl,RightSpace,Dot +.SS Limitations +.PP +Note that since FTP isn\[cq]t HTTP based the following flags don\[cq]t +work with it: \f[C]\-\-dump\-headers\f[R], \f[C]\-\-dump\-bodies\f[R], +\f[C]\-\-dump\-auth\f[R] +.PP +Note that \f[C]\-\-timeout\f[R] isn\[cq]t supported (but +\f[C]\-\-contimeout\f[R] is). +.PP +Note that \f[C]\-\-bind\f[R] isn\[cq]t supported. +.PP +FTP could support server side move but doesn\[cq]t yet. +.PP +Note that the ftp backend does not support the \f[C]ftp_proxy\f[R] +environment variable yet. +.PP +Note that while implicit FTP over TLS is supported, explicit FTP over +TLS is not. +.SS Google Cloud Storage +.PP +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. +.PP +The initial setup for google cloud storage involves getting a token from +Google Cloud Storage which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +n) New remote +d) Delete remote +q) Quit config +e/n/d/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Cloud Storage (this is not Google Drive) + \[rs] \[dq]google cloud storage\[dq] +[snip] +Storage> google cloud storage +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Project number optional \- needed only for list/create/delete buckets \- see your developer console. +project_number> 12345678 +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> +Access Control List for new objects. +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 /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\[cq]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\[cq]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\[cq]t use the browser based authentication flow. +If you\[cq]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 Application Default Credentials +.PP +If no other source of credentials is provided, rclone will fall back to +Application Default +Credentials (https://cloud.google.com/video-intelligence/docs/common/auth#authenticating_with_application_default_credentials) +this is useful both when you already have configured authentication for +your developer account, or in production when running on a google +compute host. +Note that if running in docker, you may need to run additional commands +on your google compute machine \- see this +page (https://cloud.google.com/container-registry/docs/advanced-authentication#gcloud_as_a_docker_credential_helper). +.PP +Note that in the case application default credentials are used, there is +no need to explicitly configure a project number. +.SS \[en]fast\-list +.PP +This remote supports \f[C]\-\-fast\-list\f[R] which allows you to use +fewer transactions in exchange for more memory. +See the rclone docs (/docs/#fast-list) for more details. +.SS Modified time +.PP +Google google cloud storage stores md5sums natively and rclone stores +modification times as metadata on the object, under the \[lq]mtime\[rq] +key in RFC3339 format accurate to 1ns. +.SS 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 (/overview/#invalid-utf8), as +they can\[cq]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 \[en]gcs\-client\-id +.PP +Google Application Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gcs\-client\-secret +.PP +Google Application Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GCS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gcs\-project\-number +.PP +Project number. +Optional \- needed only for list/create/delete buckets \- see your +developer console. +.IP \[bu] 2 +Config: project_number +.IP \[bu] 2 +Env Var: RCLONE_GCS_PROJECT_NUMBER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gcs\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gcs\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gcs\-object\-acl +.PP +Access Control List for new objects. +.IP \[bu] 2 +Config: object_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_OBJECT_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]authenticatedRead\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Authenticated Users get READER +access. +.RE +.IP \[bu] 2 +\[lq]bucketOwnerFullControl\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get OWNER +access. +.RE +.IP \[bu] 2 +\[lq]bucketOwnerRead\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team owners get READER +access. +.RE +.IP \[bu] 2 +\[lq]private\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[lq]projectPrivate\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and project team members get access +according to their roles. +.RE +.IP \[bu] 2 +\[lq]publicRead\[rq] +.RS 2 +.IP \[bu] 2 +Object owner gets OWNER access, and all Users get READER access. +.RE +.RE +.SS \[en]gcs\-bucket\-acl +.PP +Access Control List for new buckets. +.IP \[bu] 2 +Config: bucket_acl +.IP \[bu] 2 +Env Var: RCLONE_GCS_BUCKET_ACL +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]authenticatedRead\[rq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Authenticated Users get +READER access. +.RE +.IP \[bu] 2 +\[lq]private\[rq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access [default if left blank]. +.RE +.IP \[bu] 2 +\[lq]projectPrivate\[rq] +.RS 2 +.IP \[bu] 2 +Project team members get access according to their roles. +.RE +.IP \[bu] 2 +\[lq]publicRead\[rq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get READER access. +.RE +.IP \[bu] 2 +\[lq]publicReadWrite\[rq] +.RS 2 +.IP \[bu] 2 +Project team owners get OWNER access, and all Users get WRITER access. +.RE +.RE +.SS \[en]gcs\-bucket\-policy\-only +.PP +Access checks should use bucket\-level IAM policies. +.PP +If you want to upload objects to a bucket with Bucket Policy Only set +then you will need to set this. +.PP +When it is set, rclone: +.IP \[bu] 2 +ignores ACLs set on buckets +.IP \[bu] 2 +ignores ACLs set on objects +.IP \[bu] 2 +creates buckets with Bucket Policy Only set +.PP +Docs: https://cloud.google.com/storage/docs/bucket\-policy\-only +.IP \[bu] 2 +Config: bucket_policy_only +.IP \[bu] 2 +Env Var: RCLONE_GCS_BUCKET_POLICY_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]gcs\-location +.PP +Location for the newly created buckets. +.IP \[bu] 2 +Config: location +.IP \[bu] 2 +Env Var: RCLONE_GCS_LOCATION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[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 +\[lq]asia\[rq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Asia. +.RE +.IP \[bu] 2 +\[lq]eu\[rq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for Europe. +.RE +.IP \[bu] 2 +\[lq]us\[rq] +.RS 2 +.IP \[bu] 2 +Multi\-regional location for United States. +.RE +.IP \[bu] 2 +\[lq]asia\-east1\[rq] +.RS 2 +.IP \[bu] 2 +Taiwan. +.RE +.IP \[bu] 2 +\[lq]asia\-east2\[rq] +.RS 2 +.IP \[bu] 2 +Hong Kong. +.RE +.IP \[bu] 2 +\[lq]asia\-northeast1\[rq] +.RS 2 +.IP \[bu] 2 +Tokyo. +.RE +.IP \[bu] 2 +\[lq]asia\-south1\[rq] +.RS 2 +.IP \[bu] 2 +Mumbai. +.RE +.IP \[bu] 2 +\[lq]asia\-southeast1\[rq] +.RS 2 +.IP \[bu] 2 +Singapore. +.RE +.IP \[bu] 2 +\[lq]australia\-southeast1\[rq] +.RS 2 +.IP \[bu] 2 +Sydney. +.RE +.IP \[bu] 2 +\[lq]europe\-north1\[rq] +.RS 2 +.IP \[bu] 2 +Finland. +.RE +.IP \[bu] 2 +\[lq]europe\-west1\[rq] +.RS 2 +.IP \[bu] 2 +Belgium. +.RE +.IP \[bu] 2 +\[lq]europe\-west2\[rq] +.RS 2 +.IP \[bu] 2 +London. +.RE +.IP \[bu] 2 +\[lq]europe\-west3\[rq] +.RS 2 +.IP \[bu] 2 +Frankfurt. +.RE +.IP \[bu] 2 +\[lq]europe\-west4\[rq] +.RS 2 +.IP \[bu] 2 +Netherlands. +.RE +.IP \[bu] 2 +\[lq]us\-central1\[rq] +.RS 2 +.IP \[bu] 2 +Iowa. +.RE +.IP \[bu] 2 +\[lq]us\-east1\[rq] +.RS 2 +.IP \[bu] 2 +South Carolina. +.RE +.IP \[bu] 2 +\[lq]us\-east4\[rq] +.RS 2 +.IP \[bu] 2 +Northern Virginia. +.RE +.IP \[bu] 2 +\[lq]us\-west1\[rq] +.RS 2 +.IP \[bu] 2 +Oregon. +.RE +.IP \[bu] 2 +\[lq]us\-west2\[rq] +.RS 2 +.IP \[bu] 2 +California. +.RE +.RE +.SS \[en]gcs\-storage\-class +.PP +The storage class to use when storing objects in Google Cloud Storage. +.IP \[bu] 2 +Config: storage_class +.IP \[bu] 2 +Env Var: RCLONE_GCS_STORAGE_CLASS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[dq]\[dq] +.RS 2 +.IP \[bu] 2 +Default +.RE +.IP \[bu] 2 +\[lq]MULTI_REGIONAL\[rq] +.RS 2 +.IP \[bu] 2 +Multi\-regional storage class +.RE +.IP \[bu] 2 +\[lq]REGIONAL\[rq] +.RS 2 +.IP \[bu] 2 +Regional storage class +.RE +.IP \[bu] 2 +\[lq]NEARLINE\[rq] +.RS 2 +.IP \[bu] 2 +Nearline storage class +.RE +.IP \[bu] 2 +\[lq]COLDLINE\[rq] +.RS 2 +.IP \[bu] 2 +Coldline storage class +.RE +.IP \[bu] 2 +\[lq]DURABLE_REDUCED_AVAILABILITY\[rq] +.RS 2 +.IP \[bu] 2 +Durable reduced availability storage class +.RE +.RE +.SS Advanced Options +.PP +Here are the advanced options specific to google cloud storage (Google +Cloud Storage (this is not Google Drive)). +.SS \[en]gcs\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_GCS_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,CrLf,InvalidUtf8,Dot +.SS Google Drive +.PP +Paths are specified as \f[C]drive:path\f[R] +.PP +Drive paths may be as deep as required, eg +\f[C]drive:directory/subdirectory\f[R]. +.PP +The initial setup for drive involves getting a token from Google drive +which you need to do in your browser. +\f[C]rclone config\f[R] walks you through it. +.PP +Here is an example of how to make a remote called \f[C]remote\f[R]. +First run: +.IP +.nf +\f[C] + rclone config +\f[R] +.fi +.PP +This will guide you through an interactive setup process: +.IP +.nf +\f[C] +No remotes found \- make a new one +n) New remote +r) Rename remote +c) Copy remote +s) Set configuration password +q) Quit config +n/r/c/s/q> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value +[snip] +XX / Google Drive + \[rs] \[dq]drive\[dq] +[snip] +Storage> drive +Google Application Client Id \- leave blank normally. +client_id> +Google Application Client Secret \- leave blank normally. +client_secret> +Scope that rclone should use when requesting access from drive. +Choose a number from below, or type in your own value + 1 / Full access all files, excluding Application Data Folder. + \[rs] \[dq]drive\[dq] + 2 / Read\-only access to file metadata and file contents. + \[rs] \[dq]drive.readonly\[dq] + / Access to files created by rclone only. + 3 | These are visible in the drive website. + | File authorization is revoked when the user deauthorizes the app. + \[rs] \[dq]drive.file\[dq] + / Allows read and write access to the Application Data folder. + 4 | This is not visible in the drive website. + \[rs] \[dq]drive.appfolder\[dq] + / Allows read\-only access to file metadata but + 5 | does not allow any access to read or download file content. + \[rs] \[dq]drive.metadata.readonly\[dq] +scope> 1 +ID of the root folder \- leave blank normally. Fill in to access \[dq]Computers\[dq] folders. (see docs). +root_folder_id> +Service Account Credentials JSON file path \- needed only if you want use SA instead of interactive login. +service_account_file> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine or Y didn\[aq]t work +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code +Configure this as a team drive? +y) Yes +n) No +y/n> n +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +client_id = +client_secret = +scope = drive +root_folder_id = +service_account_file = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]XXX\[dq],\[dq]expiry\[dq]:\[dq]2014\-03\-16T13:57:58.955387075Z\[dq]} +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Note that rclone runs a webserver on your local machine to collect the +token as returned from Google if you use auto config mode. +This only runs from the moment it opens your browser to the moment you +get back the verification code. +This is on \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\[cq]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\[cq]t be able to see rclone\[cq]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 \[lq]Computers\[rq] tab on the +drive web interface (where files from Google\[cq]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 \[lq]Computers\[rq] tab seem to be read +only (drive gives a 500 error) when using rclone. +.PP +There doesn\[cq]t appear to be an API to discover the folder IDs of the +\[lq]Computers\[rq] tab \- please contact us if you know otherwise! +.PP +Note also that rclone can\[cq]t access any data under the +\[lq]Backups\[rq] tab on the google drive web interface yet. +.SS Service Account support +.PP +You can set up rclone with Google Drive in an unattended mode, i.e.\ not +tied to a specific end\-user Google account. +This is useful when you want to synchronise files onto machines that +don\[cq]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\[cq]t use the +browser based authentication flow. +If you\[cq]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\[cq]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\[cq]s Drive account, who IS a +member of the domain. +We\[cq]ll call the domain \f[B]example.com\f[R], and the user +\f[B]foo\[at]example.com\f[R]. +.PP +There\[cq]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\[cq]t. +.IP \[bu] 2 +Then go to \[lq]IAM & admin\[rq] \-> \[lq]Service Accounts\[rq]. +.IP \[bu] 2 +Use the \[lq]Create Credentials\[rq] button. +Fill in \[lq]Service account name\[rq] with something that identifies +your client. +\[lq]Role\[rq] can be empty. +.IP \[bu] 2 +Tick \[lq]Furnish a new private key\[rq] \- select \[lq]Key type +JSON\[rq]. +.IP \[bu] 2 +Tick \[lq]Enable G Suite Domain\-wide Delegation\[rq]. +This option makes \[lq]impersonation\[rq] possible, as documented here: +Delegating domain\-wide authority to the service +account (https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) +.IP \[bu] 2 +These credentials are what rclone will use for authentication. +If you ever need to remove access, press the \[lq]Delete service account +key\[rq] button. +.SS 2. Allowing API access to example.com Google Drive +.IP \[bu] 2 +Go to example.com\[cq]s admin console +.IP \[bu] 2 +Go into \[lq]Security\[rq] (or use the search bar) +.IP \[bu] 2 +Select \[lq]Show more\[rq] and then \[lq]Advanced settings\[rq] +.IP \[bu] 2 +Select \[lq]Manage API client access\[rq] in the +\[lq]Authentication\[rq] section +.IP \[bu] 2 +In the \[lq]Client Name\[rq] field enter the service account\[cq]s +\[lq]Client ID\[rq] \- this can be found in the Developer Console under +\[lq]IAM & Admin\[rq] \-> \[lq]Service Accounts\[rq], then \[lq]View +Client ID\[rq] for the newly created service account. +It is a \[ti]21 character numerical string. +.IP \[bu] 2 +In the next field, \[lq]One or More API Scopes\[rq], enter +\f[C]https://www.googleapis.com/auth/drive\f[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\[cq]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 +.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 \[en]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 (/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 (/overview/#invalid-utf8), as +they can\[cq]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 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\[cq]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, eg with +\f[C]\-\-drive\-import\-formats docx,odt,txt\f[R], all files having +these extension would result in a document represented as a docx file. +This brings the additional risk of overwriting a document, if multiple +files have the same stem. +Many rclone operations will not handle this name change in any way. +They assume an equal name when copying files and might copy the file +again or delete them when the name changes. +.PP +Here are the possible export extensions with their corresponding mime +types. +Most of these can also be used for importing, but there more that are +not listed here. +Some of these additional ones might only be available when the operating +system provides the correct MIME type entries. +.PP +This list can be changed by Google Drive at any time and might not +represent the currently available conversions. +.PP +.TS +tab(@); +lw(19.7n) lw(24.1n) lw(26.2n). +T{ +Extension +T}@T{ +Mime Type +T}@T{ +Description +T} +_ +T{ +csv +T}@T{ +text/csv +T}@T{ +Standard CSV format for Spreadsheets +T} +T{ +docx +T}@T{ +application/vnd.openxmlformats\-officedocument.wordprocessingml.document +T}@T{ +Microsoft Office Document +T} +T{ +epub +T}@T{ +application/epub+zip +T}@T{ +E\-book format +T} +T{ +html +T}@T{ +text/html +T}@T{ +An HTML Document +T} +T{ +jpg +T}@T{ +image/jpeg +T}@T{ +A JPEG Image File +T} +T{ +json +T}@T{ +application/vnd.google\-apps.script+json +T}@T{ +JSON Text Format +T} +T{ +odp +T}@T{ +application/vnd.oasis.opendocument.presentation +T}@T{ +Openoffice Presentation +T} +T{ +ods +T}@T{ +application/vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +ods +T}@T{ +application/x\-vnd.oasis.opendocument.spreadsheet +T}@T{ +Openoffice Spreadsheet +T} +T{ +odt +T}@T{ +application/vnd.oasis.opendocument.text +T}@T{ +Openoffice Document +T} +T{ +pdf +T}@T{ +application/pdf +T}@T{ +Adobe PDF Format +T} +T{ +png +T}@T{ +image/png +T}@T{ +PNG Image Format +T} +T{ +pptx +T}@T{ +application/vnd.openxmlformats\-officedocument.presentationml.presentation +T}@T{ +Microsoft Office Powerpoint +T} +T{ +rtf +T}@T{ +application/rtf +T}@T{ +Rich Text Format +T} +T{ +svg +T}@T{ +image/svg+xml +T}@T{ +Scalable Vector Graphics Format +T} +T{ +tsv +T}@T{ +text/tab\-separated\-values +T}@T{ +Standard TSV format for spreadsheets +T} +T{ +txt +T}@T{ +text/plain +T}@T{ +Plain Text +T} +T{ +xlsx +T}@T{ +application/vnd.openxmlformats\-officedocument.spreadsheetml.sheet +T}@T{ +Microsoft Office Spreadsheet +T} +T{ +zip +T}@T{ +application/zip +T}@T{ +A ZIP file of HTML, Images CSS +T} +.TE +.PP +Google documents can also be exported as link files. +These files will open a browser window for the Google Docs website of +that document when opened. +The link file extension has to be specified as a +\f[C]\-\-drive\-export\-formats\f[R] parameter. +They will match all available Google Documents. +.PP +.TS +tab(@); +l l l. +T{ +Extension +T}@T{ +Description +T}@T{ +OS Support +T} +_ +T{ +desktop +T}@T{ +freedesktop.org specified desktop entry +T}@T{ +Linux +T} +T{ +link.html +T}@T{ +An HTML Document with a redirect +T}@T{ +All +T} +T{ +url +T}@T{ +INI style link file +T}@T{ +macOS, Windows +T} +T{ +webloc +T}@T{ +macOS specific XML format +T}@T{ +macOS +T} +.TE +.SS Standard Options +.PP +Here are the standard options specific to drive (Google Drive). +.SS \[en]drive\-client\-id +.PP +Google Application Client Id Setting your own is recommended. +See https://rclone.org/drive/#making\-your\-own\-client\-id for how to +create your own. +If you leave this blank, it will use an internal key which is low +performance. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-client\-secret +.PP +Google Application Client Secret Setting your own is recommended. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-scope +.PP +Scope that rclone should use when requesting access from drive. +.IP \[bu] 2 +Config: scope +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SCOPE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.IP \[bu] 2 +Examples: +.RS 2 +.IP \[bu] 2 +\[lq]drive\[rq] +.RS 2 +.IP \[bu] 2 +Full access all files, excluding Application Data Folder. +.RE +.IP \[bu] 2 +\[lq]drive.readonly\[rq] +.RS 2 +.IP \[bu] 2 +Read\-only access to file metadata and file contents. +.RE +.IP \[bu] 2 +\[lq]drive.file\[rq] +.RS 2 +.IP \[bu] 2 +Access to files created by rclone only. +.IP \[bu] 2 +These are visible in the drive website. +.IP \[bu] 2 +File authorization is revoked when the user deauthorizes the app. +.RE +.IP \[bu] 2 +\[lq]drive.appfolder\[rq] +.RS 2 +.IP \[bu] 2 +Allows read and write access to the Application Data folder. +.IP \[bu] 2 +This is not visible in the drive website. +.RE +.IP \[bu] 2 +\[lq]drive.metadata.readonly\[rq] +.RS 2 +.IP \[bu] 2 +Allows read\-only access to file metadata but +.IP \[bu] 2 +does not allow any access to read or download file content. +.RE +.RE +.SS \[en]drive\-root\-folder\-id +.PP +ID of the root folder Leave blank normally. +.PP +Fill in to access \[lq]Computers\[rq] folders (see docs), or for rclone +to use a non root folder as its starting point. +.PP +Note that if this is blank, the first time rclone runs it will fill it +in with the ID of the root folder. +.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 \[en]drive\-service\-account\-file +.PP +Service Account Credentials JSON file path Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_file +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_FILE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to drive (Google Drive). +.SS \[en]drive\-service\-account\-credentials +.PP +Service Account Credentials JSON blob Leave blank normally. +Needed only if you want use SA instead of interactive login. +.IP \[bu] 2 +Config: service_account_credentials +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SERVICE_ACCOUNT_CREDENTIALS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-team\-drive +.PP +ID of the Team Drive +.IP \[bu] 2 +Config: team_drive +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TEAM_DRIVE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-auth\-owner\-only +.PP +Only consider files owned by the authenticated user. +.IP \[bu] 2 +Config: auth_owner_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_AUTH_OWNER_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-use\-trash +.PP +Send files to the trash instead of deleting permanently. +Defaults to true, namely sending files to the trash. +Use \f[C]\-\-drive\-use\-trash=false\f[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 \[en]drive\-skip\-gdocs +.PP +Skip google documents in all listings. +If given, gdocs practically become invisible to rclone. +.IP \[bu] 2 +Config: skip_gdocs +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_GDOCS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-skip\-checksum\-gphotos +.PP +Skip MD5 checksum on Google photos and videos only. +.PP +Use this if you get checksum errors when transferring Google photos or +videos. +.PP +Setting this flag will cause Google photos and videos to return a blank +MD5 checksum. +.PP +Google photos are identifed by being in the \[lq]photos\[rq] space. +.PP +Corrupted checksums are caused by Google modifying the image/video but +not updating the checksum. +.IP \[bu] 2 +Config: skip_checksum_gphotos +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SKIP_CHECKSUM_GPHOTOS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-shared\-with\-me +.PP +Only show files that are shared with me. +.PP +Instructs rclone to operate on your \[lq]Shared with me\[rq] folder +(where Google Drive lets you access the files and folders others have +shared with you). +.PP +This works both with the \[lq]list\[rq] (lsd, lsl, etc) and the +\[lq]copy\[rq] commands (copy, sync, etc), and with all other commands +too. +.IP \[bu] 2 +Config: shared_with_me +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_SHARED_WITH_ME +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-trashed\-only +.PP +Only show files that are in the trash. +This will show trashed files in their original directory structure. +.IP \[bu] 2 +Config: trashed_only +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_TRASHED_ONLY +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-formats +.PP +Deprecated: see export_formats +.IP \[bu] 2 +Config: formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-export\-formats +.PP +Comma separated list of preferred formats for downloading Google docs. +.IP \[bu] 2 +Config: export_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_EXPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[lq]docx,xlsx,pptx,svg\[rq] +.SS \[en]drive\-import\-formats +.PP +Comma separated list of preferred formats for uploading Google docs. +.IP \[bu] 2 +Config: import_formats +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPORT_FORMATS +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-allow\-import\-name\-change +.PP +Allow the filetype to change when uploading Google docs (e.g.\ file.doc +to file.docx). +This will confuse sync and reupload every time. +.IP \[bu] 2 +Config: allow_import_name_change +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALLOW_IMPORT_NAME_CHANGE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-use\-created\-date +.PP +Use file created date instead of modified date., +.PP +Useful when downloading data and you want the creation date used in +place of the last modified date. +.PP +\f[B]WARNING\f[R]: This flag may have some unexpected consequences. +.PP +When uploading to your drive all files will be overwritten unless they +haven\[cq]t been modified since their creation. +And the inverse will occur while downloading. +This side effect can be avoided by using the \[lq]\[en]checksum\[rq] +flag. +.PP +This feature was implemented to retain photos capture date as recorded +by google photos. +You will first need to check the \[lq]Create a Google Photos folder\[rq] +option in your google drive settings. +You can then copy or move the photos locally and use the date the image +was taken (created) set as the modification date. +.IP \[bu] 2 +Config: use_created_date +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_USE_CREATED_DATE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-use\-shared\-date +.PP +Use date file was shared instead of modified date. +.PP +Note that, as with \[lq]\[en]drive\-use\-created\-date\[rq], this flag +may have unexpected consequences when uploading/downloading files. +.PP +If both this flag and \[lq]\[en]drive\-use\-created\-date\[rq] 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 \[en]drive\-list\-chunk +.PP +Size of listing chunk 100\-1000. +0 to disable. +.IP \[bu] 2 +Config: list_chunk +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_LIST_CHUNK +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 1000 +.SS \[en]drive\-impersonate +.PP +Impersonate this user when using a service account. +.IP \[bu] 2 +Config: impersonate +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_IMPERSONATE +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]drive\-alternate\-export +.PP +Use alternate export URLs for google documents export., +.PP +If this option is set this instructs rclone to use an alternate set of +export URLs for drive documents. +Users have reported that the official export URLs can\[cq]t export large +documents, whereas these unofficial ones can. +.PP +See rclone issue #2243 (https://github.com/rclone/rclone/issues/2243) +for background, this google drive +issue (https://issuetracker.google.com/issues/36761333) and this helpful +post (https://www.labnol.org/internet/direct-links-for-google-drive/28356/). +.IP \[bu] 2 +Config: alternate_export +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ALTERNATE_EXPORT +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-upload\-cutoff +.PP +Cutoff for switching to chunked upload +.IP \[bu] 2 +Config: upload_cutoff +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_UPLOAD_CUTOFF +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \[en]drive\-chunk\-size +.PP +Upload chunk size. +Must a power of 2 >= 256k. +.PP +Making this larger will improve performance, but note that each chunk is +buffered in memory one per transfer. +.PP +Reducing this will reduce memory usage but decrease performance. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 8M +.SS \[en]drive\-acknowledge\-abuse +.PP +Set to allow files which return cannotDownloadAbusiveFile to be +downloaded. +.PP +If downloading a file returns the error \[lq]This file has been +identified as malware or spam and cannot be downloaded\[rq] with the +error code \[lq]cannotDownloadAbusiveFile\[rq] then supply this flag to +rclone to indicate you acknowledge the risks of downloading the file and +rclone will download it anyway. +.IP \[bu] 2 +Config: acknowledge_abuse +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_ACKNOWLEDGE_ABUSE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-keep\-revision\-forever +.PP +Keep new head revision of each file forever. +.IP \[bu] 2 +Config: keep_revision_forever +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_KEEP_REVISION_FOREVER +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS \[en]drive\-size\-as\-quota +.PP +Show sizes as storage quota usage, not actual size. +.PP +Show the size of a file as the 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 \[en]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 \[en]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 \[en]drive\-v2\-download\-min\-size +.PP +If Object\[cq]s are greater, use drive v2 API to download. +.IP \[bu] 2 +Config: v2_download_min_size +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_V2_DOWNLOAD_MIN_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: off +.SS \[en]drive\-pacer\-min\-sleep +.PP +Minimum time to sleep between API calls. +.IP \[bu] 2 +Config: pacer_min_sleep +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_MIN_SLEEP +.IP \[bu] 2 +Type: Duration +.IP \[bu] 2 +Default: 100ms +.SS \[en]drive\-pacer\-burst +.PP +Number of API calls to allow without sleeping. +.IP \[bu] 2 +Config: pacer_burst +.IP \[bu] 2 +Env Var: RCLONE_DRIVE_PACER_BURST +.IP \[bu] 2 +Type: int +.IP \[bu] 2 +Default: 100 +.SS \[en]drive\-server\-side\-across\-configs +.PP +Allow server side operations (eg copy) to work across different drive +configs. +.PP +This can be useful if you wish to do a server side copy between two +different Google drives. +Note that this isn\[cq]t enabled by default because it isn\[cq]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 \[en]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 \[en]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\[cq]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 \[en]drive\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/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 Limitations +.PP +Drive has quite a lot of rate limiting. +This causes rclone to be limited to transferring about 2 files per +second only. +Individual files may be transferred much faster at 100s of MBytes/s but +lots of small files can take a long time. +.PP +Server side copies are also subject to a separate rate limit. +If you see User rate limit exceeded errors, wait at least 24 hours and +retry. +You can disable server side copies with \f[C]\-\-disable copy\f[R] to +download and upload the files if you prefer. +.SS Limitations of Google Docs +.PP +Google docs will appear as size \-1 in \f[C]rclone ls\f[R] and as size 0 +in anything which uses the VFS layer, eg \f[C]rclone mount\f[R], +\f[C]rclone serve\f[R]. +.PP +This is because rclone can\[cq]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\[cq]t work you will get a 0 sized file. +If you try again the doc may gain its correct size and be downloadable. +Whther it will work on not depends on the application accessing the +mount and the OS you are running \- experiment to find out if it does +work for you! +.SS Duplicated files +.PP +Sometimes, for no reason I\[cq]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\[cq]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\[cq]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\[cq]s end +when comparing directory listings. +Specifically with team drives used in combination with \[en]fast\-list. +Files that were uploaded recently may not appear on the directory list +sent to rclone when using \[en]fast\-list. +.PP +Waiting a moderate period of time between attempts (estimated to be +approximately 1 hour) and/or not using \[en]fast\-list both seem to be +effective in preventing the problem. +.SS Making your own client_id +.PP +When you use rclone with Google drive in its default configuration you +are using rclone\[cq]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\[cq]t matter what Google account you use. +(It need not be the same account as the Google Drive you want to access) +.IP "2." 3 +Select a project or create a new project. +.IP "3." 3 +Under \[lq]ENABLE APIS AND SERVICES\[rq] search for \[lq]Drive\[rq], and +enable the \[lq]Google Drive API\[rq]. +.IP "4." 3 +Click \[lq]Credentials\[rq] in the left\-side panel (not \[lq]Create +credentials\[rq], which opens the wizard), then \[lq]Create +credentials\[rq], then \[lq]OAuth client ID\[rq]. +It will prompt you to set the OAuth consent screen product name, if you +haven\[cq]t set one already. +.IP "5." 3 +Choose an application type of \[lq]other\[rq], and click +\[lq]Create\[rq]. +(the default name is fine) +.IP "6." 3 +It will show you a client ID and client secret. +Use these values in rclone config to add a new remote or edit an +existing remote. +.PP +(Thanks to \[at]balazer on github for these instructions.) +.SS Google Photos +.PP +The rclone backend for Google +Photos (https://www.google.com/photos/about/) is a specialized backend +for transferring photos and videos to and from Google Photos. +.PP +\f[B]NB\f[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 +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. +.PP +This remote is called \f[C]remote\f[R] and can now be used like this +.PP +See all the albums in your photos +.IP +.nf +\f[C] +rclone lsd remote:album +\f[R] +.fi +.PP +Make a new album +.IP +.nf +\f[C] +rclone mkdir remote:album/newAlbum +\f[R] +.fi +.PP +List the contents of an album +.IP +.nf +\f[C] +rclone ls remote:album/newAlbum +\f[R] +.fi +.PP +Sync \f[C]/home/local/images\f[R] to the Google Photos, removing any +excess files in the album. +.IP +.nf +\f[C] +rclone sync /home/local/image remote:album/newAlbum +\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. +.PP +The directories under \f[C]media\f[R] 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 \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.) +.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\[cq]ve put them into albums. +.IP +.nf +\f[C] +/ +\- upload + \- file1.jpg + \- file2.jpg + \- ... +\- media + \- all + \- file1.jpg + \- file2.jpg + \- ... + \- by\-year + \- 2000 + \- file1.jpg + \- ... + \- 2001 + \- file2.jpg + \- ... + \- ... + \- by\-month + \- 2000 + \- 2000\-01 + \- file1.jpg + \- ... + \- 2000\-02 + \- file2.jpg + \- ... + \- ... + \- by\-day + \- 2000 + \- 2000\-01\-01 + \- file1.jpg + \- ... + \- 2000\-01\-02 + \- file2.jpg + \- ... + \- ... +\- album + \- album name + \- album name/sub +\- shared\-album + \- album name + \- album name/sub +\f[R] +.fi +.PP +There are two writable parts of the tree, the \f[C]upload\f[R] directory +and sub directories of the the \f[C]album\f[R] directory. +.PP +The \f[C]upload\f[R] directory is for uploading files you don\[cq]t want +to put into albums. +This will be empty to start with and will contain the files you\[cq]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 \f[C]album\f[R] will work better. +.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 +.IP +.nf +\f[C] +rclone copy /path/to/images remote:album/images +\f[R] +.fi +.PP +and the images directory contains +.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 +.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 +.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. +.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. +.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\[cq]t understand, rclone will upload the file, then Google +Photos will give an error when it is put turned into a media item. +.PP +Note that all media items uploaded to Google Photos through the API are +stored in full resolution at \[lq]original quality\[rq] and +\f[B]will\f[R] count towards your storage quota in your Google Account. +The API does \f[B]not\f[R] offer a way to upload in \[lq]high +quality\[rq] mode.. +.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). +.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 \[lq]Google Photos\[rq] as a backup of your photos. You will +not be able to use rclone to redownload original images. You could use +`google takeout' to recover the original photos as a last resort\f[R] +.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). +.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!). +.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 +confuse rclone. +For example if you uploaded an image to \f[C]upload\f[R] then uploaded +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\[cq]t cause too many problems. +.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. +.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. +.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. +.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. +.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\[cq]ll need to experiment to see if it works for you without the +flag. +.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). +.PP +Rclone can remove files it uploaded from albums it created only. +.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). +.PP +Rclone cannot delete files anywhere except under \f[C]album\f[R]. +.SS Deleting albums +.PP +The Google Photos API does not support deleting albums \- see bug +#135714733 (https://issuetracker.google.com/issues/135714733). +.SS Standard Options +.PP +Here are the standard options specific to google photos (Google Photos). +.SS \[en]gphotos\-client\-id +.PP +Google Application Client Id Leave blank normally. +.IP \[bu] 2 +Config: client_id +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gphotos\-client\-secret +.PP +Google Application Client Secret Leave blank normally. +.IP \[bu] 2 +Config: client_secret +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_CLIENT_SECRET +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]gphotos\-read\-only +.PP +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. +.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). +.SS \[en]gphotos\-read\-size +.PP +Set to read the size of media items. +.PP +Normally rclone does not read the size of media items since this takes +another transaction. +This isn\[cq]t necessary for syncing. +However rclone mount needs to know the size of files in advance of +reading them, so setting this flag when using rclone mount is +recommended if you want to read the media. +.IP \[bu] 2 +Config: read_size +.IP \[bu] 2 +Env Var: RCLONE_GPHOTOS_READ_SIZE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS HTTP +.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. +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\[cq]t then please file an issue, or send a pull request!) +.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. +Choose a number from below, or type in your own value +[snip] +XX / http Connection + \[rs] \[dq]http\[dq] +[snip] +Storage> http +URL of http host to connect to +Choose a number from below, or type in your own value + 1 / Connect to example.com + \[rs] \[dq]https://example.com\[dq] +url> https://beta.rclone.org +Remote config +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +url = https://beta.rclone.org +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: + +Name Type +==== ==== +remote http + +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\ remote:directory\ /home/local/directory -\f[] +rclone sync remote:directory /home/local/directory +\f[R] .fi .SS Read only .PP -This remote is read only \- you can't upload files to an HTTP server. +This remote is read only \- you can\[cq]t upload files to an HTTP +server. .SS Modified time .PP Most HTTP servers store time accurate to 1 second. @@ -16737,8 +21944,8 @@ without a config file: .IP .nf \f[C] -rclone\ lsd\ \-\-http\-url\ https://beta.rclone.org\ :http: -\f[] +rclone lsd \-\-http\-url https://beta.rclone.org :http: +\f[R] .fi .SS Standard Options .PP @@ -16753,7 +21960,7 @@ Env Var: RCLONE_HTTP_URL .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -16764,7 +21971,7 @@ Examples: Connect to example.com .RE .IP \[bu] 2 -\[lq]https://user:pass\@example.com\[rq] +\[lq]https://user:pass\[at]example.com\[rq] .RS 2 .IP \[bu] 2 Connect to example.com using a username and password @@ -16797,7 +22004,7 @@ Type: CommaSepList Default: .SS \[en]http\-no\-slash .PP -Set this if the site doesn't end directories with / +Set this if the site doesn\[cq]t end directories with / .PP Use this if your target website does not use / on the end of directories. @@ -16820,7 +22027,7 @@ Type: bool Default: false .SS \[en]http\-no\-head .PP -Don't use HEAD requests to find file sizes in dir listing +Don\[cq]t use HEAD requests to find file sizes in dir listing .PP If your site is being very slow to load then you can try this option. Normally rclone does a HEAD request for each potential file in a @@ -16837,9 +22044,9 @@ This will mean .IP \[bu] 2 directory listings are much quicker .IP \[bu] 2 -rclone won't have the times or sizes of any files +rclone won\[cq]t have the times or sizes of any files .IP \[bu] 2 -some files that don't exist may be in the listing +some files that don\[cq]t exist may be in the listing .IP \[bu] 2 Config: no_head .IP \[bu] 2 @@ -16850,66 +22057,66 @@ Type: bool Default: false .SS Hubic .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP -Paths are specified as \f[C]remote:container\f[] (or \f[C]remote:\f[] -for the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:container/path/to/dir\f[]. +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 +\f[C]remote:container/path/to/dir\f[R]. .PP The initial setup for Hubic involves getting a token from Hubic which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. +\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[]. +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[] + rclone config +\f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] -n)\ New\ remote -s)\ Set\ configuration\ password -n/s>\ n -name>\ remote -Type\ of\ storage\ to\ configure. -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value +n) New remote +s) Set configuration password +n/s> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value [snip] -XX\ /\ Hubic -\ \ \ \\\ "hubic" +XX / Hubic + \[rs] \[dq]hubic\[dq] [snip] -Storage>\ hubic -Hubic\ Client\ Id\ \-\ leave\ blank\ normally. +Storage> hubic +Hubic Client Id \- leave blank normally. client_id> -Hubic\ Client\ Secret\ \-\ leave\ blank\ normally. +Hubic Client Secret \- leave blank normally. client_secret> -Remote\ config -Use\ auto\ config? -\ *\ Say\ Y\ if\ not\ sure -\ *\ Say\ N\ if\ you\ are\ working\ on\ a\ remote\ or\ headless\ machine -y)\ Yes -n)\ No -y/n>\ y -If\ your\ browser\ doesn\[aq]t\ open\ automatically\ go\ to\ the\ following\ link:\ http://127.0.0.1:53682/auth -Log\ in\ and\ authorize\ rclone\ for\ access -Waiting\ for\ code... -Got\ code +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -client_id\ = -client_secret\ = -token\ =\ {"access_token":"XXXXXX"} +client_id = +client_secret = +token = {\[dq]access_token\[dq]:\[dq]XXXXXX\[dq]} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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 @@ -16919,53 +22126,53 @@ Note that rclone runs a webserver on your local machine to collect the token as returned from Hubic. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List containers in the top level of your Hubic .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your Hubic .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an Hubic directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .PP If you want the directory to be visible in the official \f[I]Hubic -browser\f[], you need to copy your files to the \f[C]default\f[] +browser\f[R], you need to copy your files to the \f[C]default\f[R] directory .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:default/backup -\f[] +rclone copy /home/source remote:default/backup +\f[R] .fi .SS \[en]fast\-list .PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use +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 (/docs/#fast-list) for more details. .SS Modified time .PP The modified time is stored as metadata on the object as -\f[C]X\-Object\-Meta\-Mtime\f[] as floating point since the epoch +\f[C]X\-Object\-Meta\-Mtime\f[R] as floating point since the epoch accurate to 1 ns. .PP This is a de facto standard (used in the official python\-swiftclient @@ -16986,7 +22193,7 @@ Env Var: RCLONE_HUBIC_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]hubic\-client\-secret .PP Hubic Client Secret Leave blank normally. @@ -16997,7 +22204,7 @@ Env Var: RCLONE_HUBIC_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to hubic (Hubic). @@ -17017,7 +22224,7 @@ Type: SizeSuffix Default: 5G .SS \[en]hubic\-no\-chunk .PP -Don't chunk files during streaming upload. +Don\[cq]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. @@ -17035,128 +22242,136 @@ Env Var: RCLONE_HUBIC_NO_CHUNK Type: bool .IP \[bu] 2 Default: false +.SS \[en]hubic\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_HUBIC_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8 .SS Limitations .PP This uses the normal OpenStack Swift mechanism to refresh the Swift API credentials and ignores the expires field returned by the Hubic API. .PP -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 +The Swift API doesn\[cq]t return a correct MD5SUM for segmented files +(Dynamic or Static Large Objects) so rclone won\[cq]t check or use the MD5SUM for these. .SS Jottacloud .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP -To configure Jottacloud you will need to enter your username and -password and select a mountpoint. +To configure Jottacloud you will need to generate a personal security +token in the Jottacloud web inteface. +You will the option to do in your account security +settings (https://www.jottacloud.com/web/secure). +Note that the web inteface may refer to this token as a JottaCli token. .PP -Here is an example of how to make a remote called \f[C]remote\f[]. +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[] + 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>\ jotta -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 +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> jotta +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\ /\ JottaCloud -\ \ \ \\\ "jottacloud" +XX / JottaCloud + \[rs] \[dq]jottacloud\[dq] [snip] -Storage>\ jottacloud -**\ See\ help\ for\ jottacloud\ backend\ at:\ https://rclone.org/jottacloud/\ ** +Storage> jottacloud +** See help for jottacloud backend at: https://rclone.org/jottacloud/ ** -Edit\ advanced\ config?\ (y/n) -y)\ Yes -n)\ No -y/n>\ n -Remote\ config +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config -Do\ you\ want\ to\ create\ a\ machine\ specific\ API\ key? +Generate a personal login token here: https://www.jottacloud.com/web/secure +Login Token> -Rclone\ has\ it\[aq]s\ own\ Jottacloud\ API\ KEY\ which\ works\ fine\ as\ long\ as\ one\ only\ uses\ rclone\ on\ a\ single\ machine.\ When\ you\ want\ to\ use\ rclone\ with\ this\ account\ on\ more\ than\ one\ machine\ it\[aq]s\ recommended\ to\ create\ a\ machine\ specific\ API\ key.\ These\ keys\ can\ NOT\ be\ shared\ between\ machines. +Do you want to use a non standard device/mountpoint e.g. for accessing files uploaded using the official Jottacloud client? -y)\ Yes -n)\ No -y/n>\ y -Username>\ 0xC4KE\@gmail.com -Your\ Jottacloud\ password\ is\ only\ required\ during\ setup\ and\ will\ not\ be\ stored. -password: - -Do\ you\ want\ to\ use\ a\ non\ standard\ device/mountpoint\ e.g.\ for\ accessing\ files\ uploaded\ using\ the\ official\ Jottacloud\ client? - -y)\ Yes -n)\ No -y/n>\ y -Please\ select\ the\ device\ to\ use.\ Normally\ this\ will\ be\ Jotta -Choose\ a\ number\ from\ below,\ or\ type\ in\ an\ existing\ value -\ 1\ >\ DESKTOP\-3H31129 -\ 2\ >\ fla1 -\ 3\ >\ Jotta -Devices>\ 3 -Please\ select\ the\ mountpoint\ to\ user.\ Normally\ this\ will\ be\ Archive -Choose\ a\ number\ from\ below,\ or\ type\ in\ an\ existing\ value -\ 1\ >\ Archive -\ 2\ >\ Shared -\ 3\ >\ Sync -Mountpoints>\ 1 +y) Yes +n) No +y/n> y +Please select the device to use. Normally this will be Jotta +Choose a number from below, or type in an existing value + 1 > DESKTOP\-3H31129 + 2 > fla1 + 3 > Jotta +Devices> 3 +Please select the mountpoint to user. Normally this will be Archive +Choose a number from below, or type in an existing value + 1 > Archive + 2 > Shared + 3 > Sync +Mountpoints> 1 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [jotta] -type\ =\ jottacloud -user\ =\ 0xC4KE\@gmail.com -client_id\ =\ ..... -client_secret\ =\ ........ -token\ =\ {........} -device\ =\ Jotta -mountpoint\ =\ Archive +type = jottacloud +user = 0xC4KE\[at]gmail.com +token = {........} +device = Jotta +mountpoint = Archive +configVersion = 1 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Jottacloud .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your Jottacloud .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an Jottacloud directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Devices and Mountpoints .PP @@ -17165,13 +22380,13 @@ install it on and then creates a mountpoint for each folder you select for Backup. The web interface uses a special device called Jotta for the Archive, Sync and Shared mountpoints. -In most cases you'll want to use the Jotta/Archive device/mounpoint -however if you want to access files uploaded by the official rclone -provides the option to select other devices and mountpoints during -config. +In most cases you\[cq]ll want to use the Jotta/Archive device/mounpoint +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. .SS \[en]fast\-list .PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use +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 (/docs/#fast-list) for more details. .PP @@ -17185,14 +22400,14 @@ second. These will be used to detect whether objects need syncing or not. .PP Jottacloud supports MD5 type hashes, so you can use the -\f[C]\-\-checksum\f[] flag. +\f[C]\-\-checksum\f[R] flag. .PP 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 \f[C]TMPDIR\f[] environment variable +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 -\f[C]\-\-jottacloud\-md5\-memory\-limit\f[] flag. +\f[C]\-\-jottacloud\-md5\-memory\-limit\f[R] flag. .SS Restricted filename characters .PP In addition to the default restricted characters @@ -17211,65 +22426,65 @@ Replacement T} _ T{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} T{ * T}@T{ 0x2A T}@T{ -＊ +\[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ -： +\[uFF1A] 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{ 0x7C T}@T{ -｜ +\[uFF5C] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in XML strings. +they can\[cq]t be used in XML strings. .SS Deleting files .PP By default rclone will send all files to the trash when deleting files. Due to a lack of API documentation emptying the trash is currently only possible via the Jottacloud website. If deleting permanently is required then use the -\f[C]\-\-jottacloud\-hard\-delete\f[] flag, or set the equivalent +\f[C]\-\-jottacloud\-hard\-delete\f[R] flag, or set the equivalent environment variable. .SS Versions .PP @@ -17281,7 +22496,7 @@ versions can be accessed via the Jottacloud Website. .SS Quota information .PP To view your current quota you can use the -\f[C]rclone\ about\ remote:\f[] command which will display your usage +\f[C]rclone about remote:\f[R] command which will display your usage limit (unless it is unlimited) and the current usage. .SS Device IDs .PP @@ -17335,7 +22550,7 @@ Type: bool Default: false .SS \[en]jottacloud\-upload\-resume\-limit .PP -Files bigger than this can be resumed if the upload fail's. +Files bigger than this can be resumed if the upload fail\[cq]s. .IP \[bu] 2 Config: upload_resume_limit .IP \[bu] 2 @@ -17344,16 +22559,32 @@ Env Var: RCLONE_JOTTACLOUD_UPLOAD_RESUME_LIMIT Type: SizeSuffix .IP \[bu] 2 Default: 10M +.SS \[en]jottacloud\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_JOTTACLOUD_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot .SS Limitations .PP -Note that Jottacloud is case insensitive so you can't have a file called -\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +Note that Jottacloud is case insensitive so you can\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .PP -There are quite a few characters that can't be in Jottacloud file names. +There are quite a few characters that can\[cq]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. +in it will be mapped to \[uFF1F] instead. .PP Jottacloud only supports filenames up to 255 characters in length. .SS Troubleshooting @@ -17364,105 +22595,105 @@ previously deleted paths to fail. Emptying the trash should help in such cases. .SS Koofr .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for Koofr involves creating an application password for rclone. You can do that by opening the Koofr web application (https://app.koofr.net/app/admin/preferences/password), -giving the password a nice name like \f[C]rclone\f[] and clicking on +giving the password a nice name like \f[C]rclone\f[R] and clicking on generate. .PP -Here is an example of how to make a remote called \f[C]koofr\f[]. +Here is an example of how to make a remote called \f[C]koofr\f[R]. First run: .IP .nf \f[C] -\ rclone\ config -\f[] + 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>\ koofr\ -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 +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> koofr +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\ /\ Koofr -\ \ \ \\\ "koofr" +XX / Koofr + \[rs] \[dq]koofr\[dq] [snip] -Storage>\ koofr -**\ See\ help\ for\ koofr\ backend\ at:\ https://rclone.org/koofr/\ ** +Storage> koofr +** See help for koofr backend at: https://rclone.org/koofr/ ** -Your\ Koofr\ user\ name -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -user>\ USER\@NAME -Your\ Koofr\ password\ for\ rclone\ (generate\ one\ at\ https://app.koofr.net/app/admin/preferences/password) -y)\ Yes\ type\ in\ my\ own\ password -g)\ Generate\ random\ password -y/g>\ y -Enter\ the\ password: +Your Koofr user name +Enter a string value. Press Enter for the default (\[dq]\[dq]). +user> USER\[at]NAME +Your Koofr password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password) +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: password: -Confirm\ the\ password: +Confirm the password: password: -Edit\ advanced\ config?\ (y/n) -y)\ Yes -n)\ No -y/n>\ n -Remote\ config +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [koofr] -type\ =\ koofr -baseurl\ =\ https://app.koofr.net -user\ =\ USER\@NAME -password\ =\ ***\ ENCRYPTED\ *** +type = koofr +baseurl = https://app.koofr.net +user = USER\[at]NAME +password = *** ENCRYPTED *** \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] .fi .PP You can choose to edit advanced config in order to enter your own service URL if you use an on\-premise or white label Koofr instance, or choose an alternative mount instead of your primary storage. .PP -Once configured you can then use \f[C]rclone\f[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Koofr .IP .nf \f[C] -rclone\ lsd\ koofr: -\f[] +rclone lsd koofr: +\f[R] .fi .PP List all the files in your Koofr .IP .nf \f[C] -rclone\ ls\ koofr: -\f[] +rclone ls koofr: +\f[R] .fi .PP To copy a local directory to an Koofr directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Restricted filename characters .PP @@ -17482,16 +22713,16 @@ Replacement T} _ T{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in XML strings. +they can\[cq]t be used in XML strings. .SS Standard Options .PP Here are the standard options specific to koofr (Koofr). @@ -17505,7 +22736,7 @@ Env Var: RCLONE_KOOFR_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]koofr\-password .PP Your Koofr password for rclone (generate one at @@ -17517,7 +22748,7 @@ Env Var: RCLONE_KOOFR_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to koofr (Koofr). @@ -17543,7 +22774,7 @@ Env Var: RCLONE_KOOFR_MOUNTID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]koofr\-setmtime .PP Does the backend support setting modification time. @@ -17557,9 +22788,23 @@ Env Var: RCLONE_KOOFR_SETMTIME Type: bool .IP \[bu] 2 Default: true +.SS \[en]koofr\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_KOOFR_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS Limitations .PP -Note that Koofr is case insensitive so you can't have a file called +Note that Koofr is case insensitive so you can\[cq]t have a file called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .SS Mail.ru Cloud .PP @@ -17571,9 +22816,10 @@ available only on Windows. .SS Features highlights .IP \[bu] 2 Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[] +\f[C]remote:directory/subdirectory\f[R] .IP \[bu] 2 -Files have a \f[C]last\ modified\ time\f[] property, directories don't +Files have a \f[C]last modified time\f[R] property, directories +don\[cq]t .IP \[bu] 2 Deleted files are by default moved to the trash .IP \[bu] 2 @@ -17598,68 +22844,68 @@ First create a Mail.ru Cloud account and choose a tariff, then run .IP .nf \f[C] -rclone\ config -\f[] +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. -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 +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> remote +Type of storage to configure. +Type of storage to configure. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +Choose a number from below, or type in your own value [snip] -XX\ /\ Mail.ru\ Cloud -\ \ \ \\\ "mailru" +XX / Mail.ru Cloud + \[rs] \[dq]mailru\[dq] [snip] -Storage>\ mailru -User\ name\ (usually\ email) -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). -user>\ username\@mail.ru +Storage> mailru +User name (usually email) +Enter a string value. Press Enter for the default (\[dq]\[dq]). +user> username\[at]mail.ru Password -y)\ Yes\ type\ in\ my\ own\ password -g)\ Generate\ random\ password -y/g>\ y -Enter\ the\ password: +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: password: -Confirm\ the\ password: +Confirm the password: password: -Skip\ full\ upload\ if\ there\ is\ another\ file\ with\ same\ data\ hash. -This\ feature\ is\ called\ "speedup"\ or\ "put\ by\ hash".\ It\ is\ especially\ efficient -in\ case\ of\ generally\ available\ files\ like\ popular\ books,\ video\ or\ audio\ clips +Skip full upload if there is another file with same data hash. +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 [snip] -Enter\ a\ boolean\ value\ (true\ or\ false).\ Press\ Enter\ for\ the\ default\ ("true"). -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Enable -\ \ \ \\\ "true" -\ 2\ /\ Disable -\ \ \ \\\ "false" -speedup_enable>\ 1 -Edit\ advanced\ config?\ (y/n) -y)\ Yes -n)\ No -y/n>\ n -Remote\ config +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 / Enable + \[rs] \[dq]true\[dq] + 2 / Disable + \[rs] \[dq]false\[dq] +speedup_enable> 1 +Edit advanced config? (y/n) +y) Yes +n) No +y/n> n +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -type\ =\ mailru -user\ =\ username\@mail.ru -pass\ =\ ***\ ENCRYPTED\ *** -speedup_enable\ =\ true +type = mailru +user = username\[at]mail.ru +pass = *** ENCRYPTED *** +speedup_enable = true \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] .fi .PP Configuration of this backend does not require a local web browser. @@ -17669,33 +22915,33 @@ See top level directories .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP Make a new directory .IP .nf \f[C] -rclone\ mkdir\ remote:directory -\f[] +rclone mkdir remote:directory +\f[R] .fi .PP List the contents of a directory .IP .nf \f[C] -rclone\ ls\ remote:directory -\f[] +rclone ls remote:directory +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote path, deleting any +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\ /home/local/directory\ remote:directory -\f[] +rclone sync /home/local/directory remote:directory +\f[R] .fi .SS Modified time .PP @@ -17716,13 +22962,13 @@ Removing a file or directory actually moves it to the trash, which is not visible to rclone but can be seen in a web browser. The trashed file still occupies part of total quota. If you wish to empty your trash and free some quota, you can use the -\f[C]rclone\ cleanup\ remote:\f[] command, which will permanently delete +\f[C]rclone cleanup remote:\f[R] command, which will permanently delete all your trashed files. This command does not take any path arguments. .SS Quota information .PP To view your current quota you can use the -\f[C]rclone\ about\ remote:\f[] command which will display your usage +\f[C]rclone about remote:\f[R] command which will display your usage limit (quota) and the current usage. .SS Restricted filename characters .PP @@ -17742,65 +22988,65 @@ Replacement T} _ T{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} T{ * T}@T{ 0x2A T}@T{ -＊ +\[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ -： +\[uFF1A] 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{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ -｜ +\[uFF5C] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Limitations .PP File size limits depend on your account. @@ -17808,7 +23054,7 @@ A single file size is limited by 2G for a free account and unlimited for paid tariffs. Please refer to the Mail.ru site for the total uploaded size limits. .PP -Note that Mailru is case insensitive so you can't have a file called +Note that Mailru is case insensitive so you can\[cq]t have a file called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .SS Standard Options .PP @@ -17823,7 +23069,7 @@ Env Var: RCLONE_MAILRU_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]mailru\-pass .PP Password @@ -17834,7 +23080,7 @@ Env Var: RCLONE_MAILRU_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]mailru\-speedup\-enable .PP Skip full upload if there is another file with same data hash. @@ -17878,7 +23124,7 @@ Here are the advanced options specific to mailru (Mail.ru Cloud). .PP Comma separated list of file name patterns eligible for speedup (put by hash). -Patterns are case insensitive and can contain '*' or `?' meta +Patterns are case insensitive and can contain \[cq]*\[cq] or `?' meta characters. .IP \[bu] 2 Config: speedup_file_patterns @@ -17888,30 +23134,30 @@ Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS Type: string .IP \[bu] 2 Default: -\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3,\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq] +\[lq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3,\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[rq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 -"" +\[dq]\[dq] .RS 2 .IP \[bu] 2 Empty list completely disables speedup (put by hash). .RE .IP \[bu] 2 -"*" +\[dq]*\[dq] .RS 2 .IP \[bu] 2 All files will be attempted for speedup. .RE .IP \[bu] 2 -\[lq]\f[I].mkv,\f[].avi,\f[I].mp4,\f[].mp3\[rq] +\[lq]\f[I].mkv,\f[R].avi,\f[I].mp4,\f[R].mp3\[rq] .RS 2 .IP \[bu] 2 Only common audio/video files will be tried for put by hash. .RE .IP \[bu] 2 -\[lq]\f[I].zip,\f[].gz,\f[I].rar,\f[].pdf\[rq] +\[lq]\f[I].zip,\f[R].gz,\f[I].rar,\f[R].pdf\[rq] .RS 2 .IP \[bu] 2 Only common archives or PDF books will be tried for speedup. @@ -18023,7 +23269,7 @@ Env Var: RCLONE_MAILRU_USER_AGENT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]mailru\-quirks .PP Comma separated list of internal maintenance flags. @@ -18041,7 +23287,22 @@ Env Var: RCLONE_MAILRU_QUIRKS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS \[en]mailru\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_MAILRU_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS Mega .PP Mega (https://mega.nz/) is a cloud storage and file hosting service @@ -18053,90 +23314,90 @@ files without knowledge of the key used for encryption. This is an rclone backend for Mega which supports the file transfer features of Mega using the same client side encryption. .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP -Here is an example of how to make a remote called \f[C]remote\f[]. +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[] + 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 +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\ /\ Mega -\ \ \ \\\ "mega" +XX / Mega + \[rs] \[dq]mega\[dq] [snip] -Storage>\ mega -User\ name -user>\ you\@example.com +Storage> mega +User name +user> you\[at]example.com Password. -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: +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: +Confirm the password: password: -Remote\ config +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -type\ =\ mega -user\ =\ you\@example.com -pass\ =\ ***\ ENCRYPTED\ *** +type = mega +user = you\[at]example.com +pass = *** ENCRYPTED *** \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] .fi .PP -\f[B]NOTE:\f[] The encryption keys need to have been already generated +\f[B]NOTE:\f[R] The encryption keys need to have been already generated after a regular login via the browser, otherwise attempting to use the -credentials in \f[C]rclone\f[] will fail. +credentials in \f[C]rclone\f[R] will fail. .PP -Once configured you can then use \f[C]rclone\f[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your Mega .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your Mega .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an Mega directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Modified time and hashes .PP @@ -18159,19 +23420,19 @@ 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 (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Duplicated files .PP Mega can have two files with exactly the same name and path (unlike a @@ -18180,25 +23441,25 @@ normal file system). Duplicated files cause problems with the syncing and you will see messages in the log about duplicates. .PP -Use \f[C]rclone\ dedupe\f[] to fix duplicated files. +Use \f[C]rclone dedupe\f[R] to fix duplicated files. .SS Failure to log\-in .PP Mega remotes seem to get blocked (reject logins) under \[lq]heavy use\[rq]. -We haven't worked out the exact blocking rules but it seems to be +We haven\[cq]t worked out the exact blocking rules but it seems to be related to fast paced, sucessive rclone commands. .PP For example, executing this command 90 times in a row -\f[C]rclone\ link\ remote:file\f[] will cause the remote to become +\f[C]rclone link remote:file\f[R] will cause the remote to become \[lq]blocked\[rq]. This is not an abnormal situation, for example if you wish to get the public links of a directory with hundred of files\&... After more or less a week, the remote will remote accept rclone logins normally again. .PP You can mitigate this issue by mounting the remote it with -\f[C]rclone\ mount\f[]. +\f[C]rclone mount\f[R]. This will log\-in when mounting and a log\-out when unmounting only. -You can also run \f[C]rclone\ rcd\f[] and then use \f[C]rclone\ rc\f[] +You can also run \f[C]rclone rcd\f[R] and then use \f[C]rclone rc\f[R] to run the commands over the API to avoid logging in each time. .PP Rclone does not currently close mega sessions (you can see them in the @@ -18206,7 +23467,7 @@ web interface), however closing the sessions does not solve the issue. .PP If you space rclone commands by 3 seconds it will avoid blocking the remote. -We haven't identified the exact blocking rules, so perhaps one could +We haven\[cq]t identified the exact blocking rules, so perhaps one could execute the command 80 times without waiting and avoid blocking by waiting 3 seconds, then continuing\&... .PP @@ -18215,7 +23476,7 @@ in stone. .PP Other tools seem not to produce this blocking effect, as they use a different working approach (state\-based, using sessionIDs instead of -log\-in) which isn't compatible with the current stateless rclone +log\-in) which isn\[cq]t compatible with the current stateless rclone approach. .PP Note that once blocked, the use of other tools (such as megacmd) is not @@ -18243,7 +23504,7 @@ Env Var: RCLONE_MEGA_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]mega\-pass .PP Password. @@ -18254,7 +23515,7 @@ Env Var: RCLONE_MEGA_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to mega (Mega). @@ -18287,111 +23548,186 @@ Env Var: RCLONE_MEGA_HARD_DELETE Type: bool .IP \[bu] 2 Default: false +.SS \[en]mega\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_MEGA_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8,Dot .SS Limitations .PP This backend uses the go\-mega go library (https://github.com/t3rm1n4l/go-mega) which is an opensource go library implementing the Mega API. -There doesn't appear to be any documentation for the mega protocol +There doesn\[cq]t appear to be any documentation for the mega protocol beyond the mega C++ SDK (https://github.com/meganz/sdk) source code so there are likely quite a few errors still remaining in this library. .PP Mega allows duplicate files which may confuse rclone. +.SS Memory +.PP +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). +Because it has no parameters you can just use it with the +\f[C]:memory:\f[R] remote name. +.PP +You can configure it as a remote like this with \f[C]rclone config\f[R] +too if you want to: +.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 / Memory + \[rs] \[dq]memory\[dq] +[snip] +Storage> memory +** See help for memory backend at: https://rclone.org/memory/ ** + +Remote config + +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = memory +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Because the memory backend isn\[cq]t persistent it is most useful for +testing or with an rclone server or rclone mount, eg +.IP +.nf +\f[C] +rclone mount :memory: /mnt/tmp +rclone serve webdav :memory: +rclone serve sftp :memory: +\f[R] +.fi +.SS Modified time and hashes +.PP +The memory backend supports MD5 hashes and modification times accurate +to 1 nS. +.SS Restricted filename characters +.PP +The memory backend replaces the default restricted characters +set (/overview/#restricted-characters). .SS Microsoft Azure Blob Storage .PP -Paths are specified as \f[C]remote:container\f[] (or \f[C]remote:\f[] -for the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:container/path/to/dir\f[]. +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 +\f[C]remote:container/path/to/dir\f[R]. .PP Here is an example of making a Microsoft Azure Blob Storage configuration. -For a remote called \f[C]remote\f[]. +For a remote called \f[C]remote\f[R]. First run: .IP .nf \f[C] -\ rclone\ config -\f[] + 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 +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\ /\ Microsoft\ Azure\ Blob\ Storage -\ \ \ \\\ "azureblob" +XX / Microsoft Azure Blob Storage + \[rs] \[dq]azureblob\[dq] [snip] -Storage>\ azureblob -Storage\ Account\ Name -account>\ account_name -Storage\ Account\ Key -key>\ base64encodedkey== -Endpoint\ for\ the\ service\ \-\ leave\ blank\ normally. -endpoint>\ -Remote\ config +Storage> azureblob +Storage Account Name +account> account_name +Storage Account Key +key> base64encodedkey== +Endpoint for the service \- leave blank normally. +endpoint> +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -account\ =\ account_name -key\ =\ base64encodedkey== -endpoint\ =\ +account = account_name +key = base64encodedkey== +endpoint = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] .fi .PP See all containers .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP Make a new container .IP .nf \f[C] -rclone\ mkdir\ remote:container -\f[] +rclone mkdir remote:container +\f[R] .fi .PP List the contents of a container .IP .nf \f[C] -rclone\ ls\ remote:container -\f[] +rclone ls remote:container +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote container, deleting +Sync \f[C]/home/local/directory\f[R] to the remote container, deleting any excess files in the container. .IP .nf \f[C] -rclone\ sync\ /home/local/directory\ remote:container -\f[] +rclone sync /home/local/directory remote:container +\f[R] .fi .SS \[en]fast\-list .PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use +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 (/docs/#fast-list) for more details. .SS Modified time .PP The modified time is stored as metadata on the object with the -\f[C]mtime\f[] key. +\f[C]mtime\f[R] 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. @@ -18417,14 +23753,14 @@ T{ T}@T{ 0x2F T}@T{ -／ +\[uFF0F] T} T{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} .TE .PP @@ -18447,12 +23783,12 @@ T{ T}@T{ 0x2E T}@T{ -． +\[uFF0E] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Hashes .PP MD5 hashes are stored with blobs. @@ -18464,14 +23800,14 @@ Rclone has 3 ways of authenticating with Azure Blob Storage: .SS Account and Key .PP This is the most straight forward and least flexible way. -Just fill in the \f[C]account\f[] and \f[C]key\f[] lines and leave the +Just fill in the \f[C]account\f[R] and \f[C]key\f[R] lines and leave the rest blank. .SS SAS URL .PP This can be an account level SAS URL or container level SAS URL .PP -To use it leave \f[C]account\f[], \f[C]key\f[] blank and fill in -\f[C]sas_url\f[]. +To use it leave \f[C]account\f[R], \f[C]key\f[R] blank and fill in +\f[C]sas_url\f[R]. .PP Account level SAS URL or container level SAS URL can be obtained from Azure portal or Azure Storage Explorer. @@ -18483,8 +23819,8 @@ on particular container, eg .IP .nf \f[C] -rclone\ ls\ azureblob:container\ or\ rclone\ ls\ azureblob: -\f[] +rclone ls azureblob:container or rclone ls azureblob: +\f[R] .fi .PP Since container name already exists in SAS URL, you can leave it empty @@ -18494,9 +23830,9 @@ However these will not work .IP .nf \f[C] -rclone\ lsd\ azureblob: -rclone\ ls\ azureblob:othercontainer -\f[] +rclone lsd azureblob: +rclone ls azureblob:othercontainer +\f[R] .fi .PP This would be useful for temporarily allowing third parties access to a @@ -18509,20 +23845,20 @@ 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[] of them being uploaded at once. +\f[C]\-\-transfers\f[R] of them being uploaded at once. .PP -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. +Files can\[cq]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[]. +\f[C]\-\-azureblob\-chunk\-size 100M\f[R]. .PP -Note that rclone doesn't commit the block list until the end of the +Note that rclone doesn\[cq]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. +in progress as Azure won\[cq]t allow more than that amount of +uncommitted blocks. .SS Standard Options .PP Here are the standard options specific to azureblob (Microsoft Azure @@ -18537,7 +23873,7 @@ Env Var: RCLONE_AZUREBLOB_ACCOUNT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]azureblob\-key .PP Storage Account Key (leave blank to use SAS URL or Emulator) @@ -18548,7 +23884,7 @@ Env Var: RCLONE_AZUREBLOB_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]azureblob\-sas\-url .PP SAS URL for container level access only (leave blank if using @@ -18560,7 +23896,7 @@ Env Var: RCLONE_AZUREBLOB_SAS_URL .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]azureblob\-use\-emulator .PP Uses local storage emulator if provided as `true' (leave blank if using @@ -18587,7 +23923,7 @@ Env Var: RCLONE_AZUREBLOB_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]azureblob\-upload\-cutoff .PP Cutoff for switching to chunked upload (<= 256MB). @@ -18643,8 +23979,8 @@ Archived blobs can be restored by setting access tier to hot or cool. Leave blank if you intend to use default access tier, which is set at account level .PP -If there is no \[lq]access tier\[rq] specified, rclone doesn't apply any -tier. +If there is no \[lq]access tier\[rq] specified, rclone doesn\[cq]t apply +any tier. rclone performs \[lq]Set Tier\[rq] operation on blobs while uploading, if objects are not modified, specifying \[lq]access tier\[rq] to new one will have no effect. @@ -18659,7 +23995,21 @@ Env Var: RCLONE_AZUREBLOB_ACCESS_TIER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS \[en]azureblob\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_AZUREBLOB_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8 .SS Limitations .PP MD5 sums are only uploaded with chunked files if the source has an MD5 @@ -18669,105 +24019,105 @@ This will always be the case for a local to azure copy. .PP You can test rlcone with storage emulator locally, to do this make sure azure storage emulator installed locally and set up a new remote with -\f[C]rclone\ config\f[] follow instructions described in introduction, -set \f[C]use_emulator\f[] config as \f[C]true\f[], you do not need to +\f[C]rclone config\f[R] follow instructions described in introduction, +set \f[C]use_emulator\f[R] config as \f[C]true\f[R], you do not need to provide default account name or key if using emulator. .SS Microsoft OneDrive .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for OneDrive involves getting a token from Microsoft which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. +\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[]. +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[] + rclone config +\f[R] .fi .PP This will guide you through an interactive setup process: .IP .nf \f[C] -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>\ 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 +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> 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\ /\ Microsoft\ OneDrive -\ \ \ \\\ "onedrive" +XX / Microsoft OneDrive + \[rs] \[dq]onedrive\[dq] [snip] -Storage>\ onedrive -Microsoft\ App\ Client\ Id -Leave\ blank\ normally. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +Storage> onedrive +Microsoft App Client Id +Leave blank normally. +Enter a string value. Press Enter for the default (\[dq]\[dq]). client_id> -Microsoft\ App\ Client\ Secret -Leave\ blank\ normally. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +Microsoft App 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 -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 -Choose\ a\ number\ from\ below,\ or\ type\ in\ an\ existing\ value -\ 1\ /\ OneDrive\ Personal\ or\ Business -\ \ \ \\\ "onedrive" -\ 2\ /\ Sharepoint\ site -\ \ \ \\\ "sharepoint" -\ 3\ /\ Type\ in\ driveID -\ \ \ \\\ "driveid" -\ 4\ /\ Type\ in\ SiteID -\ \ \ \\\ "siteid" -\ 5\ /\ Search\ a\ Sharepoint\ site -\ \ \ \\\ "search" -Your\ choice>\ 1 -Found\ 1\ drives,\ please\ select\ the\ one\ you\ want\ to\ use: -0:\ OneDrive\ (business)\ id=b!Eqwertyuiopasdfghjklzxcvbnm\-7mnbvcxzlkjhgfdsapoiuytrewqk -Chose\ drive\ to\ use:>\ 0 -Found\ drive\ \[aq]root\[aq]\ of\ type\ \[aq]business\[aq],\ URL:\ https://org\-my.sharepoint.com/personal/you/Documents -Is\ that\ okay? -y)\ Yes -n)\ No -y/n>\ y +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 +Choose a number from below, or type in an existing value + 1 / OneDrive Personal or Business + \[rs] \[dq]onedrive\[dq] + 2 / Sharepoint site + \[rs] \[dq]sharepoint\[dq] + 3 / Type in driveID + \[rs] \[dq]driveid\[dq] + 4 / Type in SiteID + \[rs] \[dq]siteid\[dq] + 5 / Search a Sharepoint site + \[rs] \[dq]search\[dq] +Your choice> 1 +Found 1 drives, please select the one you want to use: +0: OneDrive (business) id=b!Eqwertyuiopasdfghjklzxcvbnm\-7mnbvcxzlkjhgfdsapoiuytrewqk +Chose drive to use:> 0 +Found drive \[aq]root\[aq] of type \[aq]business\[aq], URL: https://org\-my.sharepoint.com/personal/you/Documents +Is that okay? +y) Yes +n) No +y/n> y \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -type\ =\ onedrive -token\ =\ {"access_token":"youraccesstoken","token_type":"Bearer","refresh_token":"yourrefreshtoken","expiry":"2018\-08\-26T22:39:52.486512262+08:00"} -drive_id\ =\ b!Eqwertyuiopasdfghjklzxcvbnm\-7mnbvcxzlkjhgfdsapoiuytrewqk -drive_type\ =\ business +type = onedrive +token = {\[dq]access_token\[dq]:\[dq]youraccesstoken\[dq],\[dq]token_type\[dq]:\[dq]Bearer\[dq],\[dq]refresh_token\[dq]:\[dq]yourrefreshtoken\[dq],\[dq]expiry\[dq]:\[dq]2018\-08\-26T22:39:52.486512262+08:00\[dq]} +drive_id = b!Eqwertyuiopasdfghjklzxcvbnm\-7mnbvcxzlkjhgfdsapoiuytrewqk +drive_type = business \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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 @@ -18777,67 +24127,71 @@ Note that rclone runs a webserver on your local machine to collect the token as returned from Microsoft. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your OneDrive .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your OneDrive .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an OneDrive directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Getting your own Client ID and Key .PP -rclone uses a pair of Client ID and Key shared by all rclone users when -performing requests by default. +You can use your own Client ID if the default (\f[C]client_id\f[R] left +blank) one doesn\[cq]t work for you or you see lots of throttling. +The default Client ID and Key is shared by all rclone users when +performing requests. +.PP If you are having problems with them (E.g., seeing a lot of throttling), you can get your own Client ID and Key by following the steps below: .IP "1." 3 Open https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade, -then click \f[C]New\ registration\f[]. +then click \f[C]New registration\f[R]. .IP "2." 3 -Enter a name for your app, choose your account type, select \f[C]Web\f[] -in \f[C]Redirect\ URI\f[] Enter \f[C]http://localhost:53682/\f[] and -click Register. -Copy and keep the \f[C]Application\ (client)\ ID\f[] under the app name +Enter a name for your app, choose account type +\f[C]Any Azure AD directory \- Multitenant\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. +Copy and keep the \f[C]Application (client) ID\f[R] under the app name for later use. .IP "3." 3 -Under \f[C]manage\f[] select \f[C]Certificates\ &\ secrets\f[], click -\f[C]New\ client\ secret\f[]. +Under \f[C]manage\f[R] select \f[C]Certificates & secrets\f[R], click +\f[C]New client secret\f[R]. Copy and keep that secret for later use. .IP "4." 3 -Under \f[C]manage\f[] select \f[C]API\ permissions\f[], click -\f[C]Add\ a\ permission\f[] and select \f[C]Microsoft\ Graph\f[] then -select \f[C]delegated\ permissions\f[]. +Under \f[C]manage\f[R] select \f[C]API permissions\f[R], click +\f[C]Add a permission\f[R] and select \f[C]Microsoft Graph\f[R] then +select \f[C]delegated permissions\f[R]. .IP "5." 3 -Search and select the follwing permssions: \f[C]Files.Read\f[], -\f[C]Files.ReadWrite\f[], \f[C]Files.Read.All\f[], -\f[C]Files.ReadWrite.All\f[], \f[C]offline_access\f[], -\f[C]User.Read\f[]. -Once selected click \f[C]Add\ permissions\f[] at the bottom. +Search and select the follwing permssions: \f[C]Files.Read\f[R], +\f[C]Files.ReadWrite\f[R], \f[C]Files.Read.All\f[R], +\f[C]Files.ReadWrite.All\f[R], \f[C]offline_access\f[R], +\f[C]User.Read\f[R]. +Once selected click \f[C]Add permissions\f[R] at the bottom. .PP Now the application is complete. -Run \f[C]rclone\ config\f[] to create or edit a OneDrive remote. +Run \f[C]rclone config\f[R] to create or edit a OneDrive remote. Supply the app ID and password as Client ID and Secret, respectively. rclone will walk you through the remaining steps. .SS Modification time and hashes @@ -18850,7 +24204,7 @@ OneDrive personal supports SHA1 type hashes. OneDrive for business and Sharepoint Server support QuickXorHash (https://docs.microsoft.com/en-us/onedrive/developer/code-snippets/quickxorhash). .PP -For all types of OneDrive you can use the \f[C]\-\-checksum\f[] flag. +For all types of OneDrive you can use the \f[C]\-\-checksum\f[R] flag. .SS Restricted filename characters .PP In addition to the default restricted characters @@ -18869,74 +24223,74 @@ Replacement T} _ T{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} T{ * T}@T{ 0x2A T}@T{ -＊ +\[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ -： +\[uFF1A] 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{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ -｜ +\[uFF5C] T} T{ # T}@T{ 0x23 T}@T{ -＃ +\[uFF03] T} T{ % T}@T{ 0x25 T}@T{ -％ +\[uFF05] T} .TE .PP @@ -18959,14 +24313,14 @@ SP T}@T{ 0x20 T}@T{ -␠ +\[u2420] T} T{ \&. T}@T{ 0x2E T}@T{ -． +\[uFF0E] T} .TE .PP @@ -18989,24 +24343,24 @@ SP T}@T{ 0x20 T}@T{ -␠ +\[u2420] T} T{ -~ +\[ti] T}@T{ 0x7E T}@T{ -～ +\[uFF5E] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Deleting files .PP 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 +Microsoft doesn\[cq]t provide an API to permanently delete files, nor to +empty the trash, so you will have to do that with one of Microsoft\[cq]s apps or via the OneDrive website. .SS Standard Options .PP @@ -19021,7 +24375,7 @@ Env Var: RCLONE_ONEDRIVE_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]onedrive\-client\-secret .PP Microsoft App Client Secret Leave blank normally. @@ -19032,7 +24386,7 @@ Env Var: RCLONE_ONEDRIVE_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to onedrive (Microsoft OneDrive). @@ -19062,7 +24416,7 @@ Env Var: RCLONE_ONEDRIVE_DRIVE_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]onedrive\-drive\-type .PP The type of the drive ( personal | business | documentLibrary ) @@ -19073,13 +24427,14 @@ Env Var: RCLONE_ONEDRIVE_DRIVE_TYPE .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]onedrive\-expose\-onenote\-files .PP Set to make OneNote files show up in directory listings. .PP By default rclone will hide OneNote files in directory listings because -operations like \[lq]Open\[rq] and \[lq]Update\[rq] won't work on them. +operations like \[lq]Open\[rq] and \[lq]Update\[rq] won\[cq]t work on +them. But this behaviour may also prevent you from deleting them. If you want to delete OneNote files or otherwise want them to show up in directory listing, set this option. @@ -19091,19 +24446,35 @@ Env Var: RCLONE_ONEDRIVE_EXPOSE_ONENOTE_FILES Type: bool .IP \[bu] 2 Default: false +.SS \[en]onedrive\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_ONEDRIVE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot .SS Limitations .SS Naming .PP -Note that OneDrive is case insensitive so you can't have a file called -\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +Note that OneDrive is case insensitive so you can\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .PP -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. +There are quite a few characters that can\[cq]t be in OneDrive file +names. +These can\[cq]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 \f[C]?\f[] in it will be mapped to -\f[C]？\f[] instead. +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 sizes are 15GB for OneDrive for Business and @@ -19119,7 +24490,7 @@ typically longer than the original ones. .PP OneDrive seems to be OK with at least 50,000 files in a folder, but at 100,000 rclone will get errors listing the directory like -\f[C]couldn't\ list\ files:\ UnknownError:\f[]. +\f[C]couldn\[cq]t list files: UnknownError:\f[R]. See #2707 (https://github.com/rclone/rclone/issues/2707) for more info. .PP An official document about the limitations for different types of @@ -19132,11 +24503,11 @@ This counts against a users quota. For example changing the modification time of a file creates a second version, so the file is using twice the space. .PP -The \f[C]copy\f[] is the only rclone command affected by this as we copy -the file and then afterwards set the modification time to match the +The \f[C]copy\f[R] is the only rclone command affected by this as we +copy the file and then afterwards set the modification time to match the source file. .PP -\f[B]Note\f[]: Starting October 2018, users will no longer be able to +\f[B]Note\f[R]: Starting October 2018, users will no longer be able to disable versioning by default. This is because Microsoft has brought an update (https://techcommunity.microsoft.com/t5/Microsoft-OneDrive-Blog/New-Updates-to-OneDrive-and-SharePoint-Team-Site-Versioning/ba-p/204390) @@ -19146,22 +24517,22 @@ be run by a SharePoint admin. If you are an admin, you can run these commands in PowerShell to change that setting: .IP "1." 3 -\f[C]Install\-Module\ \-Name\ Microsoft.Online.SharePoint.PowerShell\f[] -(in case you haven't installed this already) +\f[C]Install\-Module \-Name Microsoft.Online.SharePoint.PowerShell\f[R] +(in case you haven\[cq]t installed this already) .IP "2." 3 -\f[C]Import\-Module\ Microsoft.Online.SharePoint.PowerShell\ \-DisableNameChecking\f[] +\f[C]Import\-Module Microsoft.Online.SharePoint.PowerShell \-DisableNameChecking\f[R] .IP "3." 3 -\f[C]Connect\-SPOService\ \-Url\ https://YOURSITE\-admin.sharepoint.com\ \-Credential\ YOU\@YOURSITE.COM\f[] -(replacing \f[C]YOURSITE\f[], \f[C]YOU\f[], \f[C]YOURSITE.COM\f[] with -the actual values; this will prompt for your credentials) +\f[C]Connect\-SPOService \-Url https://YOURSITE\-admin.sharepoint.com \-Credential YOU\[at]YOURSITE.COM\f[R] +(replacing \f[C]YOURSITE\f[R], \f[C]YOU\f[R], \f[C]YOURSITE.COM\f[R] +with the actual values; this will prompt for your credentials) .IP "4." 3 -\f[C]Set\-SPOTenant\ \-EnableMinimumVersionRequirement\ $False\f[] +\f[C]Set\-SPOTenant \-EnableMinimumVersionRequirement $False\f[R] .IP "5." 3 -\f[C]Disconnect\-SPOService\f[] (to disconnect from the server) +\f[C]Disconnect\-SPOService\f[R] (to disconnect from the server) .PP \f[I]Below are the steps for normal users to disable versioning. If you -don't see the \[lq]No Versioning\[rq] option, make sure the above -requirements are met.\f[] +don\[cq]t see the \[lq]No Versioning\[rq] option, make sure the above +requirements are met.\f[R] .PP User Weropol (https://github.com/Weropol) has found a method to disable versioning on OneDrive @@ -19203,11 +24574,10 @@ these checks with the following command line arguments: .IP .nf \f[C] -\-\-ignore\-checksum\ \-\-ignore\-size -\f[] +\-\-ignore\-checksum \-\-ignore\-size +\f[R] .fi -.SS Replacing/deleting existing files on Sharepoint gets \[lq]item not -found\[rq] +.SS Replacing/deleting existing files on Sharepoint gets \[lq]item not found\[rq] .PP It is a known (https://github.com/OneDrive/onedrive-api-docs/issues/1068) issue @@ -19215,32 +24585,32 @@ that Sharepoint (not OneDrive or OneDrive for Business) may return \[lq]item not found\[rq] errors when users try to replace or delete uploaded files; this seems to mainly affect Office files (.docx, .xlsx, etc.). -As a workaround, you may use the \f[C]\-\-backup\-dir\ \f[] +As a workaround, you may use the \f[C]\-\-backup\-dir \f[R] command line argument so rclone moves the files to be replaced/deleted into a given backup directory (instead of directly replacing/deleting them). For example, to instruct rclone to move the files into the directory -\f[C]rclone\-backup\-dir\f[] on backend \f[C]mysharepoint\f[], you may +\f[C]rclone\-backup\-dir\f[R] on backend \f[C]mysharepoint\f[R], you may use: .IP .nf \f[C] -\-\-backup\-dir\ mysharepoint:rclone\-backup\-dir -\f[] +\-\-backup\-dir mysharepoint:rclone\-backup\-dir +\f[R] .fi .SS access_denied (AADSTS65005) .IP .nf \f[C] -Error:\ access_denied -Code:\ AADSTS65005 -Description:\ Using\ application\ \[aq]rclone\[aq]\ is\ currently\ not\ supported\ for\ your\ organization\ [YOUR_ORGANIZATION]\ because\ it\ is\ in\ an\ unmanaged\ state.\ An\ administrator\ needs\ to\ claim\ ownership\ of\ the\ company\ by\ DNS\ validation\ of\ [YOUR_ORGANIZATION]\ before\ the\ application\ rclone\ can\ be\ provisioned. -\f[] +Error: access_denied +Code: AADSTS65005 +Description: Using application \[aq]rclone\[aq] is currently not supported for your organization [YOUR_ORGANIZATION] because it is in an unmanaged state. An administrator needs to claim ownership of the company by DNS validation of [YOUR_ORGANIZATION] before the application rclone can be provisioned. +\f[R] .fi .PP -This means that rclone can't use the OneDrive for Business API with your -account. -You can't do much about it, maybe write an email to your admins. +This means that rclone can\[cq]t use the OneDrive for Business API with +your account. +You can\[cq]t do much about it, maybe write an email to your admins. .PP However, there are other ways to interact with your OneDrive account. Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint @@ -19248,97 +24618,97 @@ Have a look at the webdav backend: https://rclone.org/webdav/#sharepoint .IP .nf \f[C] -Error:\ invalid_grant -Code:\ AADSTS50076 -Description:\ Due\ to\ a\ configuration\ change\ made\ by\ your\ administrator,\ or\ because\ you\ moved\ to\ a\ new\ location,\ you\ must\ use\ multi\-factor\ authentication\ to\ access\ \[aq]...\[aq]. -\f[] +Error: invalid_grant +Code: AADSTS50076 +Description: Due to a configuration change made by your administrator, or because you moved to a new location, you must use multi\-factor authentication to access \[aq]...\[aq]. +\f[R] .fi .PP 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 \f[C]rclone\ config\f[], and choose to edit your +To do that, run \f[C]rclone config\f[R], and choose to edit your OneDrive backend. -Then, you don't need to actually make any changes until you reach this -question: \f[C]Already\ have\ a\ token\ \-\ refresh?\f[]. -For this question, answer \f[C]y\f[] and go through the process to +Then, you don\[cq]t need to actually make any changes until you reach +this question: \f[C]Already have a token \- refresh?\f[R]. +For this question, answer \f[C]y\f[R] 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. .SS OpenDrive .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP -Here is an example of how to make a remote called \f[C]remote\f[]. +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[] + 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 +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\ /\ OpenDrive -\ \ \ \\\ "opendrive" +XX / OpenDrive + \[rs] \[dq]opendrive\[dq] [snip] -Storage>\ opendrive +Storage> opendrive Username username> Password -y)\ Yes\ type\ in\ my\ own\ password -g)\ Generate\ random\ password -y/g>\ y -Enter\ the\ password: +y) Yes type in my own password +g) Generate random password +y/g> y +Enter the password: password: -Confirm\ the\ password: +Confirm the password: password: \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -username\ = -password\ =\ ***\ ENCRYPTED\ *** +username = +password = *** ENCRYPTED *** \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] .fi .PP List directories in top level of your OpenDrive .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your OpenDrive .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an OpenDrive directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Modified time and MD5SUMs .PP @@ -19363,70 +24733,70 @@ NUL T}@T{ 0x00 T}@T{ -␀ +\[u2400] T} T{ / T}@T{ 0x2F T}@T{ -／ +\[uFF0F] T} T{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} T{ * T}@T{ 0x2A T}@T{ -＊ +\[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ -： +\[uFF1A] 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{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ -｜ +\[uFF5C] T} .TE .PP @@ -19450,40 +24820,40 @@ SP T}@T{ 0x20 T}@T{ -␠ +\[u2420] 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{ CR T}@T{ 0x0D T}@T{ -␍ +\[u240D] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to opendrive (OpenDrive). @@ -19497,7 +24867,7 @@ Env Var: RCLONE_OPENDRIVE_USERNAME .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]opendrive\-password .PP Password. @@ -19508,174 +24878,207 @@ Env Var: RCLONE_OPENDRIVE_PASSWORD .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to opendrive (OpenDrive). +.SS \[en]opendrive\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_OPENDRIVE_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: +Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot +.SS \[en]opendrive\-chunk\-size +.PP +Files will be uploaded in chunks this size. +.PP +Note that these chunks are buffered in memory so increasing them will +increase memory use. +.IP \[bu] 2 +Config: chunk_size +.IP \[bu] 2 +Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE +.IP \[bu] 2 +Type: SizeSuffix +.IP \[bu] 2 +Default: 10M .SS Limitations .PP -Note that OpenDrive is case insensitive so you can't have a file called -\[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. +Note that OpenDrive is case insensitive so you can\[cq]t have a file +called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .PP -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. +There are quite a few characters that can\[cq]t be in OpenDrive file +names. +These can\[cq]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 \f[C]?\f[] in it will be mapped to -\f[C]？\f[] instead. +For example if a file has a \f[C]?\f[R] in it will be mapped to +\f[C]\[uFF1F]\f[R] instead. .SS QingStor .PP -Paths are specified as \f[C]remote:bucket\f[] (or \f[C]remote:\f[] for -the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:bucket/path/to/dir\f[]. +Paths are specified as \f[C]remote:bucket\f[R] (or \f[C]remote:\f[R] for +the \f[C]lsd\f[R] command.) You may put subdirectories in too, eg +\f[C]remote:bucket/path/to/dir\f[R]. .PP Here is an example of making an QingStor configuration. First run .IP .nf \f[C] -rclone\ config -\f[] +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 +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\ /\ QingStor\ Object\ Storage -\ \ \ \\\ "qingstor" +XX / QingStor Object Storage + \[rs] \[dq]qingstor\[dq] [snip] -Storage>\ qingstor -Get\ QingStor\ credentials\ from\ runtime.\ 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\ QingStor\ credentials\ in\ the\ next\ step -\ \ \ \\\ "false" -\ 2\ /\ Get\ QingStor\ credentials\ from\ the\ environment\ (env\ vars\ or\ IAM) -\ \ \ \\\ "true" -env_auth>\ 1 -QingStor\ Access\ Key\ ID\ \-\ leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. -access_key_id>\ access_key -QingStor\ Secret\ Access\ Key\ (password)\ \-\ leave\ blank\ for\ anonymous\ access\ or\ runtime\ credentials. -secret_access_key>\ secret_key -Enter\ a\ endpoint\ URL\ to\ connection\ QingStor\ API. -Leave\ blank\ will\ use\ the\ default\ value\ "https://qingstor.com:443" +Storage> qingstor +Get QingStor credentials from runtime. 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 QingStor credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get QingStor credentials from the environment (env vars or IAM) + \[rs] \[dq]true\[dq] +env_auth> 1 +QingStor Access Key ID \- leave blank for anonymous access or runtime credentials. +access_key_id> access_key +QingStor Secret Access Key (password) \- leave blank for anonymous access or runtime credentials. +secret_access_key> secret_key +Enter a endpoint URL to connection QingStor API. +Leave blank will use the default value \[dq]https://qingstor.com:443\[dq] endpoint> -Zone\ connect\ to.\ Default\ is\ "pek3a". -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ \ \ /\ The\ Beijing\ (China)\ Three\ Zone -\ 1\ |\ Needs\ location\ constraint\ pek3a. -\ \ \ \\\ "pek3a" -\ \ \ /\ The\ Shanghai\ (China)\ First\ Zone -\ 2\ |\ Needs\ location\ constraint\ sh1a. -\ \ \ \\\ "sh1a" -zone>\ 1 -Number\ of\ connnection\ retry. -Leave\ blank\ will\ use\ the\ default\ value\ "3". +Zone connect to. Default is \[dq]pek3a\[dq]. +Choose a number from below, or type in your own value + / The Beijing (China) Three Zone + 1 | Needs location constraint pek3a. + \[rs] \[dq]pek3a\[dq] + / The Shanghai (China) First Zone + 2 | Needs location constraint sh1a. + \[rs] \[dq]sh1a\[dq] +zone> 1 +Number of connnection retry. +Leave blank will use the default value \[dq]3\[dq]. connection_retries> -Remote\ config +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -env_auth\ =\ false -access_key_id\ =\ access_key -secret_access_key\ =\ secret_key -endpoint\ = -zone\ =\ pek3a -connection_retries\ = +env_auth = false +access_key_id = access_key +secret_access_key = secret_key +endpoint = +zone = pek3a +connection_retries = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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[] and can now be used like this +This remote is called \f[C]remote\f[R] and can now be used like this .PP See all buckets .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP Make a new bucket .IP .nf \f[C] -rclone\ mkdir\ remote:bucket -\f[] +rclone mkdir remote:bucket +\f[R] .fi .PP List the contents of a bucket .IP .nf \f[C] -rclone\ ls\ remote:bucket -\f[] +rclone ls remote:bucket +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote bucket, deleting any +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\ /home/local/directory\ remote:bucket -\f[] +rclone sync /home/local/directory remote:bucket +\f[R] .fi .SS \[en]fast\-list .PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use +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 (/docs/#fast-list) for more details. .SS Multipart uploads .PP 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 files uploaded with multipart upload don\[cq]t have an MD5SUM. .SS Buckets and Zone .PP -With QingStor you can list buckets (\f[C]rclone\ lsd\f[]) using any +With QingStor you can list buckets (\f[C]rclone lsd\f[R]) 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, -\f[C]incorrect\ zone,\ the\ bucket\ is\ not\ in\ \[aq]XXX\[aq]\ zone\f[]. +\f[C]incorrect zone, the bucket is not in \[aq]XXX\[aq] zone\f[R]. .SS Authentication .PP -There are two ways to supply \f[C]rclone\f[] with a set of QingStor +There are two ways to supply \f[C]rclone\f[R] with a set of QingStor credentials. In order of precedence: .IP \[bu] 2 Directly in the rclone configuration file (as configured by -\f[C]rclone\ config\f[]) +\f[C]rclone config\f[R]) .RS 2 .IP \[bu] 2 -set \f[C]access_key_id\f[] and \f[C]secret_access_key\f[] +set \f[C]access_key_id\f[R] and \f[C]secret_access_key\f[R] .RE .IP \[bu] 2 Runtime configuration: .RS 2 .IP \[bu] 2 -set \f[C]env_auth\f[] to \f[C]true\f[] in the config file +set \f[C]env_auth\f[R] to \f[C]true\f[R] in the config file .IP \[bu] 2 Exporting the following environment variables before running -\f[C]rclone\f[] +\f[C]rclone\f[R] .RS 2 .IP \[bu] 2 -Access Key ID: \f[C]QS_ACCESS_KEY_ID\f[] or \f[C]QS_ACCESS_KEY\f[] +Access Key ID: \f[C]QS_ACCESS_KEY_ID\f[R] or \f[C]QS_ACCESS_KEY\f[R] .IP \[bu] 2 -Secret Access Key: \f[C]QS_SECRET_ACCESS_KEY\f[] or -\f[C]QS_SECRET_KEY\f[] +Secret Access Key: \f[C]QS_SECRET_ACCESS_KEY\f[R] or +\f[C]QS_SECRET_KEY\f[R] .RE .RE .SS Restricted filename characters @@ -19685,7 +25088,7 @@ restricted characters set (/overview/#restricted-characters). Note that 0x7F is not replaced. .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to qingstor (QingCloud Object @@ -19729,7 +25132,7 @@ Env Var: RCLONE_QINGSTOR_ACCESS_KEY_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]qingstor\-secret\-access\-key .PP QingStor Secret Access Key (password) Leave blank for anonymous access @@ -19741,7 +25144,7 @@ Env Var: RCLONE_QINGSTOR_SECRET_ACCESS_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]qingstor\-endpoint .PP Enter a endpoint URL to connection QingStor API. @@ -19754,7 +25157,7 @@ Env Var: RCLONE_QINGSTOR_ENDPOINT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]qingstor\-zone .PP Zone to connect to. @@ -19766,7 +25169,7 @@ Env Var: RCLONE_QINGSTOR_ZONE .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -19865,6 +25268,20 @@ Env Var: RCLONE_QINGSTOR_UPLOAD_CONCURRENCY Type: int .IP \[bu] 2 Default: 1 +.SS \[en]qingstor\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_QINGSTOR_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Ctl,InvalidUtf8 .SS Swift .PP Swift refers to Openstack Object @@ -19883,147 +25300,147 @@ Oracle Cloud Storage (https://cloud.oracle.com/storage-opc) 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[] (or \f[C]remote:\f[] -for the \f[C]lsd\f[] command.) You may put subdirectories in too, eg -\f[C]remote:container/path/to/dir\f[]. +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 +\f[C]remote:container/path/to/dir\f[R]. .PP Here is an example of making a swift configuration. First run .IP .nf \f[C] -rclone\ config -\f[] +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 +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\ /\ Openstack\ Swift\ (Rackspace\ Cloud\ Files,\ Memset\ Memstore,\ OVH) -\ \ \ \\\ "swift" +XX / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \[rs] \[dq]swift\[dq] [snip] -Storage>\ swift -Get\ swift\ credentials\ from\ environment\ variables\ in\ standard\ OpenStack\ form. -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Enter\ swift\ credentials\ in\ the\ next\ step -\ \ \ \\\ "false" -\ 2\ /\ Get\ swift\ credentials\ from\ environment\ vars.\ Leave\ other\ fields\ blank\ if\ using\ this. -\ \ \ \\\ "true" -env_auth>\ true -User\ name\ to\ log\ in\ (OS_USERNAME). -user>\ -API\ key\ or\ password\ (OS_PASSWORD). -key>\ -Authentication\ URL\ for\ server\ (OS_AUTH_URL). -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Rackspace\ US -\ \ \ \\\ "https://auth.api.rackspacecloud.com/v1.0" -\ 2\ /\ Rackspace\ UK -\ \ \ \\\ "https://lon.auth.api.rackspacecloud.com/v1.0" -\ 3\ /\ Rackspace\ v2 -\ \ \ \\\ "https://identity.api.rackspacecloud.com/v2.0" -\ 4\ /\ Memset\ Memstore\ UK -\ \ \ \\\ "https://auth.storage.memset.com/v1.0" -\ 5\ /\ Memset\ Memstore\ UK\ v2 -\ \ \ \\\ "https://auth.storage.memset.com/v2.0" -\ 6\ /\ OVH -\ \ \ \\\ "https://auth.cloud.ovh.net/v2.0" -auth>\ -User\ ID\ to\ log\ in\ \-\ optional\ \-\ most\ swift\ systems\ use\ user\ and\ leave\ this\ blank\ (v3\ auth)\ (OS_USER_ID). -user_id>\ -User\ domain\ \-\ optional\ (v3\ auth)\ (OS_USER_DOMAIN_NAME) -domain>\ -Tenant\ name\ \-\ optional\ for\ v1\ auth,\ this\ or\ tenant_id\ required\ otherwise\ (OS_TENANT_NAME\ or\ OS_PROJECT_NAME) -tenant>\ -Tenant\ ID\ \-\ optional\ for\ v1\ auth,\ this\ or\ tenant\ required\ otherwise\ (OS_TENANT_ID) -tenant_id>\ -Tenant\ domain\ \-\ optional\ (v3\ auth)\ (OS_PROJECT_DOMAIN_NAME) -tenant_domain>\ -Region\ name\ \-\ optional\ (OS_REGION_NAME) -region>\ -Storage\ URL\ \-\ optional\ (OS_STORAGE_URL) -storage_url>\ -Auth\ Token\ from\ alternate\ authentication\ \-\ optional\ (OS_AUTH_TOKEN) -auth_token>\ -AuthVersion\ \-\ optional\ \-\ set\ to\ (1,2,3)\ if\ your\ auth\ URL\ has\ no\ version\ (ST_AUTH_VERSION) -auth_version>\ -Endpoint\ type\ to\ choose\ from\ the\ service\ catalogue\ (OS_ENDPOINT_TYPE) -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Public\ (default,\ choose\ this\ if\ not\ sure) -\ \ \ \\\ "public" -\ 2\ /\ Internal\ (use\ internal\ service\ net) -\ \ \ \\\ "internal" -\ 3\ /\ Admin -\ \ \ \\\ "admin" -endpoint_type>\ -Remote\ config +Storage> swift +Get swift credentials from environment variables in standard OpenStack form. +Choose a number from below, or type in your own value + 1 / Enter swift credentials in the next step + \[rs] \[dq]false\[dq] + 2 / Get swift credentials from environment vars. Leave other fields blank if using this. + \[rs] \[dq]true\[dq] +env_auth> true +User name to log in (OS_USERNAME). +user> +API key or password (OS_PASSWORD). +key> +Authentication URL for server (OS_AUTH_URL). +Choose a number from below, or type in your own value + 1 / Rackspace US + \[rs] \[dq]https://auth.api.rackspacecloud.com/v1.0\[dq] + 2 / Rackspace UK + \[rs] \[dq]https://lon.auth.api.rackspacecloud.com/v1.0\[dq] + 3 / Rackspace v2 + \[rs] \[dq]https://identity.api.rackspacecloud.com/v2.0\[dq] + 4 / Memset Memstore UK + \[rs] \[dq]https://auth.storage.memset.com/v1.0\[dq] + 5 / Memset Memstore UK v2 + \[rs] \[dq]https://auth.storage.memset.com/v2.0\[dq] + 6 / OVH + \[rs] \[dq]https://auth.cloud.ovh.net/v3\[dq] +auth> +User ID to log in \- optional \- most swift systems use user and leave this blank (v3 auth) (OS_USER_ID). +user_id> +User domain \- optional (v3 auth) (OS_USER_DOMAIN_NAME) +domain> +Tenant name \- optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME) +tenant> +Tenant ID \- optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID) +tenant_id> +Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) +tenant_domain> +Region name \- optional (OS_REGION_NAME) +region> +Storage URL \- optional (OS_STORAGE_URL) +storage_url> +Auth Token from alternate authentication \- optional (OS_AUTH_TOKEN) +auth_token> +AuthVersion \- optional \- set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION) +auth_version> +Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE) +Choose a number from below, or type in your own value + 1 / Public (default, choose this if not sure) + \[rs] \[dq]public\[dq] + 2 / Internal (use internal service net) + \[rs] \[dq]internal\[dq] + 3 / Admin + \[rs] \[dq]admin\[dq] +endpoint_type> +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [test] -env_auth\ =\ true -user\ =\ -key\ =\ -auth\ =\ -user_id\ =\ -domain\ =\ -tenant\ =\ -tenant_id\ =\ -tenant_domain\ =\ -region\ =\ -storage_url\ =\ -auth_token\ =\ -auth_version\ =\ -endpoint_type\ =\ +env_auth = true +user = +key = +auth = +user_id = +domain = +tenant = +tenant_id = +tenant_domain = +region = +storage_url = +auth_token = +auth_version = +endpoint_type = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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[] and can now be used like this +This remote is called \f[C]remote\f[R] and can now be used like this .PP See all containers .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP Make a new container .IP .nf \f[C] -rclone\ mkdir\ remote:container -\f[] +rclone mkdir remote:container +\f[R] .fi .PP List the contents of a container .IP .nf \f[C] -rclone\ ls\ remote:container -\f[] +rclone ls remote:container +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote container, deleting +Sync \f[C]/home/local/directory\f[R] to the remote container, deleting any excess files in the container. .IP .nf \f[C] -rclone\ sync\ /home/local/directory\ remote:container -\f[] +rclone sync /home/local/directory remote:container +\f[R] .fi .SS Configuration from an OpenStack credentials file .PP @@ -20032,42 +25449,42 @@ this (without the comments) .IP .nf \f[C] -export\ OS_AUTH_URL=https://a.provider.net/v2.0 -export\ OS_TENANT_ID=ffffffffffffffffffffffffffffffff -export\ OS_TENANT_NAME="1234567890123456" -export\ OS_USERNAME="123abc567xy" -echo\ "Please\ enter\ your\ OpenStack\ Password:\ " -read\ \-sr\ OS_PASSWORD_INPUT -export\ OS_PASSWORD=$OS_PASSWORD_INPUT -export\ OS_REGION_NAME="SBG1" -if\ [\ \-z\ "$OS_REGION_NAME"\ ];\ then\ unset\ OS_REGION_NAME;\ fi -\f[] +export OS_AUTH_URL=https://a.provider.net/v2.0 +export OS_TENANT_ID=ffffffffffffffffffffffffffffffff +export OS_TENANT_NAME=\[dq]1234567890123456\[dq] +export OS_USERNAME=\[dq]123abc567xy\[dq] +echo \[dq]Please enter your OpenStack Password: \[dq] +read \-sr OS_PASSWORD_INPUT +export OS_PASSWORD=$OS_PASSWORD_INPUT +export OS_REGION_NAME=\[dq]SBG1\[dq] +if [ \-z \[dq]$OS_REGION_NAME\[dq] ]; then unset OS_REGION_NAME; fi +\f[R] .fi .PP The config file needs to look something like this where -\f[C]$OS_USERNAME\f[] represents the value of the \f[C]OS_USERNAME\f[] -variable \- \f[C]123abc567xy\f[] in the example above. +\f[C]$OS_USERNAME\f[R] represents the value of the \f[C]OS_USERNAME\f[R] +variable \- \f[C]123abc567xy\f[R] in the example above. .IP .nf \f[C] [remote] -type\ =\ swift -user\ =\ $OS_USERNAME -key\ =\ $OS_PASSWORD -auth\ =\ $OS_AUTH_URL -tenant\ =\ $OS_TENANT_NAME -\f[] +type = swift +user = $OS_USERNAME +key = $OS_PASSWORD +auth = $OS_AUTH_URL +tenant = $OS_TENANT_NAME +\f[R] .fi .PP -Note that you may (or may not) need to set \f[C]region\f[] too \- try +Note that you may (or may not) need to set \f[C]region\f[R] too \- try without first. .SS Configuration from the environment .PP If you prefer you can configure rclone to use swift using a standard set of OpenStack environment variables. .PP -When you run through the config, make sure you choose \f[C]true\f[] for -\f[C]env_auth\f[] and leave everything else blank. +When you run through the config, make sure you choose \f[C]true\f[R] for +\f[C]env_auth\f[R] and leave everything else blank. .PP rclone will then set any empty config parameters from the environment using standard OpenStack environment variables. @@ -20079,9 +25496,9 @@ in the docs for the swift library. If your OpenStack installation uses a non\-standard authentication method that might not be yet supported by rclone or the underlying swift library, you can authenticate externally (e.g.\ calling manually the -\f[C]openstack\f[] commands to get a token). +\f[C]openstack\f[R] commands to get a token). Then, you just need to pass the two configuration variables -\f[C]auth_token\f[] and \f[C]storage_url\f[]. +\f[C]auth_token\f[R] and \f[C]storage_url\f[R]. If they are both provided, the other variables are ignored. rclone will not try to authenticate but instead assume it is already authenticated and use these two variables to access the OpenStack @@ -20093,15 +25510,15 @@ this: .IP .nf \f[C] -source\ openstack\-credentials\-file -export\ RCLONE_CONFIG_MYREMOTE_TYPE=swift -export\ RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true -rclone\ lsd\ myremote: -\f[] +source openstack\-credentials\-file +export RCLONE_CONFIG_MYREMOTE_TYPE=swift +export RCLONE_CONFIG_MYREMOTE_ENV_AUTH=true +rclone lsd myremote: +\f[R] .fi .SS \[en]fast\-list .PP -This remote supports \f[C]\-\-fast\-list\f[] which allows you to use +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 (/docs/#fast-list) for more details. .SS \[en]update and \[en]use\-server\-modtime @@ -20115,8 +25532,8 @@ metadata. .PP For many operations, the time the object was last uploaded to the remote is sufficient to determine if it is \[lq]dirty\[rq]. -By using \f[C]\-\-update\f[] along with -\f[C]\-\-use\-server\-modtime\f[], you can avoid the extra API call and +By using \f[C]\-\-update\f[R] along with +\f[C]\-\-use\-server\-modtime\f[R], you can avoid the extra API call and simply upload files whose local modtime is newer than the time it was last uploaded. .SS Standard Options @@ -20162,7 +25579,7 @@ Env Var: RCLONE_SWIFT_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-key .PP API key or password (OS_PASSWORD). @@ -20173,7 +25590,7 @@ Env Var: RCLONE_SWIFT_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-auth .PP Authentication URL for server (OS_AUTH_URL). @@ -20184,7 +25601,7 @@ Env Var: RCLONE_SWIFT_AUTH .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -20219,7 +25636,7 @@ Memset Memstore UK Memset Memstore UK v2 .RE .IP \[bu] 2 -\[lq]https://auth.cloud.ovh.net/v2.0\[rq] +\[lq]https://auth.cloud.ovh.net/v3\[rq] .RS 2 .IP \[bu] 2 OVH @@ -20236,7 +25653,7 @@ Env Var: RCLONE_SWIFT_USER_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-domain .PP User domain \- optional (v3 auth) (OS_USER_DOMAIN_NAME) @@ -20247,7 +25664,7 @@ Env Var: RCLONE_SWIFT_DOMAIN .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-tenant .PP Tenant name \- optional for v1 auth, this or tenant_id required @@ -20259,7 +25676,7 @@ Env Var: RCLONE_SWIFT_TENANT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-tenant\-id .PP Tenant ID \- optional for v1 auth, this or tenant required otherwise @@ -20271,7 +25688,7 @@ Env Var: RCLONE_SWIFT_TENANT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-tenant\-domain .PP Tenant domain \- optional (v3 auth) (OS_PROJECT_DOMAIN_NAME) @@ -20282,7 +25699,7 @@ Env Var: RCLONE_SWIFT_TENANT_DOMAIN .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-region .PP Region name \- optional (OS_REGION_NAME) @@ -20293,7 +25710,7 @@ Env Var: RCLONE_SWIFT_REGION .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-storage\-url .PP Storage URL \- optional (OS_STORAGE_URL) @@ -20304,7 +25721,7 @@ Env Var: RCLONE_SWIFT_STORAGE_URL .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-auth\-token .PP Auth Token from alternate authentication \- optional (OS_AUTH_TOKEN) @@ -20315,7 +25732,7 @@ Env Var: RCLONE_SWIFT_AUTH_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-application\-credential\-id .PP Application Credential ID (OS_APPLICATION_CREDENTIAL_ID) @@ -20326,7 +25743,7 @@ Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-application\-credential\-name .PP Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME) @@ -20337,7 +25754,7 @@ Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_NAME .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-application\-credential\-secret .PP Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET) @@ -20348,7 +25765,7 @@ Env Var: RCLONE_SWIFT_APPLICATION_CREDENTIAL_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]swift\-auth\-version .PP AuthVersion \- optional \- set to (1,2,3) if your auth URL has no @@ -20409,12 +25826,12 @@ Env Var: RCLONE_SWIFT_STORAGE_POLICY .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 .IP \[bu] 2 -"" +\[dq]\[dq] .RS 2 .IP \[bu] 2 Default @@ -20452,7 +25869,7 @@ Type: SizeSuffix Default: 5G .SS \[en]swift\-no\-chunk .PP -Don't chunk files during streaming upload. +Don\[cq]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. @@ -20470,10 +25887,24 @@ Env Var: RCLONE_SWIFT_NO_CHUNK Type: bool .IP \[bu] 2 Default: false +.SS \[en]swift\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_SWIFT_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,InvalidUtf8 .SS Modified time .PP The modified time is stored as metadata on the object as -\f[C]X\-Object\-Meta\-Mtime\f[] as floating point since the epoch +\f[C]X\-Object\-Meta\-Mtime\f[R] as floating point since the epoch accurate to 1 ns. .PP This is a defacto standard (used in the official python\-swiftclient @@ -20496,105 +25927,103 @@ 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 (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Limitations .PP -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 +The Swift API doesn\[cq]t return a correct MD5SUM for segmented files +(Dynamic or Static Large Objects) so rclone won\[cq]t check or use the MD5SUM for these. .SS Troubleshooting -.SS Rclone gives Failed to create file system for \[lq]remote:\[rq]: Bad -Request +.SS Rclone gives Failed to create file system for \[lq]remote:\[rq]: Bad Request .PP Due to an oddity of the underlying swift library, it gives a \[lq]Bad Request\[rq] error rather than a more sensible error when the authentication fails for Swift. .PP So this most likely means your username / password is wrong. -You can investigate further with the \f[C]\-\-dump\-bodies\f[] flag. +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't have -(eg OVH). -.SS Rclone gives Failed to create file system: Response didn't have -storage storage url and auth token +This may also be caused by specifying the region when you shouldn\[cq]t +have (eg OVH). +.SS Rclone gives Failed to create file system: Response didn\[cq]t have storage storage url and auth token .PP This is most likely caused by forgetting to specify your tenant when setting up a swift remote. .SS pCloud .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for pCloud involves getting a token from pCloud which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. +\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[]. +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[] + 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 +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\ /\ Pcloud -\ \ \ \\\ "pcloud" +XX / Pcloud + \[rs] \[dq]pcloud\[dq] [snip] -Storage>\ pcloud -Pcloud\ App\ Client\ Id\ \-\ leave\ blank\ normally. -client_id>\ -Pcloud\ App\ Client\ Secret\ \-\ leave\ blank\ normally. -client_secret>\ -Remote\ config -Use\ auto\ config? -\ *\ Say\ Y\ if\ not\ sure -\ *\ Say\ N\ if\ you\ are\ working\ on\ a\ remote\ or\ headless\ machine -y)\ Yes -n)\ No -y/n>\ y -If\ your\ browser\ doesn\[aq]t\ open\ automatically\ go\ to\ the\ following\ link:\ http://127.0.0.1:53682/auth -Log\ in\ and\ authorize\ rclone\ for\ access -Waiting\ for\ code... -Got\ code +Storage> pcloud +Pcloud App Client Id \- leave blank normally. +client_id> +Pcloud App Client Secret \- leave blank normally. +client_secret> +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -client_id\ =\ -client_secret\ =\ -token\ =\ {"access_token":"XXX","token_type":"bearer","expiry":"0001\-01\-01T00:00:00Z"} +client_id = +client_secret = +token = {\[dq]access_token\[dq]:\[dq]XXX\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]expiry\[dq]:\[dq]0001\-01\-01T00:00:00Z\[dq]} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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 @@ -20604,33 +26033,33 @@ Note that rclone runs a webserver on your local machine to collect the token as returned from pCloud. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your pCloud .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your pCloud .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an pCloud directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Modified time and hashes .PP @@ -20641,7 +26070,7 @@ 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[] flag. +\f[C]\-\-checksum\f[R] flag. .SS Restricted filename characters .PP In addition to the default restricted characters @@ -20660,21 +26089,21 @@ Replacement T} _ T{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Deleting files .PP Deleted files will be moved to the trash. Your subscription level will determine how long items stay in the trash. -\f[C]rclone\ cleanup\f[] can be used to empty the trash. +\f[C]rclone cleanup\f[R] can be used to empty the trash. .SS Standard Options .PP Here are the standard options specific to pcloud (Pcloud). @@ -20688,7 +26117,7 @@ Env Var: RCLONE_PCLOUD_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]pcloud\-client\-secret .PP Pcloud App Client Secret Leave blank normally. @@ -20699,68 +26128,85 @@ Env Var: RCLONE_PCLOUD_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to pcloud (Pcloud). +.SS \[en]pcloud\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_PCLOUD_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS premiumize.me .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for premiumize.me (https://premiumize.me/) involves getting a token from premiumize.me which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. +\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[]. +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[] + 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\ (""). -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value +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\ /\ premiumize.me -\ \ \ \\\ "premiumizeme" +XX / premiumize.me + \[rs] \[dq]premiumizeme\[dq] [snip] -Storage>\ premiumizeme -**\ See\ help\ for\ premiumizeme\ backend\ at:\ https://rclone.org/premiumizeme/\ ** +Storage> premiumizeme +** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ ** -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 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] -type\ =\ premiumizeme -token\ =\ {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2029\-08\-07T18:44:15.548915378+01:00"} +type = premiumizeme +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]2029\-08\-07T18:44:15.548915378+01:00\[dq]} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ -\f[] +y) Yes this is OK +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 @@ -20770,39 +26216,39 @@ Note that rclone runs a webserver on your local machine to collect the token as returned from premiumize.me. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your premiumize.me .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your premiumize.me .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an premiumize.me directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Modified time and hashes .PP premiumize.me does not support modification times or hashes, therefore -syncing will default to \f[C]\-\-size\-only\f[] checking. -Note that using \f[C]\-\-update\f[] will work. +syncing will default to \f[C]\-\-size\-only\f[R] checking. +Note that using \f[C]\-\-update\f[R] will work. .SS Restricted filename characters .PP In addition to the default restricted characters @@ -20821,23 +26267,23 @@ Replacement T} _ T{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} T{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Standard Options .PP Here are the standard options specific to premiumizeme (premiumize.me). @@ -20853,100 +26299,117 @@ Env Var: RCLONE_PREMIUMIZEME_API_KEY .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS Advanced Options +.PP +Here are the advanced options specific to premiumizeme (premiumize.me). +.SS \[en]premiumizeme\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_PREMIUMIZEME_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS Limitations .PP -Note that premiumize.me is case insensitive so you can't have a file +Note that premiumize.me is case insensitive so you can\[cq]t have a file called \[lq]Hello.doc\[rq] and one called \[lq]hello.doc\[rq]. .PP -premiumize.me file names can't have the \f[C]\\\f[] or \f[C]"\f[] -characters in. +premiumize.me file names can\[cq]t have the \f[C]\[rs]\f[R] or +\f[C]\[dq]\f[R] characters in. rclone maps these to and from an identical looking unicode equivalents -\f[C]＼\f[] and \f[C]＂\f[] +\f[C]\[uFF3C]\f[R] and \f[C]\[uFF02]\f[R] .PP premiumize.me only supports filenames up to 255 characters in length. .SS put.io .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP put.io paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP The initial setup for put.io involves getting a token from put.io which you need to do in your browser. -\f[C]rclone\ config\f[] walks you through it. +\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[]. +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[] + 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>\ putio -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 +No remotes found \- make a new one +n) New remote +s) Set configuration password +q) Quit config +n/s/q> n +name> putio +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\ /\ Put.io -\ \ \ \\\ "putio" +XX / Put.io + \[rs] \[dq]putio\[dq] [snip] -Storage>\ putio -**\ See\ help\ for\ putio\ backend\ at:\ https://rclone.org/putio/\ ** +Storage> putio +** See help for putio backend at: https://rclone.org/putio/ ** -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 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 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [putio] -type\ =\ putio -token\ =\ {"access_token":"XXXXXXXX","expiry":"0001\-01\-01T00:00:00Z"} +type = putio +token = {\[dq]access_token\[dq]:\[dq]XXXXXXXX\[dq],\[dq]expiry\[dq]:\[dq]0001\-01\-01T00:00:00Z\[dq]} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -Current\ remotes: +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: -Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Type -====\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ==== -putio\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ putio +Name Type +==== ==== +putio putio -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[] +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 Note that rclone runs a webserver on your local machine to collect the token as returned from Google if you use auto config mode. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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 @@ -20956,24 +26419,24 @@ List directories in top level of your put.io .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your put.io .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to a put.io directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Restricted filename characters .PP @@ -20993,16 +26456,33 @@ Replacement T} _ T{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} .TE .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. +.SS Advanced Options +.PP +Here are the advanced options specific to putio (Put.io). +.SS \[en]putio\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_PUTIO_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot .SS SFTP .PP SFTP is the Secure (or SSH) File Transfer @@ -21017,13 +26497,13 @@ rsync.net SFTP runs over SSH v2 and is installed as standard with most modern SSH installations. .PP -Paths are specified as \f[C]remote:path\f[]. -If the path does not begin with a \f[C]/\f[] it is relative to the home +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[] refers to the user's home directory. +An empty path \f[C]remote:\f[R] refers to the user\[cq]s home directory. .PP -"Note that some SFTP servers will need the leading / \- Synology is a -good example of this. +\[dq]Note that some SFTP servers will need the leading / \- Synology is +a good example of this. rsync.net, on the other hand, requires users to OMIT the leading /. .PP Here is an example of making an SFTP configuration. @@ -21031,92 +26511,92 @@ First run .IP .nf \f[C] -rclone\ config -\f[] +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 +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\ /\ SSH/SFTP\ Connection -\ \ \ \\\ "sftp" +XX / SSH/SFTP Connection + \[rs] \[dq]sftp\[dq] [snip] -Storage>\ sftp -SSH\ host\ to\ connect\ to -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 -user>\ sftpuser -SSH\ port,\ leave\ blank\ to\ use\ default\ (22) +Storage> sftp +SSH host to connect to +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 +user> sftpuser +SSH port, leave blank to use default (22) port> -SSH\ password,\ leave\ blank\ to\ use\ ssh\-agent. -y)\ Yes\ type\ in\ my\ own\ password -g)\ Generate\ random\ password -n)\ No\ leave\ this\ optional\ password\ blank -y/g/n>\ n -Path\ to\ unencrypted\ PEM\-encoded\ private\ key\ file,\ leave\ blank\ to\ use\ ssh\-agent. +SSH password, leave blank to use ssh\-agent. +y) Yes type in my own password +g) Generate random password +n) No leave this optional password blank +y/g/n> n +Path to unencrypted PEM\-encoded private key file, leave blank to use ssh\-agent. key_file> -Remote\ config +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -host\ =\ example.com -user\ =\ sftpuser -port\ = -pass\ = -key_file\ = +host = example.com +user = sftpuser +port = +pass = +key_file = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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[] and can now be used like this: +This remote is called \f[C]remote\f[R] and can now be used like this: .PP See all directories in the home directory .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP Make a new directory .IP .nf \f[C] -rclone\ mkdir\ remote:path/to/directory -\f[] +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[] +rclone ls remote:path/to/directory +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote directory, deleting +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\ /home/local/directory\ remote:directory -\f[] +rclone sync /home/local/directory remote:directory +\f[R] .fi .SS SSH Authentication .PP @@ -21129,21 +26609,21 @@ Key file ssh\-agent .PP Key files should be PEM\-encoded private key files. -For instance \f[C]/home/$USER/.ssh/id_rsa\f[]. +For instance \f[C]/home/$USER/.ssh/id_rsa\f[R]. Only unencrypted OpenSSH or PEM encrypted files are supported. .PP -If you don't specify \f[C]pass\f[] or \f[C]key_file\f[] then rclone will -attempt to contact an ssh\-agent. +If you don\[cq]t specify \f[C]pass\f[R] or \f[C]key_file\f[R] then +rclone will attempt to contact an ssh\-agent. .PP -You can also specify \f[C]key_use_agent\f[] to force the usage of an +You can also specify \f[C]key_use_agent\f[R] to force the usage of an ssh\-agent. -In this case \f[C]key_file\f[] can also be specified to force the usage +In this case \f[C]key_file\f[R] can also be specified to force the usage of a specific key in the ssh\-agent. .PP Using an ssh\-agent is the only way to load encrypted OpenSSH keys at the moment. .PP -If you set the \f[C]\-\-sftp\-ask\-password\f[] option, rclone will +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. .SS ssh\-agent on macOS .PP @@ -21154,16 +26634,16 @@ each session, eg .IP .nf \f[C] -eval\ `ssh\-agent\ \-s`\ &&\ ssh\-add\ \-A -\f[] +eval \[ga]ssh\-agent \-s\[ga] && ssh\-add \-A +\f[R] .fi .PP And then at the end of the session .IP .nf \f[C] -eval\ `ssh\-agent\ \-k` -\f[] +eval \[ga]ssh\-agent \-k\[ga] +\f[R] .fi .PP These commands can be used in scripts of course. @@ -21177,7 +26657,7 @@ 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 -\f[C]set_modtime\ =\ false\f[] in your RClone backend configuration to +\f[C]set_modtime = false\f[R] in your RClone backend configuration to disable this behaviour. .SS Standard Options .PP @@ -21192,7 +26672,7 @@ Env Var: RCLONE_SFTP_HOST .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -21213,7 +26693,7 @@ Env Var: RCLONE_SFTP_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-port .PP SSH port, leave blank to use default (22) @@ -21224,7 +26704,7 @@ Env Var: RCLONE_SFTP_PORT .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-pass .PP SSH password, leave blank to use ssh\-agent. @@ -21235,7 +26715,7 @@ Env Var: RCLONE_SFTP_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-key\-file .PP Path to PEM\-encoded private key file, leave blank or set @@ -21247,13 +26727,13 @@ Env Var: RCLONE_SFTP_KEY_FILE .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-key\-file\-pass .PP The passphrase to decrypt the PEM\-encoded private key file. .PP Only PEM encrypted key files (old OpenSSH format) are supported. -Encrypted keys in the new OpenSSH format can't be used. +Encrypted keys in the new OpenSSH format can\[cq]t be used. .IP \[bu] 2 Config: key_file_pass .IP \[bu] 2 @@ -21261,7 +26741,7 @@ Env Var: RCLONE_SFTP_KEY_FILE_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-key\-use\-agent .PP When set forces the usage of the ssh\-agent. @@ -21270,8 +26750,8 @@ When key\-file is also set, the \[lq].pub\[rq] file of the specified key\-file is read and only the associated key is requested from the ssh\-agent. This allows to avoid -\f[C]Too\ many\ authentication\ failures\ for\ *username*\f[] errors -when the ssh\-agent contains many keys. +\f[C]Too many authentication failures for *username*\f[R] errors when +the ssh\-agent contains many keys. .IP \[bu] 2 Config: key_use_agent .IP \[bu] 2 @@ -21369,16 +26849,16 @@ Shared folders can be found in directories representing volumes .IP .nf \f[C] -rclone\ sync\ /home/local/directory\ remote:/directory\ \-\-ssh\-path\-override\ /volume2/directory -\f[] +rclone sync /home/local/directory remote:/directory \-\-ssh\-path\-override /volume2/directory +\f[R] .fi .PP Home directory can be found in a shared folder called \[lq]home\[rq] .IP .nf \f[C] -rclone\ sync\ /home/local/directory\ remote:/home/directory\ \-\-ssh\-path\-override\ /volume1/homes/USER/directory -\f[] +rclone sync /home/local/directory remote:/home/directory \-\-ssh\-path\-override /volume1/homes/USER/directory +\f[R] .fi .IP \[bu] 2 Config: path_override @@ -21387,7 +26867,7 @@ Env Var: RCLONE_SFTP_PATH_OVERRIDE .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-set\-modtime .PP Set the modified time on the remote if set. @@ -21410,7 +26890,7 @@ Env Var: RCLONE_SFTP_MD5SUM_COMMAND .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]sftp\-sha1sum\-command .PP The command used to read sha1 hashes. @@ -21422,73 +26902,366 @@ Env Var: RCLONE_SFTP_SHA1SUM_COMMAND .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] +.SS \[en]sftp\-skip\-links +.PP +Set to skip any symlinks and any other non regular files. +.IP \[bu] 2 +Config: skip_links +.IP \[bu] 2 +Env Var: RCLONE_SFTP_SKIP_LINKS +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false .SS Limitations .PP SFTP supports checksums if the same login has shell access and -\f[C]md5sum\f[] or \f[C]sha1sum\f[] as well as \f[C]echo\f[] are in the -remote's PATH. +\f[C]md5sum\f[R] or \f[C]sha1sum\f[R] as well as \f[C]echo\f[R] are in +the remote\[cq]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 \f[C]disable_hashcheck\f[] to \f[C]true\f[] -to disable checksumming. +Set the configuration option \f[C]disable_hashcheck\f[R] to +\f[C]true\f[R] to disable checksumming. .PP -SFTP also supports \f[C]about\f[] if the same login has shell access and -\f[C]df\f[] are in the remote's PATH. -\f[C]about\f[] will return the total space, free space, and used space +SFTP also supports \f[C]about\f[R] if the same login has shell access +and \f[C]df\f[R] are in the remote\[cq]s PATH. +\f[C]about\f[R] 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. -\f[C]about\f[] will fail if it does not have shell access or if -\f[C]df\f[] is not in the remote's PATH. +\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\[cq]s PATH. .PP 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 \f[C]disable_hashcheck\f[] is a good idea. +SSH and SFTP so the hashes can\[cq]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's pageant. +The only ssh agent supported under Windows is Putty\[cq]s pageant. .PP 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 -\f[C]use_insecure_cipher\f[] setting in the configuration file to -\f[C]true\f[]. +\f[C]use_insecure_cipher\f[R] setting in the configuration file to +\f[C]true\f[R]. Further details on the insecurity of this cipher can be found [in this -paper] (http://www.isg.rhul.ac.uk/~kp/SandPfinal.pdf). +paper] (http://www.isg.rhul.ac.uk/\[ti]kp/SandPfinal.pdf). .PP -SFTP isn't supported under plan9 until this +SFTP isn\[cq]t supported under plan9 until this issue (https://github.com/pkg/sftp/issues/156) is fixed. .PP -Note that since SFTP isn't HTTP based the following flags don't work -with it: \f[C]\-\-dump\-headers\f[], \f[C]\-\-dump\-bodies\f[], -\f[C]\-\-dump\-auth\f[] +Note that since SFTP isn\[cq]t HTTP based the following flags don\[cq]t +work with it: \f[C]\-\-dump\-headers\f[R], \f[C]\-\-dump\-bodies\f[R], +\f[C]\-\-dump\-auth\f[R] .PP -Note that \f[C]\-\-timeout\f[] isn't supported (but -\f[C]\-\-contimeout\f[] is). +Note that \f[C]\-\-timeout\f[R] isn\[cq]t supported (but +\f[C]\-\-contimeout\f[R] is). .SS C14 .PP C14 is supported through the SFTP backend. .PP -See C14's +See C14\[cq]s documentation (https://www.online.net/en/storage/c14-cold-storage) .SS rsync.net .PP rsync.net is supported through the SFTP backend. .PP -See rsync.net's documentation of rclone +See rsync.net\[cq]s documentation of rclone examples (https://www.rsync.net/products/rclone.html). +.SS SugarSync +.PP +SugarSync (https://sugarsync.com) is a cloud service that enables active +synchronization of files across computers and other devices for file +backup, access, syncing, and sharing. +.PP +The initial setup for SugarSync involves getting a token from SugarSync +which you can do with rclone. +\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 / Sugarsync + \[rs] \[dq]sugarsync\[dq] +[snip] +Storage> sugarsync +** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** + +Sugarsync App ID. +Leave blank to use rclone\[aq]s. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +app_id> +Sugarsync Access Key ID. +Leave blank to use rclone\[aq]s. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +access_key_id> +Sugarsync Private Access Key +Leave blank to use rclone\[aq]s. +Enter a string value. Press Enter for the default (\[dq]\[dq]). +private_access_key> +Permanently delete files if true +otherwise put them in the deleted files. +Enter a boolean value (true or false). Press Enter for the default (\[dq]false\[dq]). +hard_delete> +Edit advanced config? (y/n) +y) Yes +n) No (default) +y/n> n +Remote config +Username (email address)> nick\[at]craig\-wood.com +Your Sugarsync password is only required during setup and will not be stored. +password: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +[remote] +type = sugarsync +refresh_token = https://api.sugarsync.com/app\-authorization/XXXXXXXXXXXXXXXXXX +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +y) Yes this is OK (default) +e) Edit this remote +d) Delete this remote +y/e/d> y +\f[R] +.fi +.PP +Note that the config asks for your email and password but doesn\[cq]t +store them, it only uses them to get the initial token. +.PP +Once configured you can then use \f[C]rclone\f[R] like this, +.PP +List directories (sync folders) in top level of your SugarSync +.IP +.nf +\f[C] +rclone lsd remote: +\f[R] +.fi +.PP +List all the files in your SugarSync folder \[lq]Test\[rq] +.IP +.nf +\f[C] +rclone ls remote:Test +\f[R] +.fi +.PP +To copy a local directory to an SugarSync folder called backup +.IP +.nf +\f[C] +rclone copy /home/source remote:backup +\f[R] +.fi +.PP +Paths are specified as \f[C]remote:path\f[R] +.PP +Paths may be as deep as required, eg +\f[C]remote:directory/subdirectory\f[R]. +.PP +\f[B]NB\f[R] you can\[cq]t create files in the top level folder you have +to create a folder, which rclone will create as a \[lq]Sync Folder\[rq] +with SugarSync. +.SS Modified time and hashes +.PP +SugarSync does not support modification times or hashes, therefore +syncing will default to \f[C]\-\-size\-only\f[R] checking. +Note that using \f[C]\-\-update\f[R] will work as rclone can read the +time files were uploaded. +.SS Restricted filename characters +.PP +SugarSync replaces the default restricted characters +set (/overview/#restricted-characters) except for DEL. +.PP +Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as +they can\[cq]t be used in XML strings. +.SS Deleting files +.PP +Deleted files will be moved to the \[lq]Deleted items\[rq] folder by +default. +.PP +However you can supply the flag \f[C]\-\-sugarsync\-hard\-delete\f[R] or +set the config parameter \f[C]hard_delete = true\f[R] if you would like +files to be deleted straight away. +.SS Standard Options +.PP +Here are the standard options specific to sugarsync (Sugarsync). +.SS \[en]sugarsync\-app\-id +.PP +Sugarsync App ID. +.PP +Leave blank to use rclone\[cq]s. +.IP \[bu] 2 +Config: app_id +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_APP_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-access\-key\-id +.PP +Sugarsync Access Key ID. +.PP +Leave blank to use rclone\[cq]s. +.IP \[bu] 2 +Config: access_key_id +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-private\-access\-key +.PP +Sugarsync Private Access Key +.PP +Leave blank to use rclone\[cq]s. +.IP \[bu] 2 +Config: private_access_key +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-hard\-delete +.PP +Permanently delete files if true otherwise put them in the deleted +files. +.IP \[bu] 2 +Config: hard_delete +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_HARD_DELETE +.IP \[bu] 2 +Type: bool +.IP \[bu] 2 +Default: false +.SS Advanced Options +.PP +Here are the advanced options specific to sugarsync (Sugarsync). +.SS \[en]sugarsync\-refresh\-token +.PP +Sugarsync refresh token +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: refresh_token +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-authorization +.PP +Sugarsync authorization +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: authorization +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_AUTHORIZATION +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-authorization\-expiry +.PP +Sugarsync authorization expiry +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: authorization_expiry +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-user +.PP +Sugarsync user +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: user +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_USER +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-root\-id +.PP +Sugarsync root id +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: root_id +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_ROOT_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-deleted\-id +.PP +Sugarsync deleted folder id +.PP +Leave blank normally, will be auto configured by rclone. +.IP \[bu] 2 +Config: deleted_id +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_DELETED_ID +.IP \[bu] 2 +Type: string +.IP \[bu] 2 +Default: \[dq]\[dq] +.SS \[en]sugarsync\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_SUGARSYNC_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Ctl,InvalidUtf8,Dot .SS Union .PP -The \f[C]union\f[] remote provides a unification similar to UnionFS +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 -\f[C]remote:directory/subdirectory\f[] or -\f[C]/directory/subdirectory\f[]. +\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[] you will specify +During the initial setup with \f[C]rclone config\f[R] you will specify the target remotes as a space separated list. The target remotes can either be a local paths or other remotes. .PP @@ -21502,102 +27275,102 @@ Only the last remote is used to write to and delete from, all other remotes are read\-only. .PP Subfolders can be used in target remote. -Assume a union remote named \f[C]backup\f[] with the remotes -\f[C]mydrive:private/backup\ mydrive2:/backup\f[]. -Invoking \f[C]rclone\ mkdir\ backup:desktop\f[] is exactly the same as -invoking \f[C]rclone\ mkdir\ mydrive2:/backup/desktop\f[]. +Assume a union remote named \f[C]backup\f[R] with the remotes +\f[C]mydrive:private/backup mydrive2:/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]. .PP -There will be no special handling of paths containing \f[C]\&..\f[] +There will be no special handling of paths containing \f[C]..\f[R] segments. -Invoking \f[C]rclone\ mkdir\ backup:../desktop\f[] is exactly the same -as invoking \f[C]rclone\ mkdir\ mydrive2:/backup/../desktop\f[]. +Invoking \f[C]rclone mkdir backup:../desktop\f[R] is exactly the same as +invoking \f[C]rclone mkdir mydrive2:/backup/../desktop\f[R]. .PP -Here is an example of how to make a union called \f[C]remote\f[] for +Here is an example of how to make a union called \f[C]remote\f[R] for local folders. First run: .IP .nf \f[C] -\ rclone\ config -\f[] + 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 +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\ /\ Union\ merges\ the\ contents\ of\ several\ remotes -\ \ \ \\\ "union" +XX / Union merges the contents of several remotes + \[rs] \[dq]union\[dq] [snip] -Storage>\ union -List\ of\ space\ separated\ remotes. -Can\ be\ \[aq]remotea:test/dir\ remoteb:\[aq],\ \[aq]"remotea:test/space\ dir"\ remoteb:\[aq],\ etc. -The\ last\ remote\ is\ used\ to\ write\ to. -Enter\ a\ string\ value.\ Press\ Enter\ for\ the\ default\ (""). +Storage> union +List of space separated remotes. +Can be \[aq]remotea:test/dir remoteb:\[aq], \[aq]\[dq]remotea:test/space dir\[dq] remoteb:\[aq], etc. +The last remote is used to write to. +Enter a string value. Press Enter for the default (\[dq]\[dq]). remotes> -Remote\ config +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -type\ =\ union -remotes\ =\ C:\\dir1\ C:\\dir2\ C:\\dir3 +type = union +remotes = C:\[rs]dir1 C:\[rs]dir2 C:\[rs]dir3 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -Current\ remotes: +y) Yes this is OK +e) Edit this remote +d) Delete this remote +y/e/d> y +Current remotes: -Name\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Type -====\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ==== -remote\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ union +Name Type +==== ==== +remote union -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[] +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP -List directories in top level in \f[C]C:\\dir1\f[], \f[C]C:\\dir2\f[] -and \f[C]C:\\dir3\f[] +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] .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP -List all the files in \f[C]C:\\dir1\f[], \f[C]C:\\dir2\f[] and -\f[C]C:\\dir3\f[] +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] .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP Copy another local directory to the union directory called source, which -will be placed into \f[C]C:\\dir3\f[] +will be placed into \f[C]C:\[rs]dir3\f[R] .IP .nf \f[C] -rclone\ copy\ C:\\source\ remote:source -\f[] +rclone copy C:\[rs]source remote:source +\f[R] .fi .SS Standard Options .PP @@ -21616,115 +27389,115 @@ Env Var: RCLONE_UNION_REMOTES .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS WebDAV .PP -Paths are specified as \f[C]remote:path\f[] +Paths are specified as \f[C]remote:path\f[R] .PP Paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .PP 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. .PP -Here is an example of how to make a remote called \f[C]remote\f[]. +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[] + 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 +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\ /\ Webdav -\ \ \ \\\ "webdav" +XX / Webdav + \[rs] \[dq]webdav\[dq] [snip] -Storage>\ webdav -URL\ of\ http\ host\ to\ connect\ to -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Connect\ to\ example.com -\ \ \ \\\ "https://example.com" -url>\ https://example.com/remote.php/webdav/ -Name\ of\ the\ Webdav\ site/service/software\ you\ are\ using -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value -\ 1\ /\ Nextcloud -\ \ \ \\\ "nextcloud" -\ 2\ /\ Owncloud -\ \ \ \\\ "owncloud" -\ 3\ /\ Sharepoint -\ \ \ \\\ "sharepoint" -\ 4\ /\ Other\ site/service\ or\ software -\ \ \ \\\ "other" -vendor>\ 1 -User\ name -user>\ user +Storage> webdav +URL of http host to connect to +Choose a number from below, or type in your own value + 1 / Connect to example.com + \[rs] \[dq]https://example.com\[dq] +url> https://example.com/remote.php/webdav/ +Name of the Webdav site/service/software you are using +Choose a number from below, or type in your own value + 1 / Nextcloud + \[rs] \[dq]nextcloud\[dq] + 2 / Owncloud + \[rs] \[dq]owncloud\[dq] + 3 / Sharepoint + \[rs] \[dq]sharepoint\[dq] + 4 / Other site/service or software + \[rs] \[dq]other\[dq] +vendor> 1 +User name +user> user Password. -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: +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: +Confirm the password: password: -Bearer\ token\ instead\ of\ user/pass\ (eg\ a\ Macaroon) +Bearer token instead of user/pass (eg a Macaroon) bearer_token> -Remote\ config +Remote config \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -type\ =\ webdav -url\ =\ https://example.com/remote.php/webdav/ -vendor\ =\ nextcloud -user\ =\ user -pass\ =\ ***\ ENCRYPTED\ *** -bearer_token\ = +type = webdav +url = https://example.com/remote.php/webdav/ +vendor = nextcloud +user = user +pass = *** ENCRYPTED *** +bearer_token = \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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[] like this, +Once configured you can then use \f[C]rclone\f[R] like this, .PP List directories in top level of your WebDAV .IP .nf \f[C] -rclone\ lsd\ remote: -\f[] +rclone lsd remote: +\f[R] .fi .PP List all the files in your WebDAV .IP .nf \f[C] -rclone\ ls\ remote: -\f[] +rclone ls remote: +\f[R] .fi .PP To copy a local directory to an WebDAV directory called backup .IP .nf \f[C] -rclone\ copy\ /home/source\ remote:backup -\f[] +rclone copy /home/source remote:backup +\f[R] .fi .SS Modified time and hashes .PP @@ -21750,7 +27523,7 @@ Env Var: RCLONE_WEBDAV_URL .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -21771,7 +27544,7 @@ Env Var: RCLONE_WEBDAV_VENDOR .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -21810,7 +27583,7 @@ Env Var: RCLONE_WEBDAV_USER .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]webdav\-pass .PP Password. @@ -21821,7 +27594,7 @@ Env Var: RCLONE_WEBDAV_PASS .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]webdav\-bearer\-token .PP Bearer token instead of user/pass (eg a Macaroon) @@ -21832,7 +27605,7 @@ Env Var: RCLONE_WEBDAV_BEARER_TOKEN .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to webdav (Webdav). @@ -21846,7 +27619,7 @@ Env Var: RCLONE_WEBDAV_BEARER_TOKEN_COMMAND .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Provider notes .PP See below for notes on specific providers. @@ -21855,13 +27628,14 @@ See below for notes on specific providers. 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 -\f[C]https://example.com/remote.php/webdav/\f[]. +\f[C]https://example.com/remote.php/webdav/\f[R]. .PP -Owncloud supports modified times using the \f[C]X\-OC\-Mtime\f[] header. +Owncloud supports modified times using the \f[C]X\-OC\-Mtime\f[R] +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[]) +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 @@ -21875,47 +27649,48 @@ Office365 Education ones. These accounts are sometimes not verified by the domain owner github#1975 (https://github.com/rclone/rclone/issues/1975) .PP -This means that these accounts can't be added using the official API +This means that these accounts can\[cq]t be added using the official API (other Accounts should work with the \[lq]onedrive\[rq] option). However, it is possible to access them using webdav. .PP To use a sharepoint remote with rclone, add it like this: First, you -need to get your remote's URL: +need to get your remote\[cq]s URL: .IP \[bu] 2 Go here (https://onedrive.live.com/about/en-us/signin/) to open your OneDrive or to sign in .IP \[bu] 2 Now take a look at your address bar, the URL should look like this: -\f[C]https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/_layouts/15/onedrive.aspx\f[] +\f[C]https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/_layouts/15/onedrive.aspx\f[R] .PP -You'll only need this URL upto the email address. -After that, you'll most likely want to add \[lq]/Documents\[rq]. +You\[cq]ll only need this URL upto the email address. +After that, you\[cq]ll most likely want to add \[lq]/Documents\[rq]. That subdirectory contains the actual data stored on your OneDrive. .PP -Add the remote to rclone like this: Configure the \f[C]url\f[] as -\f[C]https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/Documents\f[] -and use your normal account email and password for \f[C]user\f[] and -\f[C]pass\f[]. +Add the remote to rclone like this: Configure the \f[C]url\f[R] as +\f[C]https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/Documents\f[R] +and use your normal account email and password for \f[C]user\f[R] and +\f[C]pass\f[R]. If you have 2FA enabled, you have to generate an app password. -Set the \f[C]vendor\f[] to \f[C]sharepoint\f[]. +Set the \f[C]vendor\f[R] to \f[C]sharepoint\f[R]. .PP Your config file should look like this: .IP .nf \f[C] [sharepoint] -type\ =\ webdav -url\ =\ https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/Documents -vendor\ =\ other -user\ =\ YourEmailAddress -pass\ =\ encryptedpassword -\f[] +type = webdav +url = https://[YOUR\-DOMAIN]\-my.sharepoint.com/personal/[YOUR\-EMAIL]/Documents +vendor = other +user = YourEmailAddress +pass = encryptedpassword +\f[R] .fi .SS Required Flags for SharePoint .PP As SharePoint does some special things with uploaded documents, you -won't be able to use the documents size or the documents hash to compare -if a file has been changed since the upload / which file is newer. +won\[cq]t be able to use the documents size or the documents hash to +compare if a file has been changed since the upload / which file is +newer. .PP For Rclone calls copying files (especially Office files such as .docx, \&.xlsx, etc.) from/to SharePoint (like copy, sync, etc.), you should @@ -21924,8 +27699,8 @@ datetime property to compare your documents: .IP .nf \f[C] -\-\-ignore\-size\ \-\-ignore\-checksum\ \-\-update -\f[] +\-\-ignore\-size \-\-ignore\-checksum \-\-update +\f[R] .fi .SS dCache .PP @@ -21937,22 +27712,22 @@ Macaroons (https://www.dcache.org/manuals/workshop-2017-05-29-Umea/000-Final/anu and OpenID\-Connect (https://en.wikipedia.org/wiki/OpenID_Connect) access tokens. .PP -Configure as normal using the \f[C]other\f[] type. -Don't enter a username or password, instead enter your Macaroon as the -\f[C]bearer_token\f[]. +Configure as normal using the \f[C]other\f[R] type. +Don\[cq]t enter a username or password, instead enter your Macaroon as +the \f[C]bearer_token\f[R]. .PP The config will end up looking something like this. .IP .nf \f[C] [dcache] -type\ =\ webdav -url\ =\ https://dcache... -vendor\ =\ other -user\ = -pass\ = -bearer_token\ =\ your\-macaroon -\f[] +type = webdav +url = https://dcache... +vendor = other +user = +pass = +bearer_token = your\-macaroon +\f[R] .fi .PP There is a @@ -21973,47 +27748,47 @@ another software package called oidc\-agent (https://github.com/indigo-dc/oidc-agent). This is a command\-line tool that facilitates obtaining an access token. Once installed and configured, an access token is obtained by running -the \f[C]oidc\-token\f[] command. +the \f[C]oidc\-token\f[R] command. The following example shows a (shortened) access token obtained from the -\f[I]XDC\f[] OIDC Provider. +\f[I]XDC\f[R] OIDC Provider. .IP .nf \f[C] -paul\@celebrimbor:~$\ oidc\-token\ XDC +paul\[at]celebrimbor:\[ti]$ oidc\-token XDC eyJraWQ[...]QFXDt0 -paul\@celebrimbor:~$ -\f[] +paul\[at]celebrimbor:\[ti]$ +\f[R] .fi .PP -\f[B]Note\f[] Before the \f[C]oidc\-token\f[] command will work, the +\f[B]Note\f[R] Before the \f[C]oidc\-token\f[R] command will work, the refresh token must be loaded into the oidc agent. -This is done with the \f[C]oidc\-add\f[] command (e.g., -\f[C]oidc\-add\ XDC\f[]). +This is done with the \f[C]oidc\-add\f[R] command (e.g., +\f[C]oidc\-add XDC\f[R]). This is typically done once per login session. Full details on this and how to register oidc\-agent with your OIDC Provider are provided in the oidc\-agent documentation (https://indigo-dc.gitbooks.io/oidc-agent/). .PP -The rclone \f[C]bearer_token_command\f[] configuration option is used to -fetch the access token from oidc\-agent. +The rclone \f[C]bearer_token_command\f[R] configuration option is used +to fetch the access token from oidc\-agent. .PP Configure as a normal WebDAV endpoint, using the `other' vendor, leaving the username and password empty. When prompted, choose to edit the advanced config and enter the command -to get a bearer token (e.g., \f[C]oidc\-agent\ XDC\f[]). +to get a bearer token (e.g., \f[C]oidc\-agent XDC\f[R]). .PP The following example config shows a WebDAV endpoint that uses -oidc\-agent to supply an access token from the \f[I]XDC\f[] OIDC +oidc\-agent to supply an access token from the \f[I]XDC\f[R] OIDC Provider. .IP .nf \f[C] [dcache] -type\ =\ webdav -url\ =\ https://dcache.example.org/ -vendor\ =\ other -bearer_token_command\ =\ oidc\-token\ XDC -\f[] +type = webdav +url = https://dcache.example.org/ +vendor = other +bearer_token_command = oidc\-token XDC +\f[R] .fi .SS Yandex Disk .PP @@ -22025,52 +27800,52 @@ First run .IP .nf \f[C] -rclone\ config -\f[] +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. -Choose\ a\ number\ from\ below,\ or\ type\ in\ your\ own\ value +No remotes found \- make a new one +n) New remote +s) Set configuration password +n/s> n +name> remote +Type of storage to configure. +Choose a number from below, or type in your own value [snip] -XX\ /\ Yandex\ Disk -\ \ \ \\\ "yandex" +XX / Yandex Disk + \[rs] \[dq]yandex\[dq] [snip] -Storage>\ yandex -Yandex\ Client\ Id\ \-\ leave\ blank\ normally. +Storage> yandex +Yandex Client Id \- leave blank normally. client_id> -Yandex\ Client\ Secret\ \-\ leave\ blank\ normally. +Yandex Client Secret \- leave blank normally. client_secret> -Remote\ config -Use\ auto\ config? -\ *\ Say\ Y\ if\ not\ sure -\ *\ Say\ N\ if\ you\ are\ working\ on\ a\ remote\ or\ headless\ machine -y)\ Yes -n)\ No -y/n>\ y -If\ your\ browser\ doesn\[aq]t\ open\ automatically\ go\ to\ the\ following\ link:\ http://127.0.0.1:53682/auth -Log\ in\ and\ authorize\ rclone\ for\ access -Waiting\ for\ code... -Got\ code +Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn\[aq]t open automatically go to the following link: http://127.0.0.1:53682/auth +Log in and authorize rclone for access +Waiting for code... +Got code \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- [remote] -client_id\ = -client_secret\ = -token\ =\ {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","expiry":"2016\-12\-29T12:27:11.362788025Z"} +client_id = +client_secret = +token = {\[dq]access_token\[dq]:\[dq]xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\[dq],\[dq]token_type\[dq]:\[dq]bearer\[dq],\[dq]expiry\[dq]:\[dq]2016\-12\-29T12:27:11.362788025Z\[dq]} \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -y)\ Yes\ this\ is\ OK -e)\ Edit\ this\ remote -d)\ Delete\ this\ remote -y/e/d>\ y -\f[] +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 @@ -22080,50 +27855,50 @@ Note that rclone runs a webserver on your local machine to collect the token as returned from Yandex Disk. This only runs from the moment it opens your browser to the moment you get back the verification code. -This is on \f[C]http://127.0.0.1:53682/\f[] and this it may require you +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[] like this, +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[] +rclone lsd remote: +\f[R] .fi .PP Make a new directory .IP .nf \f[C] -rclone\ mkdir\ remote:directory -\f[] +rclone mkdir remote:directory +\f[R] .fi .PP List the contents of a directory .IP .nf \f[C] -rclone\ ls\ remote:directory -\f[] +rclone ls remote:directory +\f[R] .fi .PP -Sync \f[C]/home/local/directory\f[] to the remote path, deleting any +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\ /home/local/directory\ remote:directory -\f[] +rclone sync /home/local/directory remote:directory +\f[R] .fi .PP Yandex paths may be as deep as required, eg -\f[C]remote:directory/subdirectory\f[]. +\f[C]remote:directory/subdirectory\f[R]. .SS Modified time .PP Modified times are supported and are stored accurate to 1 ns in custom -metadata called \f[C]rclone_modified\f[] in RFC3339 with nanoseconds +metadata called \f[C]rclone_modified\f[R] in RFC3339 with nanoseconds format. .SS MD5 checksums .PP @@ -22131,13 +27906,13 @@ MD5 checksums are natively supported by Yandex Disk. .SS Emptying Trash .PP If you wish to empty your trash you can use the -\f[C]rclone\ cleanup\ remote:\f[] command which will permanently delete +\f[C]rclone cleanup remote:\f[R] command which will permanently delete all your trashed files. This command does not take any path arguments. .SS Quota information .PP To view your current quota you can use the -\f[C]rclone\ about\ remote:\f[] command which will display your usage +\f[C]rclone about remote:\f[R] command which will display your usage limit (quota) and the current usage. .SS Restricted filename characters .PP @@ -22145,21 +27920,21 @@ The default restricted characters set (/overview/#restricted-characters) are replaced. .PP Invalid UTF\-8 bytes will also be replaced (/overview/#invalid-utf8), as -they can't be used in JSON strings. +they can\[cq]t be used in JSON strings. .SS Limitations .PP When uploading very large files (bigger than about 5GB) you will need to -increase the \f[C]\-\-timeout\f[] parameter. +increase the \f[C]\-\-timeout\f[R] 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 -\f[C]net/http:\ timeout\ awaiting\ response\ headers\f[] errors in the -logs if this is happening. +is an error and close the connection \- you\[cq]ll see +\f[C]net/http: timeout awaiting response headers\f[R] 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 -\f[C]2\ *\ 30\ =\ 60m\f[], that is \f[C]\-\-timeout\ 60m\f[]. +\f[C]2 * 30 = 60m\f[R], that is \f[C]\-\-timeout 60m\f[R]. .SS Standard Options .PP Here are the standard options specific to yandex (Yandex Disk). @@ -22173,7 +27948,7 @@ Env Var: RCLONE_YANDEX_CLIENT_ID .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS \[en]yandex\-client\-secret .PP Yandex Client Secret Leave blank normally. @@ -22184,7 +27959,7 @@ Env Var: RCLONE_YANDEX_CLIENT_SECRET .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .SS Advanced Options .PP Here are the advanced options specific to yandex (Yandex Disk). @@ -22202,18 +27977,32 @@ Env Var: RCLONE_YANDEX_UNLINK Type: bool .IP \[bu] 2 Default: false +.SS \[en]yandex\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_YANDEX_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Del,Ctl,InvalidUtf8,Dot .SS Local Filesystem .PP Local paths are specified as normal filesystem paths, eg -\f[C]/path/to/wherever\f[], so +\f[C]/path/to/wherever\f[R], so .IP .nf \f[C] -rclone\ sync\ /home/source\ /tmp/destination -\f[] +rclone sync /home/source /tmp/destination +\f[R] .fi .PP -Will sync \f[C]/home/source\f[] to \f[C]/tmp/destination\f[] +Will sync \f[C]/home/source\f[R] to \f[C]/tmp/destination\f[R] .PP These can be configured into the config file for consistencies sake, but it is probably easier not to. @@ -22230,20 +28019,21 @@ 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 \f[C]convmv\f[] tool to convert the +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' package managers. +This tool is available in most distributions\[cq] package managers. .PP If an invalid (non\-UTF8) filename is read, the invalid characters will be replaced with a quoted representation of the invalid bytes. -The name \f[C]gro\\xdf\f[] will be transferred as \f[C]gro‛DF\f[]. -\f[C]rclone\f[] will emit a debug message in this case (use \f[C]\-v\f[] -to see), eg +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 .IP .nf \f[C] -Local\ file\ system\ at\ .:\ Replacing\ invalid\ UTF\-8\ characters\ in\ "gro\\xdf" -\f[] +Local file system at .: Replacing invalid UTF\-8 characters in \[dq]gro\[rs]xdf\[dq] +\f[R] .fi .SS Restricted characters .PP @@ -22266,14 +28056,14 @@ NUL T}@T{ 0x00 T}@T{ -␀ +\[u2400] T} T{ / T}@T{ 0x2F T}@T{ -／ +\[uFF0F] T} .TE .PP @@ -22297,287 +28087,287 @@ 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{ -" +\[dq] T}@T{ 0x22 T}@T{ -＂ +\[uFF02] T} T{ * T}@T{ 0x2A T}@T{ -＊ +\[uFF0A] T} T{ : T}@T{ 0x3A T}@T{ -： +\[uFF1A] 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{ -\\ +\[rs] T}@T{ 0x5C T}@T{ -＼ +\[uFF3C] T} T{ | T}@T{ 0x7C T}@T{ -｜ +\[uFF5C] T} .TE .PP @@ -22600,19 +28390,19 @@ 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 (/overview/#invalid-utf8), as -they can't be converted to UTF\-16. +they can\[cq]t be converted to UTF\-16. .SS Long paths on Windows .PP Rclone handles long paths automatically, by converting all paths to long @@ -22621,20 +28411,21 @@ paths (https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85 which allows paths up to 32,767 characters. .PP This is why you will see that your paths, for instance -\f[C]c:\\files\f[] is converted to the UNC path -\f[C]\\\\?\\c:\\files\f[] in the output, and \f[C]\\\\server\\share\f[] -is converted to \f[C]\\\\?\\UNC\\server\\share\f[]. +\f[C]c:\[rs]files\f[R] is converted to the UNC path +\f[C]\[rs]\[rs]?\[rs]c:\[rs]files\f[R] in the output, and +\f[C]\[rs]\[rs]server\[rs]share\f[R] is converted to +\f[C]\[rs]\[rs]?\[rs]UNC\[rs]server\[rs]share\f[R]. .PP However, in rare cases this may cause problems with buggy file system drivers like EncFS (https://github.com/rclone/rclone/issues/261). To disable UNC conversion globally, add this to your -\f[C]\&.rclone.conf\f[] file: +\f[C].rclone.conf\f[R] file: .IP .nf \f[C] [local] -nounc\ =\ true -\f[] +nounc = true +\f[R] .fi .PP If you want to selectively disable UNC, you can add it to a separate @@ -22643,16 +28434,17 @@ entry like this: .nf \f[C] [nounc] -type\ =\ local -nounc\ =\ true -\f[] +type = local +nounc = true +\f[R] .fi .PP And use rclone like this: .PP -\f[C]rclone\ copy\ c:\\src\ nounc:z:\\dst\f[] +\f[C]rclone copy c:\[rs]src nounc:z:\[rs]dst\f[R] .PP -This will use UNC paths on \f[C]c:\\src\f[] but not on \f[C]z:\\dst\f[]. +This will use UNC paths on \f[C]c:\[rs]src\f[R] but not on +\f[C]z:\[rs]dst\f[R]. Of course this will cause problems if the absolute path length of a file exceeds 258 characters on z, so only use this option if you have to. .SS Symlinks / Junction points @@ -22660,10 +28452,10 @@ exceeds 258 characters on z, so only use this option if you have to. Normally rclone will ignore symlinks or junction points (which behave like symlinks under Windows). .PP -If you supply \f[C]\-\-copy\-links\f[] or \f[C]\-L\f[] then rclone will -follow the symlink and copy the pointed to file or directory. -Note that this flag is incompatible with \f[C]\-links\f[] / -\f[C]\-l\f[]. +If you supply \f[C]\-\-copy\-links\f[R] or \f[C]\-L\f[R] then rclone +will follow the symlink and copy the pointed to file or directory. +Note that this flag is incompatible with \f[C]\-links\f[R] / +\f[C]\-l\f[R]. .PP This flag applies to all commands. .PP @@ -22671,37 +28463,37 @@ For example, supposing you have a directory structure like this .IP .nf \f[C] -$\ tree\ /tmp/a +$ tree /tmp/a /tmp/a -├──\ b\ \->\ ../b -├──\ expected\ \->\ ../expected -├──\ one -└──\ two -\ \ \ \ └──\ three -\f[] +\[u251C]\[u2500]\[u2500] b \-> ../b +\[u251C]\[u2500]\[u2500] expected \-> ../expected +\[u251C]\[u2500]\[u2500] one +\[u2514]\[u2500]\[u2500] two + \[u2514]\[u2500]\[u2500] three +\f[R] .fi .PP Then you can see the difference with and without the flag like this .IP .nf \f[C] -$\ rclone\ ls\ /tmp/a -\ \ \ \ \ \ \ \ 6\ one -\ \ \ \ \ \ \ \ 6\ two/three -\f[] +$ rclone ls /tmp/a + 6 one + 6 two/three +\f[R] .fi .PP and .IP .nf \f[C] -$\ rclone\ \-L\ ls\ /tmp/a -\ \ \ \ \ 4174\ expected -\ \ \ \ \ \ \ \ 6\ one -\ \ \ \ \ \ \ \ 6\ two/three -\ \ \ \ \ \ \ \ 6\ b/two -\ \ \ \ \ \ \ \ 6\ b/one -\f[] +$ rclone \-L ls /tmp/a + 4174 expected + 6 one + 6 two/three + 6 b/two + 6 b/one +\f[R] .fi .SS \[en]links, \-l .PP @@ -22721,76 +28513,76 @@ For example, supposing you have a directory structure like this .IP .nf \f[C] -$\ tree\ /tmp/a +$ tree /tmp/a /tmp/a -├──\ file1\ \->\ ./file4 -└──\ file2\ \->\ /home/user/file3 -\f[] +\[u251C]\[u2500]\[u2500] file1 \-> ./file4 +\[u2514]\[u2500]\[u2500] file2 \-> /home/user/file3 +\f[R] .fi .PP Copying the entire directory with `\-l' .IP .nf \f[C] -$\ rclone\ copyto\ \-l\ /tmp/a/file1\ remote:/tmp/a/ -\f[] +$ rclone copyto \-l /tmp/a/file1 remote:/tmp/a/ +\f[R] .fi .PP The remote files are created with a `.rclonelink' suffix .IP .nf \f[C] -$\ rclone\ ls\ remote:/tmp/a -\ \ \ \ \ \ \ 5\ file1.rclonelink -\ \ \ \ \ \ 14\ file2.rclonelink -\f[] +$ rclone ls remote:/tmp/a + 5 file1.rclonelink + 14 file2.rclonelink +\f[R] .fi .PP The remote files will contain the target of the symbolic links .IP .nf \f[C] -$\ rclone\ cat\ remote:/tmp/a/file1.rclonelink +$ rclone cat remote:/tmp/a/file1.rclonelink \&./file4 -$\ rclone\ cat\ remote:/tmp/a/file2.rclonelink +$ rclone cat remote:/tmp/a/file2.rclonelink /home/user/file3 -\f[] +\f[R] .fi .PP Copying them back with `\-l' .IP .nf \f[C] -$\ rclone\ copyto\ \-l\ remote:/tmp/a/\ /tmp/b/ +$ rclone copyto \-l remote:/tmp/a/ /tmp/b/ -$\ tree\ /tmp/b +$ tree /tmp/b /tmp/b -├──\ file1\ \->\ ./file4 -└──\ file2\ \->\ /home/user/file3 -\f[] +\[u251C]\[u2500]\[u2500] file1 \-> ./file4 +\[u2514]\[u2500]\[u2500] file2 \-> /home/user/file3 +\f[R] .fi .PP However, if copied back without `\-l' .IP .nf \f[C] -$\ rclone\ copyto\ remote:/tmp/a/\ /tmp/b/ +$ rclone copyto remote:/tmp/a/ /tmp/b/ -$\ tree\ /tmp/b +$ tree /tmp/b /tmp/b -├──\ file1.rclonelink -└──\ file2.rclonelink -\f[] +\[u251C]\[u2500]\[u2500] file1.rclonelink +\[u2514]\[u2500]\[u2500] file2.rclonelink +\f[R] .fi .PP -Note that this flag is incompatible with \f[C]\-copy\-links\f[] / -\f[C]\-L\f[]. +Note that this flag is incompatible with \f[C]\-copy\-links\f[R] / +\f[C]\-L\f[R]. .SS Restricting filesystems with \[en]one\-file\-system .PP Normally rclone will recurse through filesystems as mounted. .PP -However if you set \f[C]\-\-one\-file\-system\f[] or \f[C]\-x\f[] this +However if you set \f[C]\-\-one\-file\-system\f[R] or \f[C]\-x\f[R] this tells rclone to stay in the filesystem specified by the root and not to recurse into different file systems. .PP @@ -22799,43 +28591,43 @@ For example if you have a directory hierarchy like this .nf \f[C] root -├──\ disk1\ \ \ \ \ \-\ disk1\ mounted\ on\ the\ root -│\ \ \ └──\ file3\ \-\ stored\ on\ disk1 -├──\ disk2\ \ \ \ \ \-\ disk2\ mounted\ on\ the\ root -│\ \ \ └──\ file4\ \-\ stored\ on\ disk12 -├──\ file1\ \ \ \ \ \-\ stored\ on\ the\ root\ disk -└──\ file2\ \ \ \ \ \-\ stored\ on\ the\ root\ disk -\f[] +\[u251C]\[u2500]\[u2500] disk1 \- disk1 mounted on the root +\[br]\ \ \[u2514]\[u2500]\[u2500] file3 \- stored on disk1 +\[u251C]\[u2500]\[u2500] disk2 \- disk2 mounted on the root +\[br]\ \ \[u2514]\[u2500]\[u2500] file4 \- stored on disk12 +\[u251C]\[u2500]\[u2500] file1 \- stored on the root disk +\[u2514]\[u2500]\[u2500] file2 \- stored on the root disk +\f[R] .fi .PP -Using \f[C]rclone\ \-\-one\-file\-system\ copy\ root\ remote:\f[] will -only copy \f[C]file1\f[] and \f[C]file2\f[]. +Using \f[C]rclone \-\-one\-file\-system copy root remote:\f[R] will only +copy \f[C]file1\f[R] and \f[C]file2\f[R]. Eg .IP .nf \f[C] -$\ rclone\ \-q\ \-\-one\-file\-system\ ls\ root -\ \ \ \ \ \ \ \ 0\ file1 -\ \ \ \ \ \ \ \ 0\ file2 -\f[] +$ rclone \-q \-\-one\-file\-system ls root + 0 file1 + 0 file2 +\f[R] .fi .IP .nf \f[C] -$\ rclone\ \-q\ ls\ root -\ \ \ \ \ \ \ \ 0\ disk1/file3 -\ \ \ \ \ \ \ \ 0\ disk2/file4 -\ \ \ \ \ \ \ \ 0\ file1 -\ \ \ \ \ \ \ \ 0\ file2 -\f[] +$ rclone \-q ls root + 0 disk1/file3 + 0 disk2/file4 + 0 file1 + 0 file2 +\f[R] .fi .PP -\f[B]NB\f[] Rclone (like most unix tools such as \f[C]du\f[], -\f[C]rsync\f[] and \f[C]tar\f[]) treats a bind mount to the same device -as being on the same filesystem. +\f[B]NB\f[R] Rclone (like most unix tools such as \f[C]du\f[R], +\f[C]rsync\f[R] and \f[C]tar\f[R]) treats a bind mount to the same +device as being on the same filesystem. .PP -\f[B]NB\f[] This flag is only available on Unix based systems. -On systems where it isn't supported (eg Windows) it will be ignored. +\f[B]NB\f[R] This flag is only available on Unix based systems. +On systems where it isn\[cq]t supported (eg Windows) it will be ignored. .SS Standard Options .PP Here are the standard options specific to local (Local Disk). @@ -22849,7 +28641,7 @@ Env Var: RCLONE_LOCAL_NOUNC .IP \[bu] 2 Type: string .IP \[bu] 2 -Default: "" +Default: \[dq]\[dq] .IP \[bu] 2 Examples: .RS 2 @@ -22887,7 +28679,7 @@ Type: bool Default: false .SS \[en]skip\-links .PP -Don't warn about skipped symlinks. +Don\[cq]t warn about skipped symlinks. This flag disables warning messages on skipped symlinks or junction points, as you explicitly acknowledge that they should be skipped. .IP \[bu] 2 @@ -22900,7 +28692,8 @@ Type: bool Default: false .SS \[en]local\-no\-unicode\-normalization .PP -Don't apply unicode normalization to paths and filenames (Deprecated) +Don\[cq]t apply unicode normalization to paths and filenames +(Deprecated) .PP This flag is deprecated now. Rclone no longer normalizes unicode file names, but it compares them @@ -22915,10 +28708,10 @@ Type: bool Default: false .SS \[en]local\-no\-check\-updated .PP -Don't check to see if the files change during upload +Don\[cq]t check to see if the files change during upload .PP Normally rclone checks the size and modification time of files as they -are being uploaded and aborts with a message which starts \[lq]can't +are being uploaded and aborts with a message which starts \[lq]can\[cq]t copy \- source file is being updated\[rq] if the file changes during upload. .PP @@ -22935,7 +28728,7 @@ Type: bool Default: false .SS \[en]one\-file\-system / \-x .PP -Don't cross filesystem boundaries (unix/macOS only). +Don\[cq]t cross filesystem boundaries (unix/macOS only). .IP \[bu] 2 Config: one_file_system .IP \[bu] 2 @@ -22974,7 +28767,434 @@ Env Var: RCLONE_LOCAL_CASE_INSENSITIVE Type: bool .IP \[bu] 2 Default: false +.SS \[en]local\-encoding +.PP +This sets the encoding for the backend. +.PP +See: the encoding section in the overview (/overview/#encoding) for more +info. +.IP \[bu] 2 +Config: encoding +.IP \[bu] 2 +Env Var: RCLONE_LOCAL_ENCODING +.IP \[bu] 2 +Type: MultiEncoder +.IP \[bu] 2 +Default: Slash,Dot .SH Changelog +.SS v1.51.0 \- 2020\-02\-01 +.IP \[bu] 2 +New backends +.RS 2 +.IP \[bu] 2 +Memory (/memory) (Nick Craig\-Wood) +.IP \[bu] 2 +Sugarsync (/sugarsync) (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +New Features +.RS 2 +.IP \[bu] 2 +Adjust all backends to have \f[C]\-\-backend\-encoding\f[R] parameter +(Nick Craig\-Wood) +.RS 2 +.IP \[bu] 2 +this enables the encoding for special characters to be adjusted or +disabled +.RE +.IP \[bu] 2 +Add \f[C]\-\-max\-duration\f[R] flag to control the maximum duration of +a transfer session (boosh) +.IP \[bu] 2 +Add \f[C]\-\-expect\-continue\-timeout\f[R] flag, default 1s (Nick +Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-no\-check\-dest\f[R] flag for copying without testing the +destination (Nick Craig\-Wood) +.IP \[bu] 2 +Implement \f[C]\-\-order\-by\f[R] flag to order transfers (Nick +Craig\-Wood) +.IP \[bu] 2 +accounting +.RS 2 +.IP \[bu] 2 +Don\[cq]t show entries in both transferring and checking (Nick +Craig\-Wood) +.IP \[bu] 2 +Add option to delete stats (Aleksandar Jankovic) +.RE +.IP \[bu] 2 +build +.RS 2 +.IP \[bu] 2 +Compress the test builds with gzip (Nick Craig\-Wood) +.IP \[bu] 2 +Implement a framework for starting test servers during tests (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +cmd: Always print elapsed time to tenth place seconds in progress (Gary +Kim) +.IP \[bu] 2 +config +.RS 2 +.IP \[bu] 2 +Add \f[C]\-\-password\-command\f[R] to allow dynamic config password +(Damon Permezel) +.IP \[bu] 2 +Give config questions default values (Nick Craig\-Wood) +.IP \[bu] 2 +Check a remote exists when creating a new one (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +copyurl: Add \f[C]\-\-stdout\f[R] flag to write to stdout (Nick +Craig\-Wood) +.IP \[bu] 2 +dedupe: Implement keep smallest too (Nick Craig\-Wood) +.IP \[bu] 2 +hashsum: Add flag \f[C]\-\-base64\f[R] flag (landall) +.IP \[bu] 2 +lsf: Speed up on s3/swift/etc by not reading mimetype by default (Nick +Craig\-Wood) +.IP \[bu] 2 +lsjson: Add \f[C]\-\-no\-mimetype\f[R] flag (Nick Craig\-Wood) +.IP \[bu] 2 +rc: Add methods to turn on blocking and mutex profiling (Nick +Craig\-Wood) +.IP \[bu] 2 +rcd +.RS 2 +.IP \[bu] 2 +Adding group parameter to stats (Chaitanya) +.IP \[bu] 2 +Move webgui apart; option to disable browser (Xiaoxing Ye) +.RE +.IP \[bu] 2 +serve sftp: Add support for public key with auth proxy (Paul Tinsley) +.IP \[bu] 2 +stats: Show deletes in stats and hide zero stats (anuar45) +.RE +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting +.RS 2 +.IP \[bu] 2 +Fix error counter counting multiple times (Ankur Gupta) +.IP \[bu] 2 +Fix error count shown as checks (Cnly) +.IP \[bu] 2 +Clear finished transfer in stats\-reset (Maciej Zimnoch) +.IP \[bu] 2 +Added StatsInfo locking in statsGroups sum function (Micha\[/l] Matczuk) +.RE +.IP \[bu] 2 +asyncreader: Fix EOF error (buengese) +.IP \[bu] 2 +check: Fix \f[C]\-\-one\-way\f[R] recursing more directories than it +needs to (Nick Craig\-Wood) +.IP \[bu] 2 +chunkedreader: Disable hash calculation for first segment (Nick +Craig\-Wood) +.IP \[bu] 2 +config +.RS 2 +.IP \[bu] 2 +Do not open browser on headless on drive/gcs/google photos (Xiaoxing Ye) +.IP \[bu] 2 +SetValueAndSave ignore error if config section does not exist yet +(buengese) +.RE +.IP \[bu] 2 +cmd: Fix completion with an encrypted config (Danil Semelenov) +.IP \[bu] 2 +dbhashsum: Stop it returning UNSUPPORTED on dropbox (Nick Craig\-Wood) +.IP \[bu] 2 +dedupe: Add missing modes to help string (Nick Craig\-Wood) +.IP \[bu] 2 +operations +.RS 2 +.IP \[bu] 2 +Fix dedupe continuing on errors like insufficientFilePermisson +(SezalAgrawal) +.IP \[bu] 2 +Clear accounting before low level retry (Maciej Zimnoch) +.IP \[bu] 2 +Write debug message when hashes could not be checked (Ole Sch\[:u]tt) +.IP \[bu] 2 +Move interface assertion to tests to remove pflag dependency (Nick +Craig\-Wood) +.IP \[bu] 2 +Make NewOverrideObjectInfo public and factor uses (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +proxy: Replace use of bcrypt with sha256 (Nick Craig\-Wood) +.IP \[bu] 2 +vendor +.RS 2 +.IP \[bu] 2 +Update bazil.org/fuse to fix FreeBSD 12.1 (Nick Craig\-Wood) +.IP \[bu] 2 +Update github.com/t3rm1n4l/go\-mega to fix mega \[lq]illegal base64 data +at input byte 22\[rq] (Nick Craig\-Wood) +.IP \[bu] 2 +Update termbox\-go to fix ncdu command on FreeBSD (Kuang\-che Wu) +.IP \[bu] 2 +Update t3rm1n4l/go\-mega \- fixes mega: couldn\[cq]t login: crypto/aes: +invalid key size 0 (Nick Craig\-Wood) +.RE +.RE +.IP \[bu] 2 +Mount +.RS 2 +.IP \[bu] 2 +Enable async reads for a 20% speedup (Nick Craig\-Wood) +.IP \[bu] 2 +Replace use of WriteAt with Write for cache mode >= writes and O_APPEND +(Brett Dutro) +.IP \[bu] 2 +Make sure we call unmount when exiting (Nick Craig\-Wood) +.IP \[bu] 2 +Don\[cq]t build on go1.10 as bazil/fuse no longer supports it (Nick +Craig\-Wood) +.IP \[bu] 2 +When setting dates discard out of range dates (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +VFS +.RS 2 +.IP \[bu] 2 +Add a newly created file straight into the directory (Nick Craig\-Wood) +.IP \[bu] 2 +Only calculate one hash for reads for a speedup (Nick Craig\-Wood) +.IP \[bu] 2 +Make ReadAt for non cached files work better with non\-sequential reads +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix edge cases when reading ModTime from file (Nick Craig\-Wood) +.IP \[bu] 2 +Make sure existing files opened for write show correct size (Nick +Craig\-Wood) +.IP \[bu] 2 +Don\[cq]t cache the path in RW file objects to fix renaming (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix rename of open files when using the VFS cache (Nick Craig\-Wood) +.IP \[bu] 2 +When renaming files in the cache, rename the cache item in memory too +(Nick Craig\-Wood) +.IP \[bu] 2 +Fix open file renaming on drive when using +\f[C]\-\-vfs\-cache\-mode writes\f[R] (Nick Craig\-Wood) +.IP \[bu] 2 +Fix incorrect modtime for mv into mount with +\f[C]\-\-vfs\-cache\-modes writes\f[R] (Nick Craig\-Wood) +.IP \[bu] 2 +On rename, rename in cache too if the file exists (Anagh Kumar Baranwal) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Make source file being updated errors be NoLowLevelRetry errors (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix update of hidden files on Windows (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Cache +.RS 2 +.IP \[bu] 2 +Follow move of upstream library github.com/coreos/bbolt +github.com/etcd\-io/bbolt (Nick Craig\-Wood) +.IP \[bu] 2 +Fix \f[C]fatal error: concurrent map writes\f[R] (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Crypt +.RS 2 +.IP \[bu] 2 +Reorder the filename encryption options (Thomas Eales) +.IP \[bu] 2 +Correctly handle trailing dot (buengese) +.RE +.IP \[bu] 2 +Chunker +.RS 2 +.IP \[bu] 2 +Reduce length of temporary suffix (Ivan Andreev) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Add \f[C]\-\-drive\-stop\-on\-upload\-limit\f[R] flag to stop syncs when +upload limit reached (Nick Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-drive\-use\-shared\-date\f[R] to use date file was shared +instead of modified date (Garry McNulty) +.IP \[bu] 2 +Make sure invalid auth for teamdrives always reports an error (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix \f[C]\-\-fast\-list\f[R] when using appDataFolder (Nick Craig\-Wood) +.IP \[bu] 2 +Use multipart resumable uploads for streaming and uploads in mount (Nick +Craig\-Wood) +.IP \[bu] 2 +Log an ERROR if an incomplete search is returned (Nick Craig\-Wood) +.IP \[bu] 2 +Hide dangerous config from the configurator (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Dropbox +.RS 2 +.IP \[bu] 2 +Treat \f[C]insufficient_space\f[R] errors as non retriable errors (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Jottacloud +.RS 2 +.IP \[bu] 2 +Use new auth method used by official client (buengese) +.IP \[bu] 2 +Add URL to generate Login Token to config wizard (Nick Craig\-Wood) +.IP \[bu] 2 +Add support whitelabel versions (buengese) +.RE +.IP \[bu] 2 +Koofr +.RS 2 +.IP \[bu] 2 +Use rclone HTTP client. +(jaKa) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Add Sites.Read.All permission (Benjamin Richter) +.IP \[bu] 2 +Add support \[lq]Retry\-After\[rq] header (Motonori IWAMURO) +.RE +.IP \[bu] 2 +Opendrive +.RS 2 +.IP \[bu] 2 +Implement \f[C]\-\-opendrive\-chunk\-size\f[R] (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +S3 +.RS 2 +.IP \[bu] 2 +Re\-implement multipart upload to fix memory issues (Nick Craig\-Wood) +.IP \[bu] 2 +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) +.IP \[bu] 2 +Reduce memory usage streaming files by reducing max stream upload size +(Nick Craig\-Wood) +.IP \[bu] 2 +Add \f[C]\-\-s3\-list\-chunk\f[R] option for bucket listing (Thomas +Kriechbaumer) +.IP \[bu] 2 +Force path style bucket access to off for AWS deprecation (Nick +Craig\-Wood) +.IP \[bu] 2 +Use AWS web identity role provider if available (Tennix) +.IP \[bu] 2 +Fix ExpiryWindow value (Aleksandar Jankovic) +.IP \[bu] 2 +Fix DisableChecksum condition (Aleksandar Jankovi\['c]) +.IP \[bu] 2 +Fix URL decoding of NextMarker (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +SFTP +.RS 2 +.IP \[bu] 2 +Add \f[C]\-\-sftp\-skip\-links\f[R] to skip symlinks and non regular +files (Nick Craig\-Wood) +.IP \[bu] 2 +Retry Creation of Connection (Sebastian Brandt) +.IP \[bu] 2 +Fix \[lq]failed to parse private key file: ssh: not an encrypted +key\[rq] error (Nick Craig\-Wood) +.IP \[bu] 2 +Open files for update write only to fix AWS SFTP interop (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Swift +.RS 2 +.IP \[bu] 2 +Reserve segments of dynamic large object when delete objects in +container what was enabled versioning. +(Nguy\[u1EC5]n H\[u1EEF]u Lu\[^a]n) +.IP \[bu] 2 +Fix parsing of X\-Object\-Manifest (Nick Craig\-Wood) +.IP \[bu] 2 +Update OVH API endpoint (unbelauscht) +.RE +.IP \[bu] 2 +WebDAV +.RS 2 +.IP \[bu] 2 +Make nextcloud only upload SHA1 checksums (Nick Craig\-Wood) +.IP \[bu] 2 +Fix case of \[lq]Bearer\[rq] in Authorization: header to agree with RFC +(Nick Craig\-Wood) +.IP \[bu] 2 +Add Referer header to fix problems with WAFs (Nick Craig\-Wood) +.RE +.SS v1.50.2 \- 2019\-11\-19 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +accounting: Fix memory leak on retries operations (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Drive +.RS 2 +.IP \[bu] 2 +Fix listing of the root directory with drive.files scope (Nick +Craig\-Wood) +.IP \[bu] 2 +Fix \[en]drive\-root\-folder\-id with team/shared drives (Nick +Craig\-Wood) +.RE +.SS v1.50.1 \- 2019\-11\-02 +.IP \[bu] 2 +Bug Fixes +.RS 2 +.IP \[bu] 2 +hash: Fix accidentally changed hash names for \f[C]DropboxHash\f[R] and +\f[C]CRC\-32\f[R] (Nick Craig\-Wood) +.IP \[bu] 2 +fshttp: Fix error reporting on tpslimit token bucket errors (Nick +Craig\-Wood) +.IP \[bu] 2 +fshttp: Don\[cq]t print token bucket errors on context cancelled (Nick +Craig\-Wood) +.RE +.IP \[bu] 2 +Local +.RS 2 +.IP \[bu] 2 +Fix listings of . +on Windows (Nick Craig\-Wood) +.RE +.IP \[bu] 2 +Onedrive +.RS 2 +.IP \[bu] 2 +Fix DirMove/Move after Onedrive change (Xiaoxing Ye) +.RE .SS v1.50.0 \- 2019\-10\-26 .IP \[bu] 2 New backends @@ -22991,7 +29211,7 @@ Mail.ru Cloud (/mailru) (Ivan Andreev) New Features .RS 2 .IP \[bu] 2 -encodings (Fabian Möller & Nick Craig\-Wood) +encodings (Fabian M\[:o]ller & Nick Craig\-Wood) .RS 2 .IP \[bu] 2 All backends now use file name encoding to ensure any file name can be @@ -23045,7 +29265,7 @@ Add sample WebDAV server Docker Compose manifest. copyurl .RS 2 .IP \[bu] 2 -Add \f[C]\-\-auto\-filename\f[] flag for using file name from URL in +Add \f[C]\-\-auto\-filename\f[R] flag for using file name from URL in destination path (Denis) .RE .IP \[bu] 2 @@ -23070,14 +29290,14 @@ Bug Fixes sync .RS 2 .IP \[bu] 2 -Make \f[C]\-\-update\f[]/\f[C]\-u\f[] not transfer files that haven't -changed (Nick Craig\-Wood) +Make \f[C]\-\-update\f[R]/\f[C]\-u\f[R] not transfer files that +haven\[cq]t changed (Nick Craig\-Wood) .IP \[bu] 2 Free objects after they come out of the transfer pipe to save memory (Nick Craig\-Wood) .IP \[bu] 2 -Fix \f[C]\-\-files\-from\ without\ \-\-no\-traverse\f[] doing a -recursive scan (Nick Craig\-Wood) +Fix \f[C]\-\-files\-from without \-\-no\-traverse\f[R] doing a recursive +scan (Nick Craig\-Wood) .RE .IP \[bu] 2 operations @@ -23114,10 +29334,10 @@ cmd Fix environment variables not setting command line flags (Nick Craig\-Wood) .IP \[bu] 2 -Make autocomplete compatible with bash's posix mode for macOS (Danil +Make autocomplete compatible with bash\[cq]s posix mode for macOS (Danil Semelenov) .IP \[bu] 2 -Make \f[C]\-\-progress\f[] work in git bash on Windows (Nick +Make \f[C]\-\-progress\f[R] work in git bash on Windows (Nick Craig\-Wood) .IP \[bu] 2 Fix `compopt: command not found' on autocomplete on macOS (Danil @@ -23132,12 +29352,12 @@ Craig\-Wood) .IP \[bu] 2 Check config names more carefully and report errors (Nick Craig\-Wood) .IP \[bu] 2 -Remove error: can't use \f[C]\-\-size\-only\f[] and -\f[C]\-\-ignore\-size\f[] together. +Remove error: can\[cq]t use \f[C]\-\-size\-only\f[R] and +\f[C]\-\-ignore\-size\f[R] together. (Nick Craig\-Wood) .RE .IP \[bu] 2 -filter: Prevent mixing options when \f[C]\-\-files\-from\f[] is in use +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 @@ -23156,14 +29376,14 @@ Fix panic on File.Open (Nick Craig\-Wood) Fix \[lq]mount_fusefs: \-o timeout=: option not supported\[rq] on FreeBSD (Nick Craig\-Wood) .IP \[bu] 2 -Don't pass huge filenames (>4k) to FUSE as it can't cope (Nick +Don\[cq]t pass huge filenames (>4k) to FUSE as it can\[cq]t cope (Nick Craig\-Wood) .RE .IP \[bu] 2 VFS .RS 2 .IP \[bu] 2 -Add flag \f[C]\-\-vfs\-case\-insensitive\f[] for windows/macOS mounts +Add flag \f[C]\-\-vfs\-case\-insensitive\f[R] for windows/macOS mounts (Ivan Andreev) .IP \[bu] 2 Make objects of unknown size readable through the VFS (Nick Craig\-Wood) @@ -23187,7 +29407,7 @@ Disable logging to the Windows event log (Nick Craig\-Wood) B2 .RS 2 .IP \[bu] 2 -Remove \f[C]unverified:\f[] prefix on sha1 to improve interop (eg with +Remove \f[C]unverified:\f[R] prefix on sha1 to improve interop (eg with CyberDuck) (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -23205,8 +29425,8 @@ Craig\-Wood) .IP \[bu] 2 Make sure that drive root ID is always canonical (Nick Craig\-Wood) .IP \[bu] 2 -Fix \f[C]\-\-drive\-shared\-with\-me\f[] from the root with lsand -\f[C]\-\-fast\-list\f[] (Nick Craig\-Wood) +Fix \f[C]\-\-drive\-shared\-with\-me\f[R] from the root with lsand +\f[C]\-\-fast\-list\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Fix ChangeNotify polling for shared drives (Nick Craig\-Wood) .IP \[bu] 2 @@ -23238,7 +29458,7 @@ HTTP .IP \[bu] 2 HEAD directory entries in parallel to speedup (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-http\-no\-head\f[] to stop rclone doing HEAD in listings +Add \f[C]\-\-http\-no\-head\f[R] to stop rclone doing HEAD in listings (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -23260,7 +29480,7 @@ Only ask for URL encoded directory listings if we need them on Ceph .IP \[bu] 2 Add option for multipart failiure behaviour (Aleksandar Jankovic) .IP \[bu] 2 -Support for multipart copy (庄天翼) +Support for multipart copy (\[u5E84]\[u5929]\[u7FFC]) .IP \[bu] 2 Fix nil pointer reference if no metadata returned for object (Nick Craig\-Wood) @@ -23269,12 +29489,12 @@ Craig\-Wood) SFTP .RS 2 .IP \[bu] 2 -Fix \f[C]\-\-sftp\-ask\-password\f[] trying to contact the ssh agent +Fix \f[C]\-\-sftp\-ask\-password\f[R] trying to contact the ssh agent (Nick Craig\-Wood) .IP \[bu] 2 Fix hashes of files with backslashes (Nick Craig\-Wood) .IP \[bu] 2 -Include more ciphers with \f[C]\-\-sftp\-use\-insecure\-cipher\f[] +Include more ciphers with \f[C]\-\-sftp\-use\-insecure\-cipher\f[R] (Carlos Ferreyra) .RE .IP \[bu] 2 @@ -23346,11 +29566,11 @@ Bug Fixes .RS 2 .IP \[bu] 2 accounting: Fix locking in Transfer to avoid deadlock with -\f[C]\-\-progress\f[] (Nick Craig\-Wood) +\f[C]\-\-progress\f[R] (Nick Craig\-Wood) .IP \[bu] 2 docs: Fix template argument for mktemp in install.sh (Cnly) .IP \[bu] 2 -operations: Fix \f[C]\-u\f[]/\f[C]\-\-update\f[] with google photos / +operations: Fix \f[C]\-u\f[R]/\f[C]\-\-update\f[R] with google photos / files of unknown size (Nick Craig\-Wood) .IP \[bu] 2 rc: Fix docs for config/create /update /password (Nick Craig\-Wood) @@ -23403,24 +29623,24 @@ New Features .IP \[bu] 2 Experimental web GUI (https://rclone.org/gui/) (Chaitanya Bankanhal) .IP \[bu] 2 -Implement \f[C]\-\-compare\-dest\f[] & \f[C]\-\-copy\-dest\f[] +Implement \f[C]\-\-compare\-dest\f[R] & \f[C]\-\-copy\-dest\f[R] (yparitcher) .IP \[bu] 2 -Implement \f[C]\-\-suffix\f[] without \f[C]\-\-backup\-dir\f[] for +Implement \f[C]\-\-suffix\f[R] without \f[C]\-\-backup\-dir\f[R] for backup to current dir (yparitcher) .IP \[bu] 2 -\f[C]config\ reconnect\f[] to re\-login (re\-run the oauth login) for +\f[C]config reconnect\f[R] to re\-login (re\-run the oauth login) for the backend. (Nick Craig\-Wood) .IP \[bu] 2 -\f[C]config\ userinfo\f[] to discover which user you are logged in as. +\f[C]config userinfo\f[R] to discover which user you are logged in as. (Nick Craig\-Wood) .IP \[bu] 2 -\f[C]config\ disconnect\f[] to disconnect you (log out) from the +\f[C]config disconnect\f[R] to disconnect you (log out) from the backend. (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-use\-json\-log\f[] for JSON logging (justinalin) +Add \f[C]\-\-use\-json\-log\f[R] for JSON logging (justinalin) .IP \[bu] 2 Add context propagation to rclone (Aleksandar Jankovic) .IP \[bu] 2 @@ -23443,10 +29663,10 @@ operations: .IP \[bu] 2 Run hashing operations in parallel (Nick Craig\-Wood) .IP \[bu] 2 -Don't calculate checksums when using \f[C]\-\-ignore\-checksum\f[] (Nick -Craig\-Wood) +Don\[cq]t calculate checksums when using \f[C]\-\-ignore\-checksum\f[R] +(Nick Craig\-Wood) .IP \[bu] 2 -Check transfer hashes when using \f[C]\-\-size\-only\f[] mode (Nick +Check transfer hashes when using \f[C]\-\-size\-only\f[R] mode (Nick Craig\-Wood) .IP \[bu] 2 Disable multi thread copy for local to local copies (Nick Craig\-Wood) @@ -23471,7 +29691,7 @@ sharing (CORS) in the rcd. Add anchor tags to the docs so links are consistent (Nick Craig\-Wood) .IP \[bu] 2 Remove _async key from input parameters after parsing so later -operations won't get confused (buengese) +operations won\[cq]t get confused (buengese) .IP \[bu] 2 Add call to clear stats (Aleksandar Jankovic) .RE @@ -23481,7 +29701,7 @@ rcd .IP \[bu] 2 Auto\-login for web\-gui (Chaitanya Bankanhal) .IP \[bu] 2 -Implement \f[C]\-\-baseurl\f[] for rcd and web\-gui (Chaitanya +Implement \f[C]\-\-baseurl\f[R] for rcd and web\-gui (Chaitanya Bankanhal) .RE .IP \[bu] 2 @@ -23502,12 +29722,12 @@ serve ftp .IP \[bu] 2 Refactor to bring into line with other serve commands (Nick Craig\-Wood) .IP \[bu] 2 -Implement \f[C]\-\-auth\-proxy\f[] (Nick Craig\-Wood) +Implement \f[C]\-\-auth\-proxy\f[R] (Nick Craig\-Wood) .RE .IP \[bu] 2 -serve http: Implement \f[C]\-\-baseurl\f[] (Nick Craig\-Wood) +serve http: Implement \f[C]\-\-baseurl\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -serve restic: Implement \f[C]\-\-baseurl\f[] (Nick Craig\-Wood) +serve restic: Implement \f[C]\-\-baseurl\f[R] (Nick Craig\-Wood) .IP \[bu] 2 serve sftp .RS 2 @@ -23520,9 +29740,9 @@ Fix detection of whether server is authorized (Nick Craig\-Wood) serve webdav .RS 2 .IP \[bu] 2 -Implement \f[C]\-\-baseurl\f[] (Nick Craig\-Wood) +Implement \f[C]\-\-baseurl\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -Support \f[C]\-\-auth\-proxy\f[] (Nick Craig\-Wood) +Support \f[C]\-\-auth\-proxy\f[R] (Nick Craig\-Wood) .RE .RE .IP \[bu] 2 @@ -23534,7 +29754,7 @@ Make \[lq]bad record MAC\[rq] a retriable error (Nick Craig\-Wood) copyurl: Fix copying files that return HTTP errors (Nick Craig\-Wood) .IP \[bu] 2 march: Fix checking sub\-directories when using -\f[C]\-\-no\-traverse\f[] (buengese) +\f[C]\-\-no\-traverse\f[R] (buengese) .IP \[bu] 2 rc .RS 2 @@ -23545,7 +29765,7 @@ marshalability (Nick Craig\-Wood) Move job expire flags to rc to fix initalization problem (Nick Craig\-Wood) .IP \[bu] 2 -Fix \f[C]\-\-loopback\f[] with rc/list and others (Nick Craig\-Wood) +Fix \f[C]\-\-loopback\f[R] with rc/list and others (Nick Craig\-Wood) .RE .IP \[bu] 2 rcat: Fix slowdown on systems with multiple hashes (Nick Craig\-Wood) @@ -23557,7 +29777,7 @@ rcd: Fix permissions problems on cache directory with web gui download Mount .RS 2 .IP \[bu] 2 -Default \f[C]\-\-deamon\-timout\f[] to 15 minutes on macOS and FreeBSD +Default \f[C]\-\-deamon\-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 @@ -23571,22 +29791,22 @@ VFS .IP \[bu] 2 Make write without cache more efficient (Nick Craig\-Wood) .IP \[bu] 2 -Fix \f[C]\-\-vfs\-cache\-mode\ minimal\f[] and \f[C]writes\f[] ignoring +Fix \f[C]\-\-vfs\-cache\-mode minimal\f[R] and \f[C]writes\f[R] ignoring cached files (Nick Craig\-Wood) .RE .IP \[bu] 2 Local .RS 2 .IP \[bu] 2 -Add \f[C]\-\-local\-case\-sensitive\f[] and -\f[C]\-\-local\-case\-insensitive\f[] (Nick Craig\-Wood) +Add \f[C]\-\-local\-case\-sensitive\f[R] and +\f[C]\-\-local\-case\-insensitive\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Avoid polluting page cache when uploading local files to remote backends -(Michał Matczuk) +(Micha\[/l] Matczuk) .IP \[bu] 2 -Don't calculate any hashes by default (Nick Craig\-Wood) +Don\[cq]t calculate any hashes by default (Nick Craig\-Wood) .IP \[bu] 2 -Fadvise run syscall on a dedicated go routine (Michał Matczuk) +Fadvise run syscall on a dedicated go routine (Micha\[/l] Matczuk) .RE .IP \[bu] 2 Azure Blob @@ -23617,7 +29837,7 @@ Fix server side copy of big files (Nick Craig\-Wood) .IP \[bu] 2 Update API for teamdrive use (Nick Craig\-Wood) .IP \[bu] 2 -Add error for purge with \f[C]\-\-drive\-trashed\-only\f[] (ginvine) +Add error for purge with \f[C]\-\-drive\-trashed\-only\f[R] (ginvine) .RE .IP \[bu] 2 Fichier @@ -23637,7 +29857,7 @@ Make all operations work from the root (Nick Craig\-Wood) HTTP .RS 2 .IP \[bu] 2 -Add \f[C]\-\-http\-headers\f[] flag for setting arbitrary headers (Nick +Add \f[C]\-\-http\-headers\f[R] flag for setting arbitrary headers (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -23712,10 +29932,10 @@ Fix segments leak during failed large file uploads. WebDAV .RS 2 .IP \[bu] 2 -Add \f[C]\-\-webdav\-bearer\-token\-command\f[] (Nick Craig\-Wood) +Add \f[C]\-\-webdav\-bearer\-token\-command\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Refresh token when it expires with -\f[C]\-\-webdav\-bearer\-token\-command\f[] (Nick Craig\-Wood) +\f[C]\-\-webdav\-bearer\-token\-command\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Add docs for using bearer_token_command with oidc\-agent (Paul Millar) .RE @@ -23733,8 +29953,8 @@ New Features Multi threaded downloads to local storage (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 -controlled with \f[C]\-\-multi\-thread\-cutoff\f[] and -\f[C]\-\-multi\-thread\-streams\f[] +controlled with \f[C]\-\-multi\-thread\-cutoff\f[R] and +\f[C]\-\-multi\-thread\-streams\f[R] .RE .IP \[bu] 2 Use rclone.conf from rclone executable directory to enable portable use @@ -23746,11 +29966,11 @@ Allow sync of a file and a directory with the same name (forgems) this is common on bucket based remotes, eg s3, gcs .RE .IP \[bu] 2 -Add \f[C]\-\-ignore\-case\-sync\f[] for forced case insensitivity +Add \f[C]\-\-ignore\-case\-sync\f[R] for forced case insensitivity (garry415) .IP \[bu] 2 -Implement \f[C]\-\-stats\-one\-line\-date\f[] and -\f[C]\-\-stats\-one\-line\-date\-format\f[] (Peter Berbec) +Implement \f[C]\-\-stats\-one\-line\-date\f[R] and +\f[C]\-\-stats\-one\-line\-date\-format\f[R] (Peter Berbec) .IP \[bu] 2 Log an ERROR for all commands which exit with non\-zero status (Nick Craig\-Wood) @@ -23766,7 +29986,7 @@ build: Drop support for go1.8 (Nick Craig\-Wood) config: Make config create/update encrypt passwords where necessary (Nick Craig\-Wood) .IP \[bu] 2 -copyurl: Honor \f[C]\-\-no\-check\-certificate\f[] (Stefan Breunig) +copyurl: Honor \f[C]\-\-no\-check\-certificate\f[R] (Stefan Breunig) .IP \[bu] 2 install: Linux skip man pages if no mandb (didil) .IP \[bu] 2 @@ -23786,8 +30006,8 @@ Craig\-Wood) rc .RS 2 .IP \[bu] 2 -Add \f[C]\-\-loopback\f[] flag to run commands directly without a server -(Nick Craig\-Wood) +Add \f[C]\-\-loopback\f[R] flag to run commands directly without a +server (Nick Craig\-Wood) .IP \[bu] 2 Add operations/fsinfo: Return information about the remote (Nick Craig\-Wood) @@ -23802,11 +30022,11 @@ jobs: Make job expiry timeouts configurable (Aleksandar Jankovic) .IP \[bu] 2 serve dlna reworked and improved (Dan Walters) .IP \[bu] 2 -serve ftp: add \f[C]\-\-ftp\-public\-ip\f[] flag to specify public IP +serve ftp: add \f[C]\-\-ftp\-public\-ip\f[R] flag to specify public IP (calistri) .IP \[bu] 2 -serve restic: Add support for \f[C]\-\-private\-repos\f[] in -\f[C]serve\ restic\f[] (Florian Apolloner) +serve restic: Add support for \f[C]\-\-private\-repos\f[R] in +\f[C]serve restic\f[R] (Florian Apolloner) .IP \[bu] 2 serve webdav: Combine serve webdav and serve http (Gary Kim) .IP \[bu] 2 @@ -23816,15 +30036,15 @@ size: Ignore negative sizes when calculating total (Garry McNulty) Bug Fixes .RS 2 .IP \[bu] 2 -Make move and copy individual files obey \f[C]\-\-backup\-dir\f[] (Nick +Make move and copy individual files obey \f[C]\-\-backup\-dir\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -If \f[C]\-\-ignore\-checksum\f[] is in effect, don't calculate checksum -(Nick Craig\-Wood) +If \f[C]\-\-ignore\-checksum\f[R] is in effect, don\[cq]t calculate +checksum (Nick Craig\-Wood) .IP \[bu] 2 moveto: Fix case\-insensitive same remote move (Gary Kim) .IP \[bu] 2 -rc: Fix serving bucket based objects with \f[C]\-\-rc\-serve\f[] (Nick +rc: Fix serving bucket based objects with \f[C]\-\-rc\-serve\f[R] (Nick Craig\-Wood) .IP \[bu] 2 serve webdav: Fix serveDir not being updated with changes from webdav @@ -23884,10 +30104,10 @@ Fix move and copy from TeamDrive to GDrive (Fionera) 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[] to default back to -old server side copy semantics by default (Nick Craig\-Wood) +Add \f[C]\-\-drive\-server\-side\-across\-configs\f[R] to default back +to old server side copy semantics by default (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-drive\-size\-as\-quota\f[] to show storage quota usage for +Add \f[C]\-\-drive\-size\-as\-quota\f[R] to show storage quota usage for file size (Garry McNulty) .RE .IP \[bu] 2 @@ -23898,7 +30118,7 @@ Add FTP List timeout (Jeff Quinn) .IP \[bu] 2 Add FTP over TLS support (Gary Kim) .IP \[bu] 2 -Add \f[C]\-\-ftp\-no\-check\-certificate\f[] option for FTPS (Gary Kim) +Add \f[C]\-\-ftp\-no\-check\-certificate\f[R] option for FTPS (Gary Kim) .RE .IP \[bu] 2 Google Cloud Storage @@ -23930,9 +30150,9 @@ S3 .RS 2 .IP \[bu] 2 Suppport S3 Accelerated endpoints with -\f[C]\-\-s3\-use\-accelerate\-endpoint\f[] (Nick Craig\-Wood) +\f[C]\-\-s3\-use\-accelerate\-endpoint\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -Add config info for Wasabi's EU Central endpoint (Robert Marko) +Add config info for Wasabi\[cq]s EU Central endpoint (Robert Marko) .IP \[bu] 2 Make SetModTime work for GLACIER while syncing (Philip Harvey) .RE @@ -23942,7 +30162,7 @@ SFTP .IP \[bu] 2 Add About support (Gary Kim) .IP \[bu] 2 -Fix about parsing of \f[C]df\f[] results so it can cope with \-ve +Fix about parsing of \f[C]df\f[R] results so it can cope with \-ve results (Nick Craig\-Wood) .IP \[bu] 2 Send custom client version and debug server version (Nick Craig\-Wood) @@ -23973,41 +30193,41 @@ this means rclone will restart transfers if the source has an error this is most useful for downloads or cloud to cloud copies .RE .IP \[bu] 2 -Use \f[C]\-\-fast\-list\f[] for listing operations where it won't use -more memory (Nick Craig\-Wood) +Use \f[C]\-\-fast\-list\f[R] for listing operations where it won\[cq]t +use more memory (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 this should speed up the following operations on remotes which support -\f[C]ListR\f[] +\f[C]ListR\f[R] .IP \[bu] 2 -\f[C]dedupe\f[], \f[C]serve\ restic\f[] \f[C]lsf\f[], \f[C]ls\f[], -\f[C]lsl\f[], \f[C]lsjson\f[], \f[C]lsd\f[], \f[C]md5sum\f[], -\f[C]sha1sum\f[], \f[C]hashsum\f[], \f[C]size\f[], \f[C]delete\f[], -\f[C]cat\f[], \f[C]settier\f[] +\f[C]dedupe\f[R], \f[C]serve restic\f[R] \f[C]lsf\f[R], \f[C]ls\f[R], +\f[C]lsl\f[R], \f[C]lsjson\f[R], \f[C]lsd\f[R], \f[C]md5sum\f[R], +\f[C]sha1sum\f[R], \f[C]hashsum\f[R], \f[C]size\f[R], \f[C]delete\f[R], +\f[C]cat\f[R], \f[C]settier\f[R] .IP \[bu] 2 -use \f[C]\-\-disable\ ListR\f[] to get old behaviour if required +use \f[C]\-\-disable ListR\f[R] to get old behaviour if required .RE .IP \[bu] 2 -Make \f[C]\-\-files\-from\f[] traverse the destination unless -\f[C]\-\-no\-traverse\f[] is set (Nick Craig\-Wood) +Make \f[C]\-\-files\-from\f[R] traverse the destination unless +\f[C]\-\-no\-traverse\f[R] is set (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 -this fixes \f[C]\-\-files\-from\f[] with Google drive and excessive API +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[] +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[] flag and default to not +Add \f[C]\-\-create\-empty\-src\-dirs\f[R] flag and default to not creating empty dirs (ishuah) .IP \[bu] 2 Add client side TLS/SSL flags -\f[C]\-\-ca\-cert\f[]/\f[C]\-\-client\-cert\f[]/\f[C]\-\-client\-key\f[] +\f[C]\-\-ca\-cert\f[R]/\f[C]\-\-client\-cert\f[R]/\f[C]\-\-client\-key\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -Implement \f[C]\-\-suffix\-keep\-extension\f[] for use with -\f[C]\-\-suffix\f[] (Nick Craig\-Wood) +Implement \f[C]\-\-suffix\-keep\-extension\f[R] for use with +\f[C]\-\-suffix\f[R] (Nick Craig\-Wood) .IP \[bu] 2 build: .RS 2 @@ -24024,17 +30244,17 @@ compatibility (Dan Walters) lsf: Add `e' format to show encrypted names and `o' for original IDs (Nick Craig\-Wood) .IP \[bu] 2 -lsjson: Added \f[C]\-\-files\-only\f[] and \f[C]\-\-dirs\-only\f[] flags -(calistri) +lsjson: Added \f[C]\-\-files\-only\f[R] and \f[C]\-\-dirs\-only\f[R] +flags (calistri) .IP \[bu] 2 rc: Implement operations/publiclink the equivalent of -\f[C]rclone\ link\f[] (Nick Craig\-Wood) +\f[C]rclone link\f[R] (Nick Craig\-Wood) .RE .IP \[bu] 2 Bug Fixes .RS 2 .IP \[bu] 2 -accounting: Fix total ETA when \f[C]\-\-stats\-unit\ bits\f[] is in +accounting: Fix total ETA when \f[C]\-\-stats\-unit bits\f[R] is in effect (Nick Craig\-Wood) .IP \[bu] 2 Bash TAB completion @@ -24045,7 +30265,7 @@ Craig\-Wood) .IP \[bu] 2 Fix for remotes with underscores in their names (Six) .IP \[bu] 2 -Fix completion of remotes (Florian Gamböck) +Fix completion of remotes (Florian Gamb\[:o]ck) .IP \[bu] 2 Fix autocompletion of remote paths with spaces (Danil Semelenov) .RE @@ -24087,20 +30307,20 @@ Allow manual configuration of backblaze downloadUrl (Vince) .IP \[bu] 2 Ignore already_hidden error on remove (Nick Craig\-Wood) .IP \[bu] 2 -Ignore malformed \f[C]src_last_modified_millis\f[] (Nick Craig\-Wood) +Ignore malformed \f[C]src_last_modified_millis\f[R] (Nick Craig\-Wood) .RE .IP \[bu] 2 Drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-skip\-checksum\-gphotos\f[] to ignore incorrect checksums +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. (Fionera) .IP \[bu] 2 -Add docs on team drives and \f[C]\-\-fast\-list\f[] eventual consistency -(Nestar47) +Add docs on team drives and \f[C]\-\-fast\-list\f[R] eventual +consistency (Nestar47) .IP \[bu] 2 Fix imports of text files (Nick Craig\-Wood) .IP \[bu] 2 @@ -24118,8 +30338,8 @@ Retry blank errors to fix long listings (Nick Craig\-Wood) FTP .RS 2 .IP \[bu] 2 -Add \f[C]\-\-ftp\-concurrency\f[] to limit maximum number of connections -(Nick Craig\-Wood) +Add \f[C]\-\-ftp\-concurrency\f[R] to limit maximum number of +connections (Nick Craig\-Wood) .RE .IP \[bu] 2 Google Cloud Storage @@ -24133,7 +30353,7 @@ Allow bucket policy only buckets (Nick Craig\-Wood) HTTP .RS 2 .IP \[bu] 2 -Add \f[C]\-\-http\-no\-slash\f[] for websites with directories with no +Add \f[C]\-\-http\-no\-slash\f[R] for websites with directories with no slashes (Nick Craig\-Wood) .IP \[bu] 2 Remove duplicates from listings (Nick Craig\-Wood) @@ -24144,7 +30364,7 @@ Fix socket leak on 404 errors (Nick Craig\-Wood) Jottacloud .RS 2 .IP \[bu] 2 -Fix token refresh (Sebastian Bünger) +Fix token refresh (Sebastian B\[:u]nger) .IP \[bu] 2 Add device registration (Oliver Heyme) .RE @@ -24157,7 +30377,7 @@ Implement graceful cancel of multipart uploads if rclone is interrupted .IP \[bu] 2 Always add trailing colon to path when addressing items, (Cnly) .IP \[bu] 2 -Return errors instead of panic for invalid uploads (Fabian Möller) +Return errors instead of panic for invalid uploads (Fabian M\[:o]ller) .RE .IP \[bu] 2 S3 @@ -24212,7 +30432,7 @@ serve dlna: serves a remove via DLNA for the local network (nicolov) New Features .RS 2 .IP \[bu] 2 -copy, move: Restore deprecated \f[C]\-\-no\-traverse\f[] flag (Nick +copy, move: Restore deprecated \f[C]\-\-no\-traverse\f[R] flag (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 @@ -24231,12 +30451,12 @@ Buffer recycling library to replace sync.Pool .IP \[bu] 2 Optionally use memory mapped memory for better memory shrinking .IP \[bu] 2 -Enable with \f[C]\-\-use\-mmap\f[] if having memory problems \- not +Enable with \f[C]\-\-use\-mmap\f[R] if having memory problems \- not default yet .RE .IP \[bu] 2 -Parallelise reading of files specified by \f[C]\-\-files\-from\f[] (Nick -Craig\-Wood) +Parallelise reading of files specified by \f[C]\-\-files\-from\f[R] +(Nick Craig\-Wood) .IP \[bu] 2 check: Add stats showing total files matched. (Dario Guzik) @@ -24246,10 +30466,10 @@ Allow rename/delete open files under Windows (Nick Craig\-Wood) lsjson: Use exactly the correct number of decimal places in the seconds (Nick Craig\-Wood) .IP \[bu] 2 -Add cookie support with cmdline switch \f[C]\-\-use\-cookies\f[] for all -HTTP based remotes (qip) +Add cookie support with cmdline switch \f[C]\-\-use\-cookies\f[R] for +all HTTP based remotes (qip) .IP \[bu] 2 -Warn if \f[C]\-\-checksum\f[] is set but there are no hashes available +Warn if \f[C]\-\-checksum\f[R] is set but there are no hashes available (Nick Craig\-Wood) .IP \[bu] 2 Rework rate limiting (pacer) to be more accurate and allow bursting @@ -24258,8 +30478,8 @@ Rework rate limiting (pacer) to be more accurate and allow bursting Improve error reporting for too many/few arguments in commands (Nick Craig\-Wood) .IP \[bu] 2 -listremotes: Remove \f[C]\-l\f[] short flag as it conflicts with the new -global flag (weetmuts) +listremotes: Remove \f[C]\-l\f[R] short flag as it conflicts with the +new global flag (weetmuts) .IP \[bu] 2 Make http serving with auth generate INFO messages on auth fail (Nick Craig\-Wood) @@ -24270,19 +30490,20 @@ Bug Fixes .IP \[bu] 2 Fix layout of stats (Nick Craig\-Wood) .IP \[bu] 2 -Fix \f[C]\-\-progress\f[] crash under Windows Jenkins (Nick Craig\-Wood) +Fix \f[C]\-\-progress\f[R] crash under Windows Jenkins (Nick +Craig\-Wood) .IP \[bu] 2 Fix transfer of google/onedrive docs by calling Rcat in Copy when size is \-1 (Cnly) .IP \[bu] 2 -copyurl: Fix checking of \f[C]\-\-dry\-run\f[] (Denis Skovpen) +copyurl: Fix checking of \f[C]\-\-dry\-run\f[R] (Denis Skovpen) .RE .IP \[bu] 2 Mount .RS 2 .IP \[bu] 2 -Check that mountpoint and local directory to mount don't overlap (Nick -Craig\-Wood) +Check that mountpoint and local directory to mount don\[cq]t overlap +(Nick Craig\-Wood) .IP \[bu] 2 Fix mount size under 32 bit Windows (Nick Craig\-Wood) .RE @@ -24297,10 +30518,10 @@ Craig\-Wood) now all backends except b2 support renaming directories .RE .IP \[bu] 2 -Implement \f[C]\-\-vfs\-cache\-max\-size\f[] to limit the total size of +Implement \f[C]\-\-vfs\-cache\-max\-size\f[R] to limit the total size of the cache (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-dir\-perms\f[] and \f[C]\-\-file\-perms\f[] flags to set +Add \f[C]\-\-dir\-perms\f[R] and \f[C]\-\-file\-perms\f[R] flags to set default permissions (Nick Craig\-Wood) .IP \[bu] 2 Fix deadlock on concurrent operations on a directory (Nick Craig\-Wood) @@ -24311,23 +30532,23 @@ Craig\-Wood) Fix renaming/deleting open files with cache mode \[lq]writes\[rq] under Windows (Nick Craig\-Wood) .IP \[bu] 2 -Fix panic on rename with \f[C]\-\-dry\-run\f[] set (Nick Craig\-Wood) +Fix panic on rename with \f[C]\-\-dry\-run\f[R] set (Nick Craig\-Wood) .IP \[bu] 2 -Fix vfs/refresh with recurse=true needing the \f[C]\-\-fast\-list\f[] +Fix vfs/refresh with recurse=true needing the \f[C]\-\-fast\-list\f[R] flag .RE .IP \[bu] 2 Local .RS 2 .IP \[bu] 2 -Add support for \f[C]\-l\f[]/\f[C]\-\-links\f[] (symbolic link -translation) (yair\@unicorn) +Add support for \f[C]\-l\f[R]/\f[C]\-\-links\f[R] (symbolic link +translation) (yair\[at]unicorn) .RS 2 .IP \[bu] 2 -this works by showing links as \f[C]link.rclonelink\f[] \- see local +this works by showing links as \f[C]link.rclonelink\f[R] \- see local backend docs for more info .IP \[bu] 2 -this errors if used with \f[C]\-L\f[]/\f[C]\-\-copy\-links\f[] +this errors if used with \f[C]\-L\f[R]/\f[C]\-\-copy\-links\f[R] .RE .IP \[bu] 2 Fix renaming/deleting open files on Windows (Nick Craig\-Wood) @@ -24345,8 +30566,8 @@ Azure Blob .IP \[bu] 2 Allow building azureblob backend on *BSD (themylogin) .IP \[bu] 2 -Use the rclone HTTP client to support \f[C]\-\-dump\ headers\f[], -\f[C]\-\-tpslimit\f[] etc (Nick Craig\-Wood) +Use the rclone HTTP client to support \f[C]\-\-dump headers\f[R], +\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 @@ -24368,7 +30589,7 @@ before this, rclone would use the authorised bucket regardless of what you put on the command line .RE .IP \[bu] 2 -Added \f[C]\-\-b2\-disable\-checksum\f[] flag (Wojciech Smigielski) +Added \f[C]\-\-b2\-disable\-checksum\f[R] flag (Wojciech Smigielski) .RS 2 .IP \[bu] 2 this enables large files to be uploaded without a SHA\-1 hash for speed @@ -24385,17 +30606,17 @@ Set default pacer to 100ms for 10 tps (Nick Craig\-Wood) This fits the Google defaults much better and reduces the 403 errors massively .IP \[bu] 2 -Add \f[C]\-\-drive\-pacer\-min\-sleep\f[] and -\f[C]\-\-drive\-pacer\-burst\f[] to control the pacer +Add \f[C]\-\-drive\-pacer\-min\-sleep\f[R] and +\f[C]\-\-drive\-pacer\-burst\f[R] to control the pacer .RE .IP \[bu] 2 Improve ChangeNotify support for items with multiple parents (Fabian -Möller) +M\[:o]ller) .IP \[bu] 2 Fix ListR for items with multiple parents \- this fixes oddities with -\f[C]vfs/refresh\f[] (Fabian Möller) +\f[C]vfs/refresh\f[R] (Fabian M\[:o]ller) .IP \[bu] 2 -Fix using \f[C]\-\-drive\-impersonate\f[] and appfolders (Nick +Fix using \f[C]\-\-drive\-impersonate\f[R] and appfolders (Nick Craig\-Wood) .IP \[bu] 2 Fix google docs in rclone mount for some (not all) applications (Nick @@ -24428,10 +30649,10 @@ Update google cloud storage endpoints (weetmuts) HTTP .RS 2 .IP \[bu] 2 -Add an example with username and password which is supported but wasn't -documented (Nick Craig\-Wood) +Add an example with username and password which is supported but +wasn\[cq]t documented (Nick Craig\-Wood) .IP \[bu] 2 -Fix backend with \f[C]\-\-files\-from\f[] and non\-existent files (Nick +Fix backend with \f[C]\-\-files\-from\f[R] and non\-existent files (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -24447,10 +30668,10 @@ Jottacloud .IP \[bu] 2 Resume and deduplication support (Oliver Heyme) .IP \[bu] 2 -Use token auth for all API requests Don't store password anymore -(Sebastian Bünger) +Use token auth for all API requests Don\[cq]t store password anymore +(Sebastian B\[:u]nger) .IP \[bu] 2 -Add support for 2\-factor authentification (Sebastian Bünger) +Add support for 2\-factor authentification (Sebastian B\[:u]nger) .RE .IP \[bu] 2 Mega @@ -24482,27 +30703,27 @@ Fix go routine leak on multipart upload errors (Nick Craig\-Wood) .IP \[bu] 2 Add upload chunk size/concurrency/cutoff control (Nick Craig\-Wood) .IP \[bu] 2 -Default \f[C]\-\-qingstor\-upload\-concurrency\f[] to 1 to work around +Default \f[C]\-\-qingstor\-upload\-concurrency\f[R] to 1 to work around bug (Nick Craig\-Wood) .RE .IP \[bu] 2 S3 .RS 2 .IP \[bu] 2 -Implement \f[C]\-\-s3\-upload\-cutoff\f[] for single part uploads below +Implement \f[C]\-\-s3\-upload\-cutoff\f[R] for single part uploads below this (Nick Craig\-Wood) .IP \[bu] 2 -Change \f[C]\-\-s3\-upload\-concurrency\f[] default to 4 to increase +Change \f[C]\-\-s3\-upload\-concurrency\f[R] default to 4 to increase perfomance (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-s3\-bucket\-acl\f[] to control bucket ACL (Nick +Add \f[C]\-\-s3\-bucket\-acl\f[R] to control bucket ACL (Nick Craig\-Wood) .IP \[bu] 2 Auto detect region for buckets on operation failure (Nick Craig\-Wood) .IP \[bu] 2 Add GLACIER storage class (William Cocker) .IP \[bu] 2 -Add Scaleway to s3 documentation (Rémy Léone) +Add Scaleway to s3 documentation (R\['e]my L\['e]one) .IP \[bu] 2 Add AWS endpoint eu\-north\-1 (weetmuts) .RE @@ -24510,11 +30731,11 @@ Add AWS endpoint eu\-north\-1 (weetmuts) SFTP .RS 2 .IP \[bu] 2 -Add support for PEM encrypted private keys (Fabian Möller) +Add support for PEM encrypted private keys (Fabian M\[:o]ller) .IP \[bu] 2 -Add option to force the usage of an ssh\-agent (Fabian Möller) +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öller) +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) .IP \[bu] 2 @@ -24527,7 +30748,7 @@ Fix error on dangling symlinks (Nick Craig\-Wood) Swift .RS 2 .IP \[bu] 2 -Add \f[C]\-\-swift\-no\-chunk\f[] to disable segmented uploads in +Add \f[C]\-\-swift\-no\-chunk\f[R] to disable segmented uploads in rcat/mount (Nick Craig\-Wood) .IP \[bu] 2 Introduce application credential auth support (kayrus) @@ -24572,7 +30793,7 @@ New backends .RS 2 .IP \[bu] 2 The Yandex backend was re\-written \- see below for details (Sebastian -Bünger) +B\[:u]nger) .RE .IP \[bu] 2 New commands @@ -24589,7 +30810,7 @@ over rclone (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 sensitive operations require authorization or the -\f[C]\-\-rc\-no\-auth\f[] flag +\f[C]\-\-rc\-no\-auth\f[R] flag .IP \[bu] 2 config/* operations to configure rclone .IP \[bu] 2 @@ -24599,7 +30820,7 @@ operations/* for all low level operations, eg copy file, list directory .IP \[bu] 2 sync/* for sync, copy and move .IP \[bu] 2 -\f[C]\-\-rc\-files\f[] flag to serve files on the rc http server +\f[C]\-\-rc\-files\f[R] flag to serve files on the rc http server .RS 2 .IP \[bu] 2 this is for building web native GUIs for rclone @@ -24607,7 +30828,7 @@ this is for building web native GUIs for rclone .IP \[bu] 2 Optionally serving objects on the rc http server .IP \[bu] 2 -Ensure rclone fails to start up if the \f[C]\-\-rc\f[] port is in use +Ensure rclone fails to start up if the \f[C]\-\-rc\f[R] port is in use already .IP \[bu] 2 See the rc docs (https://rclone.org/rc/) for more info @@ -24616,25 +30837,25 @@ See the rc docs (https://rclone.org/rc/) for more info sync/copy/move .RS 2 .IP \[bu] 2 -Make \f[C]\-\-files\-from\f[] only read the objects specified and don't -scan directories (Nick Craig\-Wood) +Make \f[C]\-\-files\-from\f[R] only read the objects specified and +don\[cq]t scan directories (Nick Craig\-Wood) .RS 2 .IP \[bu] 2 This is a huge speed improvement for destinations with lots of files .RE .RE .IP \[bu] 2 -filter: Add \f[C]\-\-ignore\-case\f[] flag (Nick Craig\-Wood) +filter: Add \f[C]\-\-ignore\-case\f[R] flag (Nick Craig\-Wood) .IP \[bu] 2 ncdu: Add remove function (`d' key) (Henning Surmeier) .IP \[bu] 2 rc command .RS 2 .IP \[bu] 2 -Add \f[C]\-\-json\f[] flag for structured JSON input (Nick Craig\-Wood) +Add \f[C]\-\-json\f[R] flag for structured JSON input (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-user\f[] and \f[C]\-\-pass\f[] flags and interpret -\f[C]\-\-rc\-user\f[], \f[C]\-\-rc\-pass\f[], \f[C]\-\-rc\-addr\f[] +Add \f[C]\-\-user\f[R] and \f[C]\-\-pass\f[R] flags and interpret +\f[C]\-\-rc\-user\f[R], \f[C]\-\-rc\-pass\f[R], \f[C]\-\-rc\-addr\f[R] (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -24653,7 +30874,7 @@ retries (Nick Craig\-Wood) Bug Fixes .RS 2 .IP \[bu] 2 -cmd: Make \f[C]\-\-progress\f[] update the stats correctly at the end +cmd: Make \f[C]\-\-progress\f[R] update the stats correctly at the end (Nick Craig\-Wood) .IP \[bu] 2 config: Create config directory on save if it is missing (Nick @@ -24661,7 +30882,7 @@ Craig\-Wood) .IP \[bu] 2 dedupe: Check for existing filename before renaming a dupe file (ssaqua) .IP \[bu] 2 -move: Don't create directories with \f[C]\-\-dry\-run\f[] (Nick +move: Don\[cq]t create directories with \f[C]\-\-dry\-run\f[R] (Nick Craig\-Wood) .IP \[bu] 2 operations: Fix Purge and Rmdirs when dir is not the root (Nick @@ -24674,7 +30895,7 @@ serve http/webdav/restic: Ensure rclone exits if the port is in use Mount .RS 2 .IP \[bu] 2 -Make \f[C]\-\-volname\f[] work for Windows and macOS (Nick Craig\-Wood) +Make \f[C]\-\-volname\f[R] work for Windows and macOS (Nick Craig\-Wood) .RE .IP \[bu] 2 Azure Blob @@ -24698,13 +30919,13 @@ Add dropbox impersonate support (Jake Coggiano) Jottacloud .RS 2 .IP \[bu] 2 -Fix bug in \f[C]\-\-fast\-list\f[] handing of empty folders (albertony) +Fix bug in \f[C]\-\-fast\-list\f[R] handing of empty folders (albertony) .RE .IP \[bu] 2 Opendrive .RS 2 .IP \[bu] 2 -Fix transfer of files with \f[C]+\f[] and \f[C]&\f[] in (Nick +Fix transfer of files with \f[C]+\f[R] and \f[C]&\f[R] in (Nick Craig\-Wood) .IP \[bu] 2 Fix retries of upload chunks (Nick Craig\-Wood) @@ -24718,7 +30939,7 @@ Craig\-Wood) .IP \[bu] 2 Fix role_arn, credential_source, \&... (Erik Swanson) .IP \[bu] 2 -Add config info for Wasabi's US\-West endpoint (Henry Ptasinski) +Add config info for Wasabi\[cq]s US\-West endpoint (Henry Ptasinski) .RE .IP \[bu] 2 SFTP @@ -24738,8 +30959,8 @@ WebDAV .IP \[bu] 2 Add Content\-Type to PUT requests (Nick Craig\-Wood) .IP \[bu] 2 -Fix config parsing so \f[C]\-\-webdav\-user\f[] and -\f[C]\-\-webdav\-pass\f[] flags work (Nick Craig\-Wood) +Fix config parsing so \f[C]\-\-webdav\-user\f[R] and +\f[C]\-\-webdav\-pass\f[R] flags work (Nick Craig\-Wood) .IP \[bu] 2 Add RFC3339 date format (Ralf Hemberger) .RE @@ -24747,17 +30968,18 @@ Add RFC3339 date format (Ralf Hemberger) Yandex .RS 2 .IP \[bu] 2 -The yandex backend was re\-written (Sebastian Bünger) +The yandex backend was re\-written (Sebastian B\[:u]nger) .RS 2 .IP \[bu] 2 -This implements low level retries (Sebastian Bünger) +This implements low level retries (Sebastian B\[:u]nger) .IP \[bu] 2 Copy, Move, DirMove, PublicLink and About optional interfaces (Sebastian -Bünger) +B\[:u]nger) .IP \[bu] 2 -Improved general error handling (Sebastian Bünger) +Improved general error handling (Sebastian B\[:u]nger) .IP \[bu] 2 -Removed ListR for now due to inconsistent behaviour (Sebastian Bünger) +Removed ListR for now due to inconsistent behaviour (Sebastian +B\[:u]nger) .RE .RE .SS v1.44 \- 2018\-10\-15 @@ -24787,12 +31009,12 @@ Show URL of backend help page when starting config (Nick Craig\-Wood) .IP \[bu] 2 stats: Long names now split in center (Joanna Marek) .IP \[bu] 2 -Add \f[C]\-\-log\-format\f[] flag for more control over log output +Add \f[C]\-\-log\-format\f[R] flag for more control over log output (dcpu) .IP \[bu] 2 rc: Add support for OPTIONS and basic CORS (frenos) .IP \[bu] 2 -stats: show FatalErrors and NoRetryErrors in stats (Cédric Connes) +stats: show FatalErrors and NoRetryErrors in stats (C\['e]dric Connes) .RE .IP \[bu] 2 Bug Fixes @@ -24800,11 +31022,11 @@ Bug Fixes .IP \[bu] 2 Fix \-P not ending with a new line (Nick Craig\-Wood) .IP \[bu] 2 -config: don't create default config dir when user supplies -\f[C]\-\-config\f[] (albertony) +config: don\[cq]t create default config dir when user supplies +\f[C]\-\-config\f[R] (albertony) .IP \[bu] 2 -Don't print non\-ASCII characters with \f[C]\-\-progress\f[] on windows -(Nick Craig\-Wood) +Don\[cq]t print non\-ASCII characters with \f[C]\-\-progress\f[R] on +windows (Nick Craig\-Wood) .IP \[bu] 2 Correct logs for excluded items (ssaqua) .RE @@ -24820,12 +31042,12 @@ VFS .IP \[bu] 2 Fix race condition detected by serve ftp tests (Nick Craig\-Wood) .IP \[bu] 2 -Add vfs/poll\-interval rc command (Fabian Möller) +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 (Nick Craig\-Wood) .IP \[bu] 2 -Reduce directory cache cleared by poll\-interval (Fabian Möller) +Reduce directory cache cleared by poll\-interval (Fabian M\[:o]ller) .IP \[bu] 2 Remove EXPERIMENTAL tags (Nick Craig\-Wood) .RE @@ -24833,7 +31055,7 @@ Remove EXPERIMENTAL tags (Nick Craig\-Wood) Local .RS 2 .IP \[bu] 2 -Skip bad symlinks in dir listing with \-L enabled (Cédric Connes) +Skip bad symlinks in dir listing with \-L enabled (C\['e]dric Connes) .IP \[bu] 2 Preallocate files on Windows to reduce fragmentation (Nick Craig\-Wood) .IP \[bu] 2 @@ -24843,20 +31065,21 @@ Preallocate files on linux with fallocate(2) (Nick Craig\-Wood) Cache .RS 2 .IP \[bu] 2 -Add cache/fetch rc function (Fabian Möller) +Add cache/fetch rc function (Fabian M\[:o]ller) .IP \[bu] 2 -Fix worker scale down (Fabian Möller) +Fix worker scale down (Fabian M\[:o]ller) .IP \[bu] 2 Improve performance by not sending info requests for cached chunks (dcpu) .IP \[bu] 2 -Fix error return value of cache/fetch rc method (Fabian Möller) +Fix error return value of cache/fetch rc method (Fabian M\[:o]ller) .IP \[bu] 2 Documentation fix for cache\-chunk\-total\-size (Anagh Kumar Baranwal) .IP \[bu] 2 -Preserve leading / in wrapped remote path (Fabian Möller) +Preserve leading / in wrapped remote path (Fabian M\[:o]ller) .IP \[bu] 2 -Add plex_insecure option to skip certificate validation (Fabian Möller) +Add plex_insecure option to skip certificate validation (Fabian +M\[:o]ller) .IP \[bu] 2 Remove entries that no longer exist in the source (dcpu) .RE @@ -24864,7 +31087,7 @@ Remove entries that no longer exist in the source (dcpu) Crypt .RS 2 .IP \[bu] 2 -Preserve leading / in wrapped remote path (Fabian Möller) +Preserve leading / in wrapped remote path (Fabian M\[:o]ller) .RE .IP \[bu] 2 Alias @@ -24876,7 +31099,8 @@ Fix handling of Windows network paths (Nick Craig\-Wood) Azure Blob .RS 2 .IP \[bu] 2 -Add \f[C]\-\-azureblob\-list\-chunk\f[] parameter (Santiago Rodríguez) +Add \f[C]\-\-azureblob\-list\-chunk\f[R] parameter (Santiago +Rodr\['i]guez) .IP \[bu] 2 Implemented settier command support on azureblob remote. (sandeepkru) @@ -24889,31 +31113,31 @@ Box .RS 2 .IP \[bu] 2 Implement link sharing. -(Sebastian Bünger) +(Sebastian B\[:u]nger) .RE .IP \[bu] 2 Drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-drive\-import\-formats\f[] \- google docs can now be -imported (Fabian Möller) +Add \f[C]\-\-drive\-import\-formats\f[R] \- google docs can now be +imported (Fabian M\[:o]ller) .RS 2 .IP \[bu] 2 -Rewrite mime type and extension handling (Fabian Möller) +Rewrite mime type and extension handling (Fabian M\[:o]ller) .IP \[bu] 2 -Add document links (Fabian Möller) +Add document links (Fabian M\[:o]ller) .IP \[bu] 2 -Add support for multipart document extensions (Fabian Möller) +Add support for multipart document extensions (Fabian M\[:o]ller) .IP \[bu] 2 -Add support for apps\-script to json export (Fabian Möller) +Add support for apps\-script to json export (Fabian M\[:o]ller) .IP \[bu] 2 -Fix escaped chars in documents during list (Fabian Möller) +Fix escaped chars in documents during list (Fabian M\[:o]ller) .RE .IP \[bu] 2 -Add \f[C]\-\-drive\-v2\-download\-min\-size\f[] a workaround for slow -downloads (Fabian Möller) +Add \f[C]\-\-drive\-v2\-download\-min\-size\f[R] a workaround for slow +downloads (Fabian M\[:o]ller) .IP \[bu] 2 -Improve directory notifications in ChangeNotify (Fabian Möller) +Improve directory notifications in ChangeNotify (Fabian M\[:o]ller) .IP \[bu] 2 When listing team drives in config, continue on failure (Nick Craig\-Wood) @@ -24929,7 +31153,7 @@ Craig\-Wood) Google Cloud Storage .RS 2 .IP \[bu] 2 -Fix service_account_file being ignored (Fabian Möller) +Fix service_account_file being ignored (Fabian M\[:o]ller) .RE .IP \[bu] 2 Jottacloud @@ -24937,15 +31161,15 @@ Jottacloud .IP \[bu] 2 Minor improvement in quota info (omit if unlimited) (albertony) .IP \[bu] 2 -Add \f[C]\-\-fast\-list\f[] support (albertony) +Add \f[C]\-\-fast\-list\f[R] support (albertony) .IP \[bu] 2 -Add permanent delete support: \f[C]\-\-jottacloud\-hard\-delete\f[] +Add permanent delete support: \f[C]\-\-jottacloud\-hard\-delete\f[R] (albertony) .IP \[bu] 2 Add link sharing support (albertony) .IP \[bu] 2 Fix handling of reserved characters. -(Sebastian Bünger) +(Sebastian B\[:u]nger) .IP \[bu] 2 Fix socket leak on Object.Remove (Nick Craig\-Wood) .RE @@ -24956,7 +31180,7 @@ Onedrive Rework to support Microsoft Graph (Cnly) .RS 2 .IP \[bu] 2 -\f[B]NB\f[] this will require re\-authenticating the remote +\f[B]NB\f[R] this will require re\-authenticating the remote .RE .IP \[bu] 2 Removed upload cutoff and always do session uploads (Oliver Heyme) @@ -24980,7 +31204,7 @@ Use custom pacer, to retry operations when reasonable (Craig Miskell) Use configured server\-side\-encryption and storace class options when calling CopyObject() (Paul Kohout) .IP \[bu] 2 -Make \f[C]\-\-s3\-v2\-auth\f[] flag (Nick Craig\-Wood) +Make \f[C]\-\-s3\-v2\-auth\f[R] flag (Nick Craig\-Wood) .IP \[bu] 2 Fix v2 auth on files with spaces (Nick Craig\-Wood) .RE @@ -24994,9 +31218,9 @@ Brucker) Implement optional interfaces (Move, DirMove, Copy etc) (Nick Craig\-Wood) .IP \[bu] 2 -Fix ChangeNotify to support multiple remotes (Fabian Möller) +Fix ChangeNotify to support multiple remotes (Fabian M\[:o]ller) .IP \[bu] 2 -Fix \f[C]\-\-backup\-dir\f[] on union backend (Nick Craig\-Wood) +Fix \f[C]\-\-backup\-dir\f[R] on union backend (Nick Craig\-Wood) .RE .IP \[bu] 2 WebDAV @@ -25024,9 +31248,9 @@ Point release to fix hubic and azureblob backends. Bug Fixes .RS 2 .IP \[bu] 2 -ncdu: Return error instead of log.Fatal in Show (Fabian Möller) +ncdu: Return error instead of log.Fatal in Show (Fabian M\[:o]ller) .IP \[bu] 2 -cmd: Fix crash with \f[C]\-\-progress\f[] and \f[C]\-\-stats\ 0\f[] +cmd: Fix crash with \f[C]\-\-progress\f[R] and \f[C]\-\-stats 0\f[R] (Nick Craig\-Wood) .IP \[bu] 2 docs: Tidy website display (Anagh Kumar Baranwal) @@ -25052,7 +31276,7 @@ Craig\-Wood) New backends .RS 2 .IP \[bu] 2 -Jottacloud (Sebastian Bünger) +Jottacloud (Sebastian B\[:u]nger) .RE .IP \[bu] 2 New commands @@ -25080,21 +31304,21 @@ Allow on the fly remotes with :backend: syntax Stats revamp .RS 2 .IP \[bu] 2 -Add \f[C]\-\-progress\f[]/\f[C]\-P\f[] flag to show interactive progress -(Nick Craig\-Wood) +Add \f[C]\-\-progress\f[R]/\f[C]\-P\f[R] flag to show interactive +progress (Nick Craig\-Wood) .IP \[bu] 2 Show the total progress of the sync in the stats (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-stats\-one\-line\f[] flag for single line stats (Nick +Add \f[C]\-\-stats\-one\-line\f[R] flag for single line stats (Nick Craig\-Wood) .RE .IP \[bu] 2 -Added weekday schedule into \f[C]\-\-bwlimit\f[] (Mateusz) +Added weekday schedule into \f[C]\-\-bwlimit\f[R] (Mateusz) .IP \[bu] 2 -lsjson: Add option to show the original object IDs (Fabian Möller) +lsjson: Add option to show the original object IDs (Fabian M\[:o]ller) .IP \[bu] 2 serve webdav: Make Content\-Type without reading the file and add -\f[C]\-\-etag\-hash\f[] (Nick Craig\-Wood) +\f[C]\-\-etag\-hash\f[R] (Nick Craig\-Wood) .IP \[bu] 2 build .RS 2 @@ -25110,7 +31334,7 @@ rc Added core/stats to return the stats (reddi1) .RE .IP \[bu] 2 -\f[C]version\ \-\-check\f[]: Prints the current release and beta +\f[C]version \-\-check\f[R]: Prints the current release and beta versions (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -25127,40 +31351,41 @@ Fix moving average speed for file stats (Nick Craig\-Wood) .IP \[bu] 2 config: Fix error reading password from piped input (Nick Craig\-Wood) .IP \[bu] 2 -move: Fix \f[C]\-\-delete\-empty\-src\-dirs\f[] flag to delete all empty -dirs on move (ishuah) +move: Fix \f[C]\-\-delete\-empty\-src\-dirs\f[R] flag to delete all +empty dirs on move (ishuah) .RE .IP \[bu] 2 Mount .RS 2 .IP \[bu] 2 -Implement \f[C]\-\-daemon\-timeout\f[] flag for OSXFUSE (Nick +Implement \f[C]\-\-daemon\-timeout\f[R] flag for OSXFUSE (Nick Craig\-Wood) .IP \[bu] 2 -Fix mount \f[C]\-\-daemon\f[] not working with encrypted config (Alex +Fix mount \f[C]\-\-daemon\f[R] not working with encrypted config (Alex Chen) .IP \[bu] 2 -Clip the number of blocks to 2^32\-1 on macOS \- fixes borg backup (Nick -Craig\-Wood) +Clip the number of blocks to 2\[ha]32\-1 on macOS \- fixes borg backup +(Nick Craig\-Wood) .RE .IP \[bu] 2 VFS .RS 2 .IP \[bu] 2 -Enable vfs\-read\-chunk\-size by default (Fabian Möller) +Enable vfs\-read\-chunk\-size by default (Fabian M\[:o]ller) .IP \[bu] 2 -Add the vfs/refresh rc command (Fabian Möller) +Add the vfs/refresh rc command (Fabian M\[:o]ller) .IP \[bu] 2 -Add non recursive mode to vfs/refresh rc command (Fabian Möller) +Add non recursive mode to vfs/refresh rc command (Fabian M\[:o]ller) .IP \[bu] 2 -Try to seek buffer on read only files (Fabian Möller) +Try to seek buffer on read only files (Fabian M\[:o]ller) .RE .IP \[bu] 2 Local .RS 2 .IP \[bu] 2 -Fix crash when deprecated \f[C]\-\-local\-no\-unicode\-normalization\f[] -is supplied (Nick Craig\-Wood) +Fix crash when deprecated +\f[C]\-\-local\-no\-unicode\-normalization\f[R] is supplied (Nick +Craig\-Wood) .IP \[bu] 2 Fix mkdir error when trying to copy files to the root of a drive on windows (Nick Craig\-Wood) @@ -25217,18 +31442,19 @@ Box .IP \[bu] 2 Fix upload of > 2GB files on 32 bit platforms (Nick Craig\-Wood) .IP \[bu] 2 -Make \f[C]\-\-box\-commit\-retries\f[] flag defaulting to 100 to fix +Make \f[C]\-\-box\-commit\-retries\f[R] flag defaulting to 100 to fix large uploads (Nick Craig\-Wood) .RE .IP \[bu] 2 Drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-drive\-keep\-revision\-forever\f[] flag (lewapm) +Add \f[C]\-\-drive\-keep\-revision\-forever\f[R] flag (lewapm) .IP \[bu] 2 -Handle gdocs when filtering file names in list (Fabian Möller) +Handle gdocs when filtering file names in list (Fabian M\[:o]ller) .IP \[bu] 2 -Support using \f[C]\-\-fast\-list\f[] for large speedups (Fabian Möller) +Support using \f[C]\-\-fast\-list\f[R] for large speedups (Fabian +M\[:o]ller) .RE .IP \[bu] 2 FTP @@ -25240,7 +31466,7 @@ Fix Put mkParentDir failed: 521 for BunnyCDN (Nick Craig\-Wood) Google Cloud Storage .RS 2 .IP \[bu] 2 -Fix index out of range error with \f[C]\-\-fast\-list\f[] (Nick +Fix index out of range error with \f[C]\-\-fast\-list\f[R] (Nick Craig\-Wood) .RE .IP \[bu] 2 @@ -25256,10 +31482,10 @@ Calculate missing MD5s (Oliver Heyme) Docs, fixes and tests for MD5 calculation (Nick Craig\-Wood) .IP \[bu] 2 Add optional MimeTyper interface. -(Sebastian Bünger) +(Sebastian B\[:u]nger) .IP \[bu] 2 -Implement optional About interface (for \f[C]df\f[] support). -(Sebastian Bünger) +Implement optional About interface (for \f[C]df\f[R] support). +(Sebastian B\[:u]nger) .RE .IP \[bu] 2 Mega @@ -25267,7 +31493,7 @@ Mega .IP \[bu] 2 Wait for events instead of arbitrary sleeping (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-mega\-hard\-delete\f[] flag (Nick Craig\-Wood) +Add \f[C]\-\-mega\-hard\-delete\f[R] flag (Nick Craig\-Wood) .IP \[bu] 2 Fix failed logins with upper case chars in email (Nick Craig\-Wood) .RE @@ -25298,10 +31524,10 @@ Remove leading / from paths (Nick Craig\-Wood) S3 .RS 2 .IP \[bu] 2 -Fix index out of range error with \f[C]\-\-fast\-list\f[] (Nick +Fix index out of range error with \f[C]\-\-fast\-list\f[R] (Nick Craig\-Wood) .IP \[bu] 2 -Add \f[C]\-\-s3\-force\-path\-style\f[] (Nick Craig\-Wood) +Add \f[C]\-\-s3\-force\-path\-style\f[R] (Nick Craig\-Wood) .IP \[bu] 2 Add support for KMS Key ID (bsteiss) .IP \[bu] 2 @@ -25311,9 +31537,9 @@ Remove leading / from paths (Nick Craig\-Wood) Swift .RS 2 .IP \[bu] 2 -Add \f[C]storage_policy\f[] (Ruben Vandamme) +Add \f[C]storage_policy\f[R] (Ruben Vandamme) .IP \[bu] 2 -Make it so just \f[C]storage_url\f[] or \f[C]auth_token\f[] can be +Make it so just \f[C]storage_url\f[R] or \f[C]auth_token\f[R] can be overidden (Nick Craig\-Wood) .IP \[bu] 2 Fix server side copy bug for unusal file names (Nick Craig\-Wood) @@ -25327,9 +31553,10 @@ WebDAV Ensure we call MKCOL with a URL with a trailing / for QNAP interop (Nick Craig\-Wood) .IP \[bu] 2 -If root ends with / then don't check if it is a file (Nick Craig\-Wood) +If root ends with / then don\[cq]t check if it is a file (Nick +Craig\-Wood) .IP \[bu] 2 -Don't accept redirects when reading metadata (Nick Craig\-Wood) +Don\[cq]t accept redirects when reading metadata (Nick Craig\-Wood) .IP \[bu] 2 Add bearer token (Macaroon) support for dCache (Nick Craig\-Wood) .IP \[bu] 2 @@ -25362,23 +31589,23 @@ deletefile command (Filip Bartodziej) New Features .RS 2 .IP \[bu] 2 -copy, move: Copy single files directly, don't use -\f[C]\-\-files\-from\f[] work\-around +copy, move: Copy single files directly, don\[cq]t use +\f[C]\-\-files\-from\f[R] work\-around .RS 2 .IP \[bu] 2 this makes them much more efficient .RE .IP \[bu] 2 -Implement \f[C]\-\-max\-transfer\f[] flag to quit transferring at a +Implement \f[C]\-\-max\-transfer\f[R] flag to quit transferring at a limit .RS 2 .IP \[bu] 2 -make exit code 8 for \f[C]\-\-max\-transfer\f[] exceeded +make exit code 8 for \f[C]\-\-max\-transfer\f[R] exceeded .RE .IP \[bu] 2 copy: copy empty source directories to destination (Ishuah Kariuki) .IP \[bu] 2 -check: Add \f[C]\-\-one\-way\f[] flag (Kasper Byrdal Nielsen) +check: Add \f[C]\-\-one\-way\f[R] flag (Kasper Byrdal Nielsen) .IP \[bu] 2 Add siginfo handler for macOS for ctrl\-T stats (kubatasiemski) .IP \[bu] 2 @@ -25387,7 +31614,7 @@ rc .IP \[bu] 2 add core/gc to run a garbage collection on demand .IP \[bu] 2 -enable go profiling by default on the \f[C]\-\-rc\f[] port +enable go profiling by default on the \f[C]\-\-rc\f[R] port .IP \[bu] 2 return error from remote on failure .RE @@ -25395,9 +31622,9 @@ return error from remote on failure lsf .RS 2 .IP \[bu] 2 -Add \f[C]\-\-absolute\f[] flag to add a leading / onto path names +Add \f[C]\-\-absolute\f[R] flag to add a leading / onto path names .IP \[bu] 2 -Add \f[C]\-\-csv\f[] flag for compliant CSV output +Add \f[C]\-\-csv\f[R] flag for compliant CSV output .IP \[bu] 2 Add `m' format specifier to show the MimeType .IP \[bu] 2 @@ -25412,7 +31639,7 @@ Add MimeType to the output Add ID field to output to show Object ID .RE .IP \[bu] 2 -Add \f[C]\-\-retries\-sleep\f[] flag (Benjamin Joseph Dag) +Add \f[C]\-\-retries\-sleep\f[R] flag (Benjamin Joseph Dag) .IP \[bu] 2 Oauth tidy up web page and error handling (Henning Surmeier) .RE @@ -25420,8 +31647,8 @@ Oauth tidy up web page and error handling (Henning Surmeier) Bug Fixes .RS 2 .IP \[bu] 2 -Password prompt output with \f[C]\-\-log\-file\f[] fixed for unix (Filip -Bartodziej) +Password prompt output with \f[C]\-\-log\-file\f[R] fixed for unix +(Filip Bartodziej) .IP \[bu] 2 Calculate ModifyWindow each time on the fly to fix various problems (Stefan Breunig) @@ -25441,23 +31668,23 @@ Ensure atexit gets run on interrupt macOS enhancements .RS 2 .IP \[bu] 2 -Make \f[C]\-\-noappledouble\f[] \f[C]\-\-noapplexattr\f[] +Make \f[C]\-\-noappledouble\f[R] \f[C]\-\-noapplexattr\f[R] .IP \[bu] 2 -Add \f[C]\-\-volname\f[] flag and remove special chars from it +Add \f[C]\-\-volname\f[R] flag and remove special chars from it .IP \[bu] 2 Make Get/List/Set/Remove xattr return ENOSYS for efficiency .IP \[bu] 2 -Make \f[C]\-\-daemon\f[] work for macOS without CGO +Make \f[C]\-\-daemon\f[R] work for macOS without CGO .RE .RE .IP \[bu] 2 VFS .RS 2 .IP \[bu] 2 -Add \f[C]\-\-vfs\-read\-chunk\-size\f[] and -\f[C]\-\-vfs\-read\-chunk\-size\-limit\f[] (Fabian Möller) +Add \f[C]\-\-vfs\-read\-chunk\-size\f[R] and +\f[C]\-\-vfs\-read\-chunk\-size\-limit\f[R] (Fabian M\[:o]ller) .IP \[bu] 2 -Fix ChangeNotify for new or changed folders (Fabian Möller) +Fix ChangeNotify for new or changed folders (Fabian M\[:o]ller) .RE .IP \[bu] 2 Local @@ -25466,7 +31693,7 @@ Local Fix symlink/junction point directory handling under Windows .RS 2 .IP \[bu] 2 -\f[B]NB\f[] you will need to add \f[C]\-L\f[] to your command line to +\f[B]NB\f[R] you will need to add \f[C]\-L\f[R] to your command line to copy files with reparse points .RE .RE @@ -25500,8 +31727,8 @@ Check the crypted hash of files when uploading for extra data security Dropbox .RS 2 .IP \[bu] 2 -Make Dropbox for business folders accessible using an initial \f[C]/\f[] -in the path +Make Dropbox for business folders accessible using an initial +\f[C]/\f[R] in the path .RE .IP \[bu] 2 Google Cloud Storage @@ -25513,15 +31740,15 @@ Low level retry all operations if necessary Google Drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-drive\-acknowledge\-abuse\f[] to download flagged files +Add \f[C]\-\-drive\-acknowledge\-abuse\f[R] to download flagged files .IP \[bu] 2 -Add \f[C]\-\-drive\-alternate\-export\f[] to fix large doc export +Add \f[C]\-\-drive\-alternate\-export\f[R] to fix large doc export .IP \[bu] 2 -Don't attempt to choose Team Drives when using rclone config create +Don\[cq]t attempt to choose Team Drives when using rclone config create .IP \[bu] 2 Fix change list polling with team drives .IP \[bu] 2 -Fix ChangeNotify for folders (Fabian Möller) +Fix ChangeNotify for folders (Fabian M\[:o]ller) .IP \[bu] 2 Fix about (and df on a mount) for team drives .RE @@ -25535,16 +31762,16 @@ Errorhandler for onedrive for business requests (Henning Surmeier) S3 .RS 2 .IP \[bu] 2 -Adjust upload concurrency with \f[C]\-\-s3\-upload\-concurrency\f[] +Adjust upload concurrency with \f[C]\-\-s3\-upload\-concurrency\f[R] (themylogin) .IP \[bu] 2 -Fix \f[C]\-\-s3\-chunk\-size\f[] which was always using the minimum +Fix \f[C]\-\-s3\-chunk\-size\f[R] which was always using the minimum .RE .IP \[bu] 2 SFTP .RS 2 .IP \[bu] 2 -Add \f[C]\-\-ssh\-path\-override\f[] flag (Piotr Oleszczyk) +Add \f[C]\-\-ssh\-path\-override\f[R] flag (Piotr Oleszczyk) .IP \[bu] 2 Fix slow downloads for long latency connections .RE @@ -25617,7 +31844,7 @@ Drop support for go1.6 Release .RS 2 .IP \[bu] 2 -Fix \f[C]make\ tarball\f[] (Chih\-Hsuan Yen) +Fix \f[C]make tarball\f[R] (Chih\-Hsuan Yen) .RE .IP \[bu] 2 Bug Fixes @@ -25637,9 +31864,10 @@ rc: take note of the \[en]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[]) +Use About to return the correct disk total/used/free (eg in +\f[C]df\f[R]) .IP \[bu] 2 -Set \f[C]\-\-attr\-timeout\ default\f[] to \f[C]1s\f[] \- fixes: +Set \f[C]\-\-attr\-timeout default\f[R] to \f[C]1s\f[R] \- fixes: .RS 2 .IP \[bu] 2 rclone using too much memory @@ -25649,13 +31877,13 @@ rclone not serving files to samba excessive time listing directories .RE .IP \[bu] 2 -Fix \f[C]df\ \-i\f[] (upstream fix) +Fix \f[C]df \-i\f[R] (upstream fix) .RE .IP \[bu] 2 VFS .RS 2 .IP \[bu] 2 -Filter files \f[C]\&.\f[] and \f[C]\&..\f[] from directory listing +Filter files \f[C].\f[R] and \f[C]..\f[R] from directory listing .IP \[bu] 2 Only make the VFS cache if \[en]vfs\-cache\-mode > Off .RE @@ -25735,7 +31963,7 @@ path (Stefan Breunig) HTTP .RS 2 .IP \[bu] 2 -Fix sync for servers which don't return Content\-Length in HEAD +Fix sync for servers which don\[cq]t return Content\-Length in HEAD .RE .IP \[bu] 2 Onedrive @@ -25751,7 +31979,7 @@ S3 .IP \[bu] 2 Look in S3 named profile files for credentials .IP \[bu] 2 -Add \f[C]\-\-s3\-disable\-checksum\f[] to disable checksum uploading +Add \f[C]\-\-s3\-disable\-checksum\f[R] to disable checksum uploading (Chris Redekop) .IP \[bu] 2 Hierarchical configuration support (Giri Badanahatti) @@ -25798,13 +32026,13 @@ New backends .RS 2 .IP \[bu] 2 Alias backend to create aliases for existing remote names (Fabian -Möller) +M\[:o]ller) .RE .IP \[bu] 2 New commands .RS 2 .IP \[bu] 2 -\f[C]lsf\f[]: list for parsing purposes (Jakub Tasiemski) +\f[C]lsf\f[R]: list for parsing purposes (Jakub Tasiemski) .RS 2 .IP \[bu] 2 by default this is a simple non recursive list of files and directories @@ -25812,7 +32040,7 @@ by default this is a simple non recursive list of files and directories it can be configured to add more info in an easy to parse way .RE .IP \[bu] 2 -\f[C]serve\ restic\f[]: for serving a remote as a Restic REST endpoint +\f[C]serve restic\f[R]: for serving a remote as a Restic REST endpoint .RS 2 .IP \[bu] 2 This enables restic to use any backends that rclone can access @@ -25820,7 +32048,7 @@ This enables restic to use any backends that rclone can access Thanks Alexander Neumann for help, patches and review .RE .IP \[bu] 2 -\f[C]rc\f[]: enable the remote control of a running rclone +\f[C]rc\f[R]: enable the remote control of a running rclone .RS 2 .IP \[bu] 2 The running rclone must be started with \[en]rc and related flags. @@ -25833,15 +32061,16 @@ cache. New Features .RS 2 .IP \[bu] 2 -\f[C]\-\-max\-delete\f[] flag to add a delete threshold (Bjørn Erik +\f[C]\-\-max\-delete\f[R] flag to add a delete threshold (Bj\[/o]rn Erik Pedersen) .IP \[bu] 2 All backends now support RangeOption for ranged Open .RS 2 .IP \[bu] 2 -\f[C]cat\f[]: Use RangeOption for limited fetches to make more efficient +\f[C]cat\f[R]: Use RangeOption for limited fetches to make more +efficient .IP \[bu] 2 -\f[C]cryptcheck\f[]: make reading of nonce more efficient with +\f[C]cryptcheck\f[R]: make reading of nonce more efficient with RangeOption .RE .IP \[bu] 2 @@ -25850,20 +32079,20 @@ serve http/webdav/restic .IP \[bu] 2 support SSL/TLS .IP \[bu] 2 -add \f[C]\-\-user\f[] \f[C]\-\-pass\f[] and \f[C]\-\-htpasswd\f[] for +add \f[C]\-\-user\f[R] \f[C]\-\-pass\f[R] and \f[C]\-\-htpasswd\f[R] for authentication .RE .IP \[bu] 2 -\f[C]copy\f[]/\f[C]move\f[]: detect file size change during copy/move +\f[C]copy\f[R]/\f[C]move\f[R]: detect file size change during copy/move and abort transfer (ishuah) .IP \[bu] 2 -\f[C]cryptdecode\f[]: added option to return encrypted file names. +\f[C]cryptdecode\f[R]: added option to return encrypted file names. (ishuah) .IP \[bu] 2 -\f[C]lsjson\f[]: add \f[C]\-\-encrypted\f[] to show encrypted name +\f[C]lsjson\f[R]: add \f[C]\-\-encrypted\f[R] to show encrypted name (Jakub Tasiemski) .IP \[bu] 2 -Add \f[C]\-\-stats\-file\-name\-length\f[] to specify the printed file +Add \f[C]\-\-stats\-file\-name\-length\f[R] to specify the printed file name length for stats (Will Gunn) .RE .IP \[bu] 2 @@ -25907,29 +32136,29 @@ on first access .IP \[bu] 2 config: retry saving the config after failure (Mateusz) .IP \[bu] 2 -sync: when using \f[C]\-\-backup\-dir\f[] don't delete files if we can't -set their modtime +sync: when using \f[C]\-\-backup\-dir\f[R] don\[cq]t delete files if we +can\[cq]t set their modtime .RS 2 .IP \[bu] 2 -this fixes odd behaviour with Dropbox and \f[C]\-\-backup\-dir\f[] +this fixes odd behaviour with Dropbox and \f[C]\-\-backup\-dir\f[R] .RE .IP \[bu] 2 fshttp: fix idle timeouts for HTTP connections .IP \[bu] 2 -\f[C]serve\ http\f[]: fix serving files with : in \- fixes +\f[C]serve http\f[R]: fix serving files with : in \- fixes .IP \[bu] 2 -Fix \f[C]\-\-exclude\-if\-present\f[] to ignore directories which it -doesn't have permission for (Iakov Davydov) +Fix \f[C]\-\-exclude\-if\-present\f[R] to ignore directories which it +doesn\[cq]t have permission for (Iakov Davydov) .IP \[bu] 2 Make accounting work properly with crypt and b2 .IP \[bu] 2 -remove \f[C]\-\-no\-traverse\f[] flag because it is obsolete +remove \f[C]\-\-no\-traverse\f[R] flag because it is obsolete .RE .IP \[bu] 2 Mount .RS 2 .IP \[bu] 2 -Add \f[C]\-\-attr\-timeout\f[] flag to control attribute caching in +Add \f[C]\-\-attr\-timeout\f[R] flag to control attribute caching in kernel .RS 2 .IP \[bu] 2 @@ -25939,7 +32168,7 @@ see the mount docs (/commands/rclone_mount/#attribute-caching) for more info .RE .IP \[bu] 2 -Add \f[C]\-\-daemon\f[] flag to allow mount to run in the background +Add \f[C]\-\-daemon\f[R] flag to allow mount to run in the background (ishuah) .IP \[bu] 2 Fix: Return ENOSYS rather than EIO on attempted link @@ -25958,14 +32187,14 @@ Many bugs fixed in the VFS layer \- see below VFS .RS 2 .IP \[bu] 2 -Many fixes for \f[C]\-\-vfs\-cache\-mode\f[] writes and above +Many fixes for \f[C]\-\-vfs\-cache\-mode\f[R] writes and above .RS 2 .IP \[bu] 2 Update cached copy if we know it has changed (fixes stale data) .IP \[bu] 2 Clean path names before using them in the cache .IP \[bu] 2 -Disable cache cleaner if \f[C]\-\-vfs\-cache\-poll\-interval=0\f[] +Disable cache cleaner if \f[C]\-\-vfs\-cache\-poll\-interval=0\f[R] .IP \[bu] 2 Fill and clean the cache immediately on startup .RE @@ -26005,7 +32234,7 @@ Reduce log level for Plex api .IP \[bu] 2 Fix dir cache issue .IP \[bu] 2 -Implement \f[C]\-\-cache\-db\-wait\-time\f[] flag +Implement \f[C]\-\-cache\-db\-wait\-time\f[R] flag .IP \[bu] 2 Improve efficiency with RangeOption and RangeSeek .IP \[bu] 2 @@ -26029,7 +32258,7 @@ Implement DirChangeNotify to notify cache/vfs/mount of changes Azureblob .RS 2 .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26041,7 +32270,7 @@ Improve accounting for chunked uploads Backblaze B2 .RS 2 .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26063,7 +32292,7 @@ Fix custom oauth client parameters Google Cloud Storage .RS 2 .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26073,17 +32302,17 @@ this makes rclone do one less request per invocation Google Drive .RS 2 .IP \[bu] 2 -Migrate to api v3 (Fabian Möller) +Migrate to api v3 (Fabian M\[:o]ller) .IP \[bu] 2 Add scope configuration and root folder selection .IP \[bu] 2 -Add \f[C]\-\-drive\-impersonate\f[] for service accounts +Add \f[C]\-\-drive\-impersonate\f[R] for service accounts .RS 2 .IP \[bu] 2 thanks to everyone who tested, explored and contributed docs .RE .IP \[bu] 2 -Add \f[C]\-\-drive\-use\-created\-date\f[] to use created date as +Add \f[C]\-\-drive\-use\-created\-date\f[R] to use created date as modified date (nbuchanan) .IP \[bu] 2 Request the export formats only when required @@ -26096,7 +32325,7 @@ Fix finding paths with latin1 chars (a workaround for a drive bug) .IP \[bu] 2 Fix copying of a single Google doc file .IP \[bu] 2 -Fix \f[C]\-\-drive\-auth\-owner\-only\f[] to look in all directories +Fix \f[C]\-\-drive\-auth\-owner\-only\f[R] to look in all directories .RE .IP \[bu] 2 HTTP @@ -26131,7 +32360,7 @@ Remove unused chunked upload flag and code Qingstor .RS 2 .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26147,7 +32376,7 @@ Initial support for IBM COS (S3) (Giri Badanahatti) .IP \[bu] 2 Update docs to discourage use of v2 auth with CEPH and others .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26161,11 +32390,11 @@ SFTP .IP \[bu] 2 Add option to disable remote hash check command execution (Jon Fautley) .IP \[bu] 2 -Add \f[C]\-\-sftp\-ask\-password\f[] flag to prompt for password when +Add \f[C]\-\-sftp\-ask\-password\f[R] flag to prompt for password when needed (Leo R. Lundgren) .IP \[bu] 2 -Add \f[C]set_modtime\f[] configuration option +Add \f[C]set_modtime\f[R] configuration option .IP \[bu] 2 Fix following of symlinks .IP \[bu] 2 @@ -26187,7 +32416,7 @@ in v1.39 a bug was introduced which ignored new tokens \- this fixes it .IP \[bu] 2 Fix extra HEAD transaction when uploading a new file .IP \[bu] 2 -Don't check for bucket/container presense if listing was OK +Don\[cq]t check for bucket/container presense if listing was OK .RS 2 .IP \[bu] 2 this makes rclone do one less request per invocation @@ -26304,7 +32533,7 @@ this requires caching files on the disk (see \[en]cache\-dir) As this is a new feature, use with care .RE .IP \[bu] 2 -Use sdnotify to signal systemd the mount is ready (Fabian Möller) +Use sdnotify to signal systemd the mount is ready (Fabian M\[:o]ller) .IP \[bu] 2 Check if directory is not empty before mounting (Ernest Borowski) .RE @@ -26399,7 +32628,7 @@ crypt .IP \[bu] 2 Option to encrypt directory names or leave them intact .IP \[bu] 2 -Implement DirChangeNotify (Fabian Möller) +Implement DirChangeNotify (Fabian M\[:o]ller) .RE .IP \[bu] 2 onedrive @@ -26425,42 +32654,43 @@ QingStor from QingCloud (thanks wuyu) New commands .RS 2 .IP \[bu] 2 -\f[C]rcat\f[] \- read from standard input and stream upload +\f[C]rcat\f[R] \- read from standard input and stream upload .IP \[bu] 2 -\f[C]tree\f[] \- shows a nicely formatted recursive listing +\f[C]tree\f[R] \- shows a nicely formatted recursive listing .IP \[bu] 2 -\f[C]cryptdecode\f[] \- decode crypted file names (thanks ishuah) +\f[C]cryptdecode\f[R] \- decode crypted file names (thanks ishuah) .IP \[bu] 2 -\f[C]config\ show\f[] \- print the config file +\f[C]config show\f[R] \- print the config file .IP \[bu] 2 -\f[C]config\ file\f[] \- print the config file location +\f[C]config file\f[R] \- print the config file location .RE .IP \[bu] 2 New Features .RS 2 .IP \[bu] 2 -Empty directories are deleted on \f[C]sync\f[] +Empty directories are deleted on \f[C]sync\f[R] .IP \[bu] 2 -\f[C]dedupe\f[] \- implement merging of duplicate directories +\f[C]dedupe\f[R] \- implement merging of duplicate directories .IP \[bu] 2 -\f[C]check\f[] and \f[C]cryptcheck\f[] made more consistent and use less -memory +\f[C]check\f[R] and \f[C]cryptcheck\f[R] made more consistent and use +less memory .IP \[bu] 2 -\f[C]cleanup\f[] for remaining remotes (thanks ishuah) +\f[C]cleanup\f[R] for remaining remotes (thanks ishuah) .IP \[bu] 2 -\f[C]\-\-immutable\f[] for ensuring that files don't change (thanks +\f[C]\-\-immutable\f[R] for ensuring that files don\[cq]t change (thanks Jacob McNamee) .IP \[bu] 2 -\f[C]\-\-user\-agent\f[] option (thanks Alex McGrath Kraak) +\f[C]\-\-user\-agent\f[R] option (thanks Alex McGrath Kraak) .IP \[bu] 2 -\f[C]\-\-disable\f[] flag to disable optional features +\f[C]\-\-disable\f[R] flag to disable optional features .IP \[bu] 2 -\f[C]\-\-bind\f[] flag for choosing the local addr on outgoing +\f[C]\-\-bind\f[R] flag for choosing the local addr on outgoing connections .IP \[bu] 2 Support for zsh auto\-completion (thanks bpicode) .IP \[bu] 2 -Stop normalizing file names but do a normalized compare in \f[C]sync\f[] +Stop normalizing file names but do a normalized compare in +\f[C]sync\f[R] .RE .IP \[bu] 2 Compile @@ -26476,11 +32706,11 @@ Bug Fixes .IP \[bu] 2 Improve retriable error detection which makes multipart uploads better .IP \[bu] 2 -Make \f[C]check\f[] obey \f[C]\-\-ignore\-size\f[] +Make \f[C]check\f[R] obey \f[C]\-\-ignore\-size\f[R] .IP \[bu] 2 Fix bwlimit toggle in conjunction with schedules (thanks cbruegg) .IP \[bu] 2 -\f[C]config\f[] ensures newly written config is on the same mount +\f[C]config\f[R] ensures newly written config is on the same mount .RE .IP \[bu] 2 Local @@ -26488,20 +32718,20 @@ Local .IP \[bu] 2 Revert to copy when moving file across file system boundaries .IP \[bu] 2 -\f[C]\-\-skip\-links\f[] to suppress symlink warnings (thanks Zhiming +\f[C]\-\-skip\-links\f[R] to suppress symlink warnings (thanks Zhiming Wang) .RE .IP \[bu] 2 Mount .RS 2 .IP \[bu] 2 -Re\-use \f[C]rcat\f[] internals to support uploads from all remotes +Re\-use \f[C]rcat\f[R] internals to support uploads from all remotes .RE .IP \[bu] 2 Dropbox .RS 2 .IP \[bu] 2 -Fix \[lq]entry doesn't belong in directory\[rq] error +Fix \[lq]entry doesn\[cq]t belong in directory\[rq] error .IP \[bu] 2 Stop using deprecated API methods .RE @@ -26509,13 +32739,13 @@ Stop using deprecated API methods Swift .RS 2 .IP \[bu] 2 -Fix server side copy to empty container with \f[C]\-\-fast\-list\f[] +Fix server side copy to empty container with \f[C]\-\-fast\-list\f[R] .RE .IP \[bu] 2 Google Drive .RS 2 .IP \[bu] 2 -Change the default for \f[C]\-\-drive\-use\-trash\f[] to \f[C]true\f[] +Change the default for \f[C]\-\-drive\-use\-trash\f[R] to \f[C]true\f[R] .RE .IP \[bu] 2 S3 @@ -26535,14 +32765,14 @@ Fix SHA1 mismatch when downloading files with no SHA1 .IP \[bu] 2 Calculate missing hashes on the fly instead of spooling .IP \[bu] 2 -\f[C]\-\-b2\-hard\-delete\f[] to permanently delete (not hide) files +\f[C]\-\-b2\-hard\-delete\f[R] to permanently delete (not hide) files (thanks John Papandriopoulos) .RE .IP \[bu] 2 Hubic .RS 2 .IP \[bu] 2 -Fix creating containers \- no longer have to use the \f[C]default\f[] +Fix creating containers \- no longer have to use the \f[C]default\f[R] container .RE .IP \[bu] 2 @@ -26551,7 +32781,7 @@ Swift .IP \[bu] 2 Optionally configure from a standard set of OpenStack environment vars .IP \[bu] 2 -Add \f[C]endpoint_type\f[] config +Add \f[C]endpoint_type\f[R] config .RE .IP \[bu] 2 Google Cloud Storage @@ -26568,7 +32798,7 @@ Implement connection pooling for multiple ssh connections Limit new connections per second .IP \[bu] 2 Add support for MD5 and SHA1 hashes where available (thanks Christian -Brüggemann) +Br\[:u]ggemann) .RE .IP \[bu] 2 HTTP @@ -26576,7 +32806,7 @@ HTTP .IP \[bu] 2 Fix URL encoding issues .IP \[bu] 2 -Fix directories with \f[C]:\f[] in +Fix directories with \f[C]:\f[R] in .IP \[bu] 2 Fix panic with URL encoded content .RE @@ -26625,7 +32855,7 @@ Add \[en]tpslimit and \[en]tpslimit\-burst to limit transactions per second .RS 2 .IP \[bu] 2 -this is useful in conjuction with \f[C]rclone\ mount\f[] to limit +this is useful in conjuction with \f[C]rclone mount\f[R] to limit external apps .RE .IP \[bu] 2 @@ -26643,7 +32873,7 @@ allow auth_url and token_url to be set in the config file Print redirection URI if using own credentials. .RE .IP \[bu] 2 -Don't Mkdir at the start of sync to save transactions +Don\[cq]t Mkdir at the start of sync to save transactions .RE .IP \[bu] 2 Compile @@ -26663,7 +32893,7 @@ Fix menu selection when no remotes .IP \[bu] 2 Config saving reworked to not kill the file if disk gets full .IP \[bu] 2 -Don't delete remote if name does not change while renaming +Don\[cq]t delete remote if name does not change while renaming .IP \[bu] 2 moveto, copyto: report transfers and checks as per move and copy .RE @@ -26682,8 +32912,8 @@ Zissimopoulos for much help .IP \[bu] 2 Compare checksums on upload/download via FUSE .IP \[bu] 2 -Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM \- Jérôme -Vizcaino +Unmount when program ends with SIGINT (Ctrl+C) or SIGTERM \- +J\['e]r\[^o]me Vizcaino .IP \[bu] 2 On read only open of file, make open pending until first read .IP \[bu] 2 @@ -26740,7 +32970,7 @@ Add missing seek to start on retries of chunked uploads .IP \[bu] 2 Fix stats accounting for upload .IP \[bu] 2 -Convert / in names to a unicode equivalent (／) +Convert / in names to a unicode equivalent (\[uFF0F]) .IP \[bu] 2 Poll for Google Drive changes when mounted .RE @@ -26793,7 +33023,7 @@ Can only set by uploading the file again .IP \[bu] 2 If you uploaded with an old rclone, rclone may upload everything again .IP \[bu] 2 -Use \f[C]\-\-size\-only\f[] or \f[C]\-\-checksum\f[] to avoid this +Use \f[C]\-\-size\-only\f[R] or \f[C]\-\-checksum\f[R] to avoid this .RE .IP \[bu] 2 Now supports the Dropbox content hashing scheme @@ -26862,7 +33092,7 @@ syslog on capable platforms .IP \[bu] 2 Implement \[en]backup\-dir and \[en]suffix .IP \[bu] 2 -Implement \[en]track\-renames (initial implementation by Bjørn Erik +Implement \[en]track\-renames (initial implementation by Bj\[/o]rn Erik Pedersen) .IP \[bu] 2 Add time\-based bandwidth limits (Lukas Loesche) @@ -26889,8 +33119,8 @@ too .IP \[bu] 2 rclone config: allow rename and copy of remotes .IP \[bu] 2 -rclone obscure: for generating encrypted passwords for rclone's config -(T.C. +rclone obscure: for generating encrypted passwords for rclone\[cq]s +config (T.C. Ferguson) .IP \[bu] 2 Comply with XDG Base Directory specification (Dario Giovannetti) @@ -26915,7 +33145,7 @@ Bug Fixes .RS 2 .IP \[bu] 2 Fix copyto copying things to the wrong place if the destination dir -didn't exist +didn\[cq]t exist .IP \[bu] 2 Fix parsing of remotes in moveto and copyto .IP \[bu] 2 @@ -26923,7 +33153,7 @@ Fix \[en]delete\-before deleting files on copy .IP \[bu] 2 Fix \[en]files\-from with an empty file copying everything .IP \[bu] 2 -Fix sync: don't update mod times if \[en]dry\-run set +Fix sync: don\[cq]t update mod times if \[en]dry\-run set .IP \[bu] 2 Fix MimeType propagation .IP \[bu] 2 @@ -26964,7 +33194,7 @@ Add \[en]crypt\-show\-mapping to show encrypted file mapping Fix crypt writer getting stuck in a loop .RS 2 .IP \[bu] 2 -\f[B]IMPORTANT\f[] this bug had the potential to cause data corruption +\f[B]IMPORTANT\f[R] this bug had the potential to cause data corruption when .RS 2 .IP \[bu] 2 @@ -27008,7 +33238,7 @@ Fix \[lq]Ignoring unknown object\[rq] when downloading .IP \[bu] 2 Add \[en]drive\-list\-chunk .IP \[bu] 2 -Add \[en]drive\-skip\-gdocs (Károly Oláh) +Add \[en]drive\-skip\-gdocs (K\['a]roly Ol\['a]h) .RE .IP \[bu] 2 OneDrive @@ -27068,7 +33298,7 @@ Allow repeated \[en]include/\[en]exclude/\[en]filter options Only show transfer stats on commands which transfer stuff .RS 2 .IP \[bu] 2 -show stats on any command using the \f[C]\-\-stats\f[] flag +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 @@ -27086,7 +33316,7 @@ Make rclone lsd obey the filters properly .IP \[bu] 2 Fix compilation on mips .IP \[bu] 2 -Fix not transferring files that don't differ in size +Fix not transferring files that don\[cq]t differ in size .IP \[bu] 2 Fix panic on nil retry/fatal error .RE @@ -27157,7 +33387,7 @@ Create destination directory on Move() New Features .RS 2 .IP \[bu] 2 -Stop single file and \f[C]\-\-files\-from\f[] operations iterating +Stop single file and \f[C]\-\-files\-from\f[R] operations iterating through the source bucket. .IP \[bu] 2 Stop removing failed upload to cloud storage remotes @@ -27167,13 +33397,14 @@ Make ContentType be preserved for cloud to cloud copies Add support to toggle bandwidth limits via SIGUSR2 \- thanks Marco Paganini .IP \[bu] 2 -\f[C]rclone\ check\f[] shows count of hashes that couldn't be checked +\f[C]rclone check\f[R] shows count of hashes that couldn\[cq]t be +checked .IP \[bu] 2 -\f[C]rclone\ listremotes\f[] command +\f[C]rclone listremotes\f[R] command .IP \[bu] 2 Support linux/arm64 build \- thanks Fredrik Fornwall .IP \[bu] 2 -Remove \f[C]Authorization:\f[] lines from \f[C]\-\-dump\-headers\f[] +Remove \f[C]Authorization:\f[R] lines from \f[C]\-\-dump\-headers\f[R] output .RE .IP \[bu] 2 @@ -27182,7 +33413,7 @@ Bug Fixes .IP \[bu] 2 Ignore files with control characters in the names .IP \[bu] 2 -Fix \f[C]rclone\ move\f[] command +Fix \f[C]rclone move\f[R] command .RS 2 .IP \[bu] 2 Delete src files which already existed in dst @@ -27190,37 +33421,37 @@ Delete src files which already existed in dst Fix deletion of src file when dst file older .RE .IP \[bu] 2 -Fix \f[C]rclone\ check\f[] on crypted file systems +Fix \f[C]rclone check\f[R] on crypted file systems .IP \[bu] 2 Make failed uploads not count as \[lq]Transferred\[rq] .IP \[bu] 2 -Make sure high level retries show with \f[C]\-q\f[] +Make sure high level retries show with \f[C]\-q\f[R] .IP \[bu] 2 Use a vendor directory with godep for repeatable builds .RE .IP \[bu] 2 -\f[C]rclone\ mount\f[] \- FUSE +\f[C]rclone mount\f[R] \- FUSE .RS 2 .IP \[bu] 2 Implement FUSE mount options .RS 2 .IP \[bu] 2 -\f[C]\-\-no\-modtime\f[], \f[C]\-\-debug\-fuse\f[], -\f[C]\-\-read\-only\f[], \f[C]\-\-allow\-non\-empty\f[], -\f[C]\-\-allow\-root\f[], \f[C]\-\-allow\-other\f[] +\f[C]\-\-no\-modtime\f[R], \f[C]\-\-debug\-fuse\f[R], +\f[C]\-\-read\-only\f[R], \f[C]\-\-allow\-non\-empty\f[R], +\f[C]\-\-allow\-root\f[R], \f[C]\-\-allow\-other\f[R] .IP \[bu] 2 -\f[C]\-\-default\-permissions\f[], \f[C]\-\-write\-back\-cache\f[], -\f[C]\-\-max\-read\-ahead\f[], \f[C]\-\-umask\f[], \f[C]\-\-uid\f[], -\f[C]\-\-gid\f[] +\f[C]\-\-default\-permissions\f[R], \f[C]\-\-write\-back\-cache\f[R], +\f[C]\-\-max\-read\-ahead\f[R], \f[C]\-\-umask\f[R], \f[C]\-\-uid\f[R], +\f[C]\-\-gid\f[R] .RE .IP \[bu] 2 -Add \f[C]\-\-dir\-cache\-time\f[] to control caching of directory +Add \f[C]\-\-dir\-cache\-time\f[R] to control caching of directory entries .IP \[bu] 2 Implement seek for files opened for read (useful for video players) .RS 2 .IP \[bu] 2 -with \f[C]\-no\-seek\f[] flag to disable +with \f[C]\-no\-seek\f[R] flag to disable .RE .IP \[bu] 2 Fix crash on 32 bit ARM (alignment of 64 bit counter) @@ -27231,13 +33462,13 @@ Fix crash on 32 bit ARM (alignment of 64 bit counter) Crypt .RS 2 .IP \[bu] 2 -Don't show encrypted password in configurator to stop confusion +Don\[cq]t show encrypted password in configurator to stop confusion .RE .IP \[bu] 2 Amazon Drive .RS 2 .IP \[bu] 2 -New wait for upload option \f[C]\-\-acd\-upload\-wait\-per\-gb\f[] +New wait for upload option \f[C]\-\-acd\-upload\-wait\-per\-gb\f[R] .RS 2 .IP \[bu] 2 upload timeouts scale by file size and can be disabled @@ -27247,14 +33478,14 @@ Add 502 Bad Gateway to list of errors we retry .IP \[bu] 2 Fix overwriting a file with a zero length file .IP \[bu] 2 -Fix ACD file size warning limit \- thanks Felix Bünemann +Fix ACD file size warning limit \- thanks Felix B\[:u]nemann .RE .IP \[bu] 2 Local .RS 2 .IP \[bu] 2 -Unix: implement \f[C]\-x\f[]/\f[C]\-\-one\-file\-system\f[] to stay on a -single file system +Unix: implement \f[C]\-x\f[R]/\f[C]\-\-one\-file\-system\f[R] to stay on +a single file system .RS 2 .IP \[bu] 2 thanks Durval Menezes and Luiz Carlos Rumbelsperger Viana @@ -27297,14 +33528,14 @@ Drive .IP \[bu] 2 Make exponential backoff work exactly as per Google specification .IP \[bu] 2 -add \f[C]\&.epub\f[], \f[C]\&.odp\f[] and \f[C]\&.tsv\f[] as export +add \f[C].epub\f[R], \f[C].odp\f[R] and \f[C].tsv\f[R] as export formats. .RE .IP \[bu] 2 Swift .RS 2 .IP \[bu] 2 -Don't read metadata for directory marker objects +Don\[cq]t read metadata for directory marker objects .RE .SS v1.33 \- 2016\-08\-24 .IP \[bu] 2 @@ -27334,7 +33565,7 @@ rclone genautocomplete \- command to make a bash completion script for rclone .RE .IP \[bu] 2 -Editing a remote using \f[C]rclone\ config\f[] now goes through the +Editing a remote using \f[C]rclone config\f[R] now goes through the wizard .IP \[bu] 2 Compile with go 1.7 \- this fixes rclone on macOS Sierra and on 386 @@ -27352,7 +33583,7 @@ Document how to make your own client_id s3 .RS 2 .IP \[bu] 2 -User\-configurable Amazon S3 ACL (thanks Radek Šenfeld) +User\-configurable Amazon S3 ACL (thanks Radek \[vS]enfeld) .RE .IP \[bu] 2 b2 @@ -27370,7 +33601,7 @@ 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[] in +Fix URL escaping in file names \- eg uploading files with \f[C]+\f[R] in them. .RE .IP \[bu] 2 @@ -27466,7 +33697,8 @@ Add instructions on how to use rclone with minio. .IP \[bu] 2 Add ap\-northeast\-2 (Seoul) and ap\-south\-1 (Mumbai) regions. .IP \[bu] 2 -Skip setting the modified time for objects > 5GB as it isn't possible. +Skip setting the modified time for objects > 5GB as it isn\[cq]t +possible. .RE .IP \[bu] 2 Backblaze B2 @@ -27482,7 +33714,7 @@ Make error handling compliant with B2 integrations notes. .IP \[bu] 2 Fix handling of token expiry. .IP \[bu] 2 -Implement \[en]b2\-test\-mode to set \f[C]X\-Bz\-Test\-Mode\f[] header. +Implement \[en]b2\-test\-mode to set \f[C]X\-Bz\-Test\-Mode\f[R] header. .IP \[bu] 2 Set cutoff for chunked upload to 200MB as per B2 guidelines. .IP \[bu] 2 @@ -27492,7 +33724,7 @@ Make upload multi\-threaded. Dropbox .RS 2 .IP \[bu] 2 -Don't retry 461 errors. +Don\[cq]t retry 461 errors. .RE .SS v1.30 \- 2016\-06\-18 .IP \[bu] 2 @@ -27521,9 +33753,9 @@ Log \-v output to stdout by default .IP \[bu] 2 Display the transfer stats in more human readable form .IP \[bu] 2 -Make 0 size files specifiable with \f[C]\-\-max\-size\ 0b\f[] +Make 0 size files specifiable with \f[C]\-\-max\-size 0b\f[R] .IP \[bu] 2 -Add \f[C]b\f[] suffix so we can specify bytes in \[en]bwlimit, +Add \f[C]b\f[R] suffix so we can specify bytes in \[en]bwlimit, \[en]min\-size etc .IP \[bu] 2 Use \[lq]password:\[rq] instead of \[lq]password>\[rq] prompt \- thanks @@ -27578,7 +33810,7 @@ Wilson Google Cloud Storage .RS 2 .IP \[bu] 2 -Make sure we don't use conflicting content types on upload +Make sure we don\[cq]t use conflicting content types on upload .IP \[bu] 2 Add service account support \- thanks Michal Witkowski .RE @@ -27595,33 +33827,33 @@ Add domain option for openstack (v3 auth) \- thanks Fabian Ruff New Features .RS 2 .IP \[bu] 2 -Implement \f[C]\-I,\ \-\-ignore\-times\f[] for unconditional upload +Implement \f[C]\-I, \-\-ignore\-times\f[R] for unconditional upload .IP \[bu] 2 -Improve \f[C]dedupe\f[]command +Improve \f[C]dedupe\f[R]command .RS 2 .IP \[bu] 2 Now removes identical copies without asking .IP \[bu] 2 -Now obeys \f[C]\-\-dry\-run\f[] +Now obeys \f[C]\-\-dry\-run\f[R] .IP \[bu] 2 -Implement \f[C]\-\-dedupe\-mode\f[] for non interactive running +Implement \f[C]\-\-dedupe\-mode\f[R] for non interactive running .RS 2 .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ interactive\f[] \- interactive the default. +\f[C]\-\-dedupe\-mode interactive\f[R] \- interactive the default. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ skip\f[] \- removes identical files then skips +\f[C]\-\-dedupe\-mode skip\f[R] \- removes identical files then skips anything left. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ first\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode first\f[R] \- removes identical files then keeps the first one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ newest\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode newest\f[R] \- removes identical files then keeps the newest one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ oldest\f[] \- removes identical files then keeps +\f[C]\-\-dedupe\-mode oldest\f[R] \- removes identical files then keeps the oldest one. .IP \[bu] 2 -\f[C]\-\-dedupe\-mode\ rename\f[] \- removes identical files then +\f[C]\-\-dedupe\-mode rename\f[R] \- removes identical files then renames the rest to be different. .RE .RE @@ -27630,7 +33862,7 @@ renames the rest to be different. Bug fixes .RS 2 .IP \[bu] 2 -Make rclone check obey the \f[C]\-\-size\-only\f[] flag. +Make rclone check obey the \f[C]\-\-size\-only\f[R] flag. .IP \[bu] 2 Use \[lq]application/octet\-stream\[rq] if discovered mime type is invalid. @@ -27661,9 +33893,9 @@ This means that B2 will now check modification times .IP \[bu] 2 It will upload new files to update the modification times .IP \[bu] 2 -(there isn't an API to just set the mod time.) +(there isn\[cq]t an API to just set the mod time.) .IP \[bu] 2 -If you want the old behaviour use \f[C]\-\-size\-only\f[]. +If you want the old behaviour use \f[C]\-\-size\-only\f[R]. .RE .IP \[bu] 2 Update API to new version @@ -27674,7 +33906,7 @@ Fix parsing of mod time when not in metadata Swift/Hubic .RS 2 .IP \[bu] 2 -Don't return an MD5SUM for static large objects +Don\[cq]t return an MD5SUM for static large objects .RE .IP \[bu] 2 S3 @@ -27689,29 +33921,29 @@ New Features .IP \[bu] 2 Configuration file encryption \- thanks Klaus Post .IP \[bu] 2 -Improve \f[C]rclone\ config\f[] adding more help and making it easier to +Improve \f[C]rclone config\f[R] adding more help and making it easier to understand .IP \[bu] 2 -Implement \f[C]\-u\f[]/\f[C]\-\-update\f[] so creation times can be used -on all remotes +Implement \f[C]\-u\f[R]/\f[C]\-\-update\f[R] so creation times can be +used on all remotes .IP \[bu] 2 -Implement \f[C]\-\-low\-level\-retries\f[] flag +Implement \f[C]\-\-low\-level\-retries\f[R] flag .IP \[bu] 2 Optionally disable gzip compression on downloads with -\f[C]\-\-no\-gzip\-encoding\f[] +\f[C]\-\-no\-gzip\-encoding\f[R] .RE .IP \[bu] 2 Bug fixes .RS 2 .IP \[bu] 2 -Don't make directories if \f[C]\-\-dry\-run\f[] set +Don\[cq]t make directories if \f[C]\-\-dry\-run\f[R] set .IP \[bu] 2 -Fix and document the \f[C]move\f[] command +Fix and document the \f[C]move\f[R] command .IP \[bu] 2 Fix redirecting stderr on unix\-like OSes when using -\f[C]\-\-log\-file\f[] +\f[C]\-\-log\-file\f[R] .IP \[bu] 2 -Fix \f[C]delete\f[] command to wait until all finished \- fixes missing +Fix \f[C]delete\f[R] command to wait until all finished \- fixes missing deletes. .RE .IP \[bu] 2 @@ -27719,14 +33951,14 @@ Backblaze B2 .RS 2 .IP \[bu] 2 Use one upload URL per go routine fixes -\f[C]more\ than\ one\ upload\ using\ auth\ token\f[] +\f[C]more than one upload using auth token\f[R] .IP \[bu] 2 Add pacing, retries and reauthentication \- fixes token expiry problems .IP \[bu] 2 Upload without using a temporary file from local (and remotes which support SHA1) .IP \[bu] 2 -Fix reading metadata for all files when it shouldn't have been +Fix reading metadata for all files when it shouldn\[cq]t have been .RE .IP \[bu] 2 Drive @@ -27742,7 +33974,7 @@ Swift .IP \[bu] 2 Fix uploading of chunked files with non ASCII characters .IP \[bu] 2 -Allow setting of \f[C]storage_url\f[] in the config \- thanks Xavier +Allow setting of \f[C]storage_url\f[R] in the config \- thanks Xavier Lucas .RE .IP \[bu] 2 @@ -27766,28 +33998,28 @@ Retry on more things to make directory listings more reliable New Features .RS 2 .IP \[bu] 2 -Easier headless configuration with \f[C]rclone\ authorize\f[] +Easier headless configuration with \f[C]rclone authorize\f[R] .IP \[bu] 2 Add support for multiple hash types \- we now check SHA1 as well as MD5 hashes. .IP \[bu] 2 -\f[C]delete\f[] command which does obey the filters (unlike -\f[C]purge\f[]) +\f[C]delete\f[R] command which does obey the filters (unlike +\f[C]purge\f[R]) .IP \[bu] 2 -\f[C]dedupe\f[] command to deduplicate a remote. +\f[C]dedupe\f[R] command to deduplicate a remote. Useful with Google Drive. .IP \[bu] 2 -Add \f[C]\-\-ignore\-existing\f[] flag to skip all files that exist on +Add \f[C]\-\-ignore\-existing\f[R] flag to skip all files that exist on destination. .IP \[bu] 2 -Add \f[C]\-\-delete\-before\f[], \f[C]\-\-delete\-during\f[], -\f[C]\-\-delete\-after\f[] flags. +Add \f[C]\-\-delete\-before\f[R], \f[C]\-\-delete\-during\f[R], +\f[C]\-\-delete\-after\f[R] flags. .IP \[bu] 2 -Add \f[C]\-\-memprofile\f[] flag to debug memory use. +Add \f[C]\-\-memprofile\f[R] flag to debug memory use. .IP \[bu] 2 Warn the user about files with same name but different case .IP \[bu] 2 -Make \f[C]\-\-include\f[] rules add their implict exclude * at the end +Make \f[C]\-\-include\f[R] rules add their implict exclude * at the end of the filter list .IP \[bu] 2 Deprecate compiling with go1.3 @@ -27814,8 +34046,8 @@ SHA1 hashes now checked by rclone core Drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-drive\-auth\-owner\-only\f[] to only consider files owned -by the user \- thanks Björn Harrtell +Add \f[C]\-\-drive\-auth\-owner\-only\f[R] to only consider files owned +by the user \- thanks Bj\[:o]rn Harrtell .IP \[bu] 2 Export Google documents .RE @@ -27835,7 +34067,7 @@ Fix upload from unprivileged user. S3 .RS 2 .IP \[bu] 2 -Fix updating of mod times of files with \f[C]+\f[] in. +Fix updating of mod times of files with \f[C]+\f[R] in. .RE .IP \[bu] 2 Local @@ -27852,8 +34084,8 @@ Yandex storage backend \- thank you Dmitry Burdeev (\[lq]dibu\[rq]) .IP \[bu] 2 Implement Backblaze B2 storage backend .IP \[bu] 2 -Add \[en]min\-age and \[en]max\-age flags \- thank you Adriano Aurélio -Meirelles +Add \[en]min\-age and \[en]max\-age flags \- thank you Adriano +Aur\['e]lio Meirelles .IP \[bu] 2 Make ls/lsl/md5sum/size/check obey includes and excludes .RE @@ -27877,7 +34109,7 @@ OneDrive .IP \[bu] 2 Re\-enable server side copy .IP \[bu] 2 -Don't mask HTTP error codes with JSON decode error +Don\[cq]t mask HTTP error codes with JSON decode error .RE .IP \[bu] 2 S3 @@ -27901,7 +34133,7 @@ Fix deletion of some excluded files without \[en]delete\-excluded .IP \[bu] 2 This could have deleted files unexpectedly on sync .IP \[bu] 2 -Always check first with \f[C]\-\-dry\-run\f[]! +Always check first with \f[C]\-\-dry\-run\f[R]! .RE .RE .IP \[bu] 2 @@ -27929,7 +34161,7 @@ New features .IP \[bu] 2 Add support for Microsoft OneDrive .IP \[bu] 2 -Add \f[C]\-\-no\-check\-certificate\f[] option to disable server +Add \f[C]\-\-no\-check\-certificate\f[R] option to disable server certificate verification .IP \[bu] 2 Add async readahead buffer for faster transfer of big files @@ -27950,26 +34182,26 @@ Swift Ignore directory marker objects where appropriate \- allows working with Hubic .IP \[bu] 2 -Don't delete the container if fs wasn't at root +Don\[cq]t delete the container if fs wasn\[cq]t at root .RE .IP \[bu] 2 S3 .RS 2 .IP \[bu] 2 -Don't delete the bucket if fs wasn't at root +Don\[cq]t delete the bucket if fs wasn\[cq]t at root .RE .IP \[bu] 2 Google Cloud Storage .RS 2 .IP \[bu] 2 -Don't delete the bucket if fs wasn't at root +Don\[cq]t delete the bucket if fs wasn\[cq]t at root .RE .SS v1.23 \- 2015\-10\-03 .IP \[bu] 2 New features .RS 2 .IP \[bu] 2 -Implement \f[C]rclone\ size\f[] for measuring remotes +Implement \f[C]rclone size\f[R] for measuring remotes .RE .IP \[bu] 2 Fixes @@ -27979,7 +34211,7 @@ Fix headless config for drive and gcs .IP \[bu] 2 Tell the user they should try again if the webserver method failed .IP \[bu] 2 -Improve output of \f[C]\-\-dump\-headers\f[] +Improve output of \f[C]\-\-dump\-headers\f[R] .RE .IP \[bu] 2 S3 @@ -28104,7 +34336,7 @@ Issue an error message when trying to upload bad file name drive .RS 2 .IP \[bu] 2 -Add \f[C]\-\-drive\-use\-trash\f[] flag so rclone trashes instead of +Add \f[C]\-\-drive\-use\-trash\f[R] flag so rclone trashes instead of deletes .IP \[bu] 2 Add \[lq]Forbidden to download\[rq] message for files with no @@ -28130,7 +34362,7 @@ s3 .IP \[bu] 2 use official AWS SDK from github.com/aws/aws\-sdk\-go .IP \[bu] 2 -\f[B]NB\f[] will most likely require you to delete and recreate remote +\f[B]NB\f[R] will most likely require you to delete and recreate remote .IP \[bu] 2 enable multipart upload which enables files > 5GB .IP \[bu] 2 @@ -28161,7 +34393,7 @@ dropbox: fix case insensitivity issues \- thanks Leonid Shalupov .IP \[bu] 2 Fix uploading big files which was causing timeouts or panics .IP \[bu] 2 -Don't check md5sum after download with \[en]size\-only +Don\[cq]t check md5sum after download with \[en]size\-only .SS v1.15 \- 2015\-06\-06 .IP \[bu] 2 Add \[en]checksum flag to only discard transfers by MD5SUM \- thanks @@ -28171,7 +34403,7 @@ Implement \[en]size\-only flag to sync on size not checksum & modtime .IP \[bu] 2 Expand docs and remove duplicated information .IP \[bu] 2 -Document rclone's limitations with directories +Document rclone\[cq]s limitations with directories .IP \[bu] 2 dropbox: update docs about case insensitivity .SS v1.14 \- 2015\-05\-21 @@ -28189,7 +34421,7 @@ Revise documentation (especially sync) .IP \[bu] 2 Implement \[en]timeout and \[en]conntimeout .IP \[bu] 2 -s3: ignore etags from multipart uploads which aren't md5sums +s3: ignore etags from multipart uploads which aren\[cq]t md5sums .SS v1.12 \- 2015\-03\-15 .IP \[bu] 2 drive: Use chunked upload for files above a certain size @@ -28243,7 +34475,7 @@ dropbox: adapt code to recent library changes google cloud storage: fix memory leak .SS v1.06 \- 2014\-12\-12 .IP \[bu] 2 -Fix \[lq]Couldn't find home directory\[rq] on OSX +Fix \[lq]Couldn\[cq]t find home directory\[rq] on OSX .IP \[bu] 2 swift: Add tenant parameter .IP \[bu] 2 @@ -28350,9 +34582,9 @@ Project named rclone Project started .SH Bugs and Limitations .SS Limitations -.SS Directory timestamps aren't preserved +.SS Directory timestamps aren\[cq]t preserved .PP -Rclone doesn't currently preserve the timestamps of directories. +Rclone doesn\[cq]t currently preserve the timestamps of directories. This is because rclone only really considers objects when syncing. .SS Rclone struggles with millions of files in a directory .PP @@ -28370,14 +34602,14 @@ directories. Rclone therefore cannot create directories in them which means that empty directories on a bucket based remote will tend to disappear. .PP -Some software creates empty keys ending in \f[C]/\f[] as directory +Some software creates empty keys ending in \f[C]/\f[R] as directory markers. -Rclone doesn't do this as it potentially creates more objects and costs -more. +Rclone doesn\[cq]t do this as it potentially creates more objects and +costs more. It may do in future (probably with a flag). .SS Bugs .PP -Bugs are stored in rclone's GitHub project: +Bugs are stored in rclone\[cq]s GitHub project: .IP \[bu] 2 Reported bugs (https://github.com/rclone/rclone/issues?q=is%3Aopen+is%3Aissue+label%3Abug) @@ -28388,18 +34620,17 @@ 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[], \f[C]copy\f[] etc) will work -on all the remote storage systems. +All the rclone commands (eg \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. -If you want to find this file, run \f[C]rclone\ config\ file\f[] which +If you want to find this file, run \f[C]rclone config file\f[R] which will tell you where it is. .PP See the remote setup docs (https://rclone.org/remote_setup/) for more info. -.SS How do I configure rclone on a remote / headless box with no -browser? +.SS How do I configure rclone on a remote / headless box with no browser? .PP This has now been documented in its own remote setup page (https://rclone.org/remote_setup/). @@ -28416,8 +34647,8 @@ Eg .IP .nf \f[C] -rclone\ sync\ drive:Folder\ s3:bucket -\f[] +rclone sync drive:Folder s3:bucket +\f[R] .fi .SS Using rclone from multiple locations at the same time .PP @@ -28426,9 +34657,9 @@ different subdirectory for the output, eg .IP .nf \f[C] -Server\ A>\ rclone\ sync\ /tmp/whatever\ remote:ServerA -Server\ B>\ rclone\ sync\ /tmp/whatever\ remote:ServerB -\f[] +Server A> rclone sync /tmp/whatever remote:ServerA +Server B> rclone sync /tmp/whatever remote:ServerB +\f[R] .fi .PP If you sync to the same directory then you should use rclone copy @@ -28436,16 +34667,15 @@ otherwise the two rclones may delete each others files, eg .IP .nf \f[C] -Server\ A>\ rclone\ copy\ /tmp/whatever\ remote:Backup -Server\ B>\ rclone\ copy\ /tmp/whatever\ remote:Backup -\f[] +Server A> rclone copy /tmp/whatever remote:Backup +Server B> rclone copy /tmp/whatever remote:Backup +\f[R] .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. -.SS Why doesn't rclone support partial transfers / binary diffs like -rsync? +.SS Why doesn\[cq]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. @@ -28454,10 +34684,10 @@ 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. .PP -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. +Cloud storage systems (at least none I\[cq]ve come across yet) don\[cq]t +support partially uploading an object. +You can\[cq]t take an existing object, and change some bytes in the +middle of it. .PP 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 @@ -28481,33 +34711,33 @@ Yes. rclone will follow the standard environment variables for proxies, similar to cURL and other programs. .PP -In general the variables are called \f[C]http_proxy\f[] (for services -reached over \f[C]http\f[]) and \f[C]https_proxy\f[] (for services -reached over \f[C]https\f[]). -Most public services will be using \f[C]https\f[], but you may wish to +In general the variables are called \f[C]http_proxy\f[R] (for services +reached over \f[C]http\f[R]) and \f[C]https_proxy\f[R] (for services +reached over \f[C]https\f[R]). +Most public services will be using \f[C]https\f[R], but you may wish to set both. .PP -The content of the variable is \f[C]protocol://server:port\f[]. +The content of the variable is \f[C]protocol://server:port\f[R]. The protocol value is the one used to talk to the proxy server, itself, -and is commonly either \f[C]http\f[] or \f[C]socks5\f[]. +and is commonly either \f[C]http\f[R] or \f[C]socks5\f[R]. .PP -Slightly annoyingly, there is no \f[I]standard\f[] for the name; some -applications may use \f[C]http_proxy\f[] but another one -\f[C]HTTP_PROXY\f[]. -The \f[C]Go\f[] libraries used by \f[C]rclone\f[] will try both +Slightly annoyingly, there is no \f[I]standard\f[R] for the name; some +applications may use \f[C]http_proxy\f[R] but another one +\f[C]HTTP_PROXY\f[R]. +The \f[C]Go\f[R] libraries used by \f[C]rclone\f[R] will try both variations, but you may wish to set all possibilities. So, on Linux, you may end up with code similar to .IP .nf \f[C] -export\ http_proxy=http://proxyserver:12345 -export\ https_proxy=$http_proxy -export\ HTTP_PROXY=$http_proxy -export\ HTTPS_PROXY=$http_proxy -\f[] +export http_proxy=http://proxyserver:12345 +export https_proxy=$http_proxy +export HTTP_PROXY=$http_proxy +export HTTPS_PROXY=$http_proxy +\f[R] .fi .PP -The \f[C]NO_PROXY\f[] allows you to disable the proxy for specific +The \f[C]NO_PROXY\f[R] allows you to disable the proxy for specific hosts. Hosts must be comma separated, and can contain domains or parts. For instance \[lq]foo.com\[rq] also matches \[lq]bar.foo.com\[rq]. @@ -28516,17 +34746,17 @@ e.g. .IP .nf \f[C] -export\ no_proxy=localhost,127.0.0.0/8,my.host.name -export\ NO_PROXY=$no_proxy -\f[] +export no_proxy=localhost,127.0.0.0/8,my.host.name +export NO_PROXY=$no_proxy +\f[R] .fi .PP -Note that the ftp backend does not support \f[C]ftp_proxy\f[] yet. -.SS Rclone gives x509: failed to load system roots and no roots provided -error +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[] can't file the SSL root certificates. -Likely you are running \f[C]rclone\f[] on a NAS with a cut\-down Linux +This means that \f[C]rclone\f[R] can\[cq]t file 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. .PP Rclone (via the Go runtime) tries to load the root certificates from @@ -28534,11 +34764,11 @@ these places on Linux. .IP .nf \f[C] -"/etc/ssl/certs/ca\-certificates.crt",\ //\ Debian/Ubuntu/Gentoo\ etc. -"/etc/pki/tls/certs/ca\-bundle.crt",\ \ \ //\ Fedora/RHEL -"/etc/ssl/ca\-bundle.pem",\ \ \ \ \ \ \ \ \ \ \ \ \ //\ OpenSUSE -"/etc/pki/tls/cacert.pem",\ \ \ \ \ \ \ \ \ \ \ \ //\ OpenELEC -\f[] +\[dq]/etc/ssl/certs/ca\-certificates.crt\[dq], // Debian/Ubuntu/Gentoo etc. +\[dq]/etc/pki/tls/certs/ca\-bundle.crt\[dq], // Fedora/RHEL +\[dq]/etc/ssl/ca\-bundle.pem\[dq], // OpenSUSE +\[dq]/etc/pki/tls/cacert.pem\[dq], // OpenELEC +\f[R] .fi .PP So doing something like this should fix the problem. @@ -28546,27 +34776,26 @@ It also sets the time which is important for SSL to work properly. .IP .nf \f[C] -mkdir\ \-p\ /etc/ssl/certs/ -curl\ \-o\ /etc/ssl/certs/ca\-certificates.crt\ https://raw.githubusercontent.com/bagder/ca\-bundle/master/ca\-bundle.crt -ntpclient\ \-s\ \-h\ pool.ntp.org -\f[] +mkdir \-p /etc/ssl/certs/ +curl \-o /etc/ssl/certs/ca\-certificates.crt https://raw.githubusercontent.com/bagder/ca\-bundle/master/ca\-bundle.crt +ntpclient \-s \-h pool.ntp.org +\f[R] .fi .PP -The two environment variables \f[C]SSL_CERT_FILE\f[] and -\f[C]SSL_CERT_DIR\f[], mentioned in the x509 +The two environment variables \f[C]SSL_CERT_FILE\f[R] and +\f[C]SSL_CERT_DIR\f[R], mentioned in the x509 package (https://godoc.org/crypto/x509), provide an additional way to provide the SSL root certificates. .PP -Note that you may need to add the \f[C]\-\-insecure\f[] option to the -\f[C]curl\f[] command line if it doesn't work without. +Note that you may need to add the \f[C]\-\-insecure\f[R] option to the +\f[C]curl\f[R] command line if it doesn\[cq]t work without. .IP .nf \f[C] -curl\ \-\-insecure\ \-o\ /etc/ssl/certs/ca\-certificates.crt\ https://raw.githubusercontent.com/bagder/ca\-bundle/master/ca\-bundle.crt -\f[] +curl \-\-insecure \-o /etc/ssl/certs/ca\-certificates.crt https://raw.githubusercontent.com/bagder/ca\-bundle/master/ca\-bundle.crt +\f[R] .fi -.SS Rclone gives Failed to load config file: function not implemented -error +.SS Rclone gives Failed to load config file: function not implemented error .PP Likely this means that you are running rclone on Linux version not supported by the go runtime, ie earlier than version 2.6.23. @@ -28576,10 +34805,10 @@ docs (https://golang.org/doc/install) for full details. .SS All my uploaded docx/xlsx/pptx files appear as archive/zip .PP This is caused by uploading these files from a Windows computer which -hasn't got the Microsoft Office suite installed. +hasn\[cq]t got the Microsoft Office suite installed. The easiest way to fix is to install the Word viewer and the Microsoft Office Compatibility Pack for Word, Excel, and PowerPoint 2007 and later -versions' file formats +versions\[cq] file formats .SS tcp lookup some.domain.com no such host .PP This happens when rclone cannot resolve a domain. @@ -28587,24 +34816,23 @@ Please check that your DNS setup is generally working, e.g. .IP .nf \f[C] -#\ both\ should\ print\ a\ long\ list\ of\ possible\ IP\ addresses -dig\ www.googleapis.com\ \ \ \ \ \ \ \ \ \ #\ resolve\ using\ your\ default\ DNS -dig\ www.googleapis.com\ \@8.8.8.8\ #\ resolve\ with\ Google\[aq]s\ DNS\ server -\f[] +# both should print a long list of possible IP addresses +dig www.googleapis.com # resolve using your default DNS +dig www.googleapis.com \[at]8.8.8.8 # resolve with Google\[aq]s DNS server +\f[R] .fi .PP -If you are using \f[C]systemd\-resolved\f[] (default on Arch Linux), +If you are using \f[C]systemd\-resolved\f[R] (default on Arch Linux), ensure it is at version 233 or higher. Previous releases contain a bug which causes not all domains to be resolved properly. .PP -Additionally with the \f[C]GODEBUG=netdns=\f[] environment variable the +Additionally with the \f[C]GODEBUG=netdns=\f[R] environment variable the Go resolver decision can be influenced. This also allows to resolve certain issues with DNS resolution. See the name resolution section in the go docs (https://golang.org/pkg/net/#hdr-Name_Resolution). -.SS The total size reported in the stats for a sync is wrong and keeps -changing +.SS The total size reported in the stats for a sync is wrong and keeps changing .PP It is likely you have more than 10,000 files that need to be synced. By default rclone only gets 10,000 files ahead in a sync so as not to @@ -28619,7 +34847,7 @@ the heap size has doubled. .PP However it is possible to tune the garbage collector to use less memory by setting GOGC (https://dave.cheney.net/tag/gogc) to a lower value, say -\f[C]export\ GOGC=20\f[]. +\f[C]export GOGC=20\f[R]. This will make the garbage collector work harder, reducing memory size at the expense of CPU usage. .PP @@ -28634,26 +34862,26 @@ COPYING file included with the source code). .IP .nf \f[C] -Copyright\ (C)\ 2019\ by\ Nick\ Craig\-Wood\ https://www.craig\-wood.com/nick/ +Copyright (C) 2019 by Nick Craig\-Wood https://www.craig\-wood.com/nick/ -Permission\ is\ hereby\ granted,\ free\ of\ charge,\ to\ any\ person\ obtaining\ a\ copy -of\ this\ software\ and\ associated\ documentation\ files\ (the\ "Software"),\ to\ deal -in\ the\ Software\ without\ restriction,\ including\ without\ limitation\ the\ rights -to\ use,\ copy,\ modify,\ merge,\ publish,\ distribute,\ sublicense,\ and/or\ sell -copies\ of\ the\ Software,\ and\ to\ permit\ persons\ to\ whom\ the\ Software\ is -furnished\ to\ do\ so,\ subject\ to\ the\ following\ conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the \[dq]Software\[dq]), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -The\ above\ copyright\ notice\ and\ this\ permission\ notice\ shall\ be\ included\ in -all\ copies\ or\ substantial\ portions\ of\ the\ Software. +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. -THE\ SOFTWARE\ IS\ PROVIDED\ "AS\ IS",\ WITHOUT\ WARRANTY\ OF\ ANY\ KIND,\ EXPRESS\ OR -IMPLIED,\ INCLUDING\ BUT\ NOT\ LIMITED\ TO\ THE\ WARRANTIES\ OF\ MERCHANTABILITY, -FITNESS\ FOR\ A\ PARTICULAR\ PURPOSE\ AND\ NONINFRINGEMENT.\ IN\ NO\ EVENT\ SHALL\ THE -AUTHORS\ OR\ COPYRIGHT\ HOLDERS\ BE\ LIABLE\ FOR\ ANY\ CLAIM,\ DAMAGES\ OR\ OTHER -LIABILITY,\ WHETHER\ IN\ AN\ ACTION\ OF\ CONTRACT,\ TORT\ OR\ OTHERWISE,\ ARISING\ FROM, -OUT\ OF\ OR\ IN\ CONNECTION\ WITH\ THE\ SOFTWARE\ OR\ THE\ USE\ OR\ OTHER\ DEALINGS\ IN -THE\ SOFTWARE. -\f[] +THE SOFTWARE IS PROVIDED \[dq]AS IS\[dq], WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +\f[R] .fi .SS Authors .IP \[bu] 2 @@ -28672,7 +34900,7 @@ Klaus Post .IP \[bu] 2 Sergey Tolmachev .IP \[bu] 2 -Adriano Aurélio Meirelles +Adriano Aur\['e]lio Meirelles .IP \[bu] 2 C. Bess @@ -28681,7 +34909,7 @@ Dmitry Burdeev .IP \[bu] 2 Joseph Spurrier .IP \[bu] 2 -Björn Harrtell +Bj\[:o]rn Harrtell .IP \[bu] 2 Xavier Lucas .IP \[bu] 2 @@ -28711,7 +34939,7 @@ Weichinger .IP \[bu] 2 Per Cederberg .IP \[bu] 2 -Radek Šenfeld +Radek \[vS]enfeld .IP \[bu] 2 Fredrik Fornwall .IP \[bu] 2 @@ -28723,7 +34951,7 @@ Tomasz Mazur .IP \[bu] 2 Marco Paganini .IP \[bu] 2 -Felix Bünemann +Felix B\[:u]nemann .IP \[bu] 2 Durval Menezes .IP \[bu] 2 @@ -28739,7 +34967,7 @@ Thibault Molleman .IP \[bu] 2 Scott McGillivray .IP \[bu] 2 -Bjørn Erik Pedersen +Bj\[/o]rn Erik Pedersen .IP \[bu] 2 Lukas Loesche .IP \[bu] 2 @@ -28752,7 +34980,7 @@ Brandur .IP \[bu] 2 Dario Giovannetti .IP \[bu] 2 -Károly Oláh +K\['a]roly Ol\['a]h .IP \[bu] 2 Jon Yergatian .IP \[bu] 2 @@ -28762,7 +34990,7 @@ Dedsec1 .IP \[bu] 2 Hisham Zarka .IP \[bu] 2 -Jérôme Vizcaino +J\['e]r\[^o]me Vizcaino .IP \[bu] 2 Mike Tesch .IP \[bu] 2 @@ -28802,7 +35030,7 @@ Sjur Fredriksen .IP \[bu] 2 Ruwbin .IP \[bu] 2 -Fabian Möller +Fabian M\[:o]ller .IP \[bu] 2 Edward Q. Bridges @@ -28830,7 +35058,7 @@ wuyu .IP \[bu] 2 Andrei Dragomir .IP \[bu] 2 -Christian Brüggemann +Christian Br\[:u]ggemann .IP \[bu] 2 Alex McGrath Kraak .IP \[bu] 2 @@ -29010,7 +35238,7 @@ reddi1 .IP \[bu] 2 Matt Tucker .IP \[bu] 2 -Sebastian Bünger +Sebastian B\[:u]nger .IP \[bu] 2 Martin Polden .IP \[bu] 2 @@ -29020,7 +35248,7 @@ Denis .IP \[bu] 2 bsteiss <35940619+bsteiss@users.noreply.github.com> .IP \[bu] 2 -Cédric Connes +C\['e]dric Connes .IP \[bu] 2 Dr.\ Tobias Quathamer .IP \[bu] 2 @@ -29033,10 +35261,11 @@ albertony <12441419+albertony@users.noreply.github.com> cron410 .IP \[bu] 2 Anagh Kumar Baranwal +<6824881+darthShadow@users.noreply.github.com> .IP \[bu] 2 Felix Brucker .IP \[bu] 2 -Santiago Rodríguez +Santiago Rodr\['i]guez .IP \[bu] 2 Craig Miskell .IP \[bu] 2 @@ -29090,7 +35319,7 @@ Mark Otway .IP \[bu] 2 William Cocker <37018962+WilliamCocker@users.noreply.github.com> .IP \[bu] 2 -François Leurent <131.js@cloudyks.org> +Fran\[,c]ois Leurent <131.js@cloudyks.org> .IP \[bu] 2 Arkadius Stefanski .IP \[bu] 2 @@ -29104,13 +35333,13 @@ Dario Guzik .IP \[bu] 2 qip .IP \[bu] 2 -yair\@unicorn +yair\[at]unicorn .IP \[bu] 2 Matt Robinson .IP \[bu] 2 kayrus .IP \[bu] 2 -Rémy Léone +R\['e]my L\['e]one .IP \[bu] 2 Wojciech Smigielski .IP \[bu] 2 @@ -29134,7 +35363,7 @@ Dr.Rx .IP \[bu] 2 marcintustin .IP \[bu] 2 -jaKa Močnik +jaKa Mo\[u010D]nik .IP \[bu] 2 Fionera .IP \[bu] 2 @@ -29175,7 +35404,8 @@ forgems .IP \[bu] 2 Florian Apolloner .IP \[bu] 2 -Aleksandar Jankovic +Aleksandar Jankovi\['c] + .IP \[bu] 2 Maran .IP \[bu] 2 @@ -29203,7 +35433,7 @@ justina777 .IP \[bu] 2 Chaitanya Bankanhal .IP \[bu] 2 -Michał Matczuk +Micha\[/l] Matczuk .IP \[bu] 2 Macavirus .IP \[bu] 2 @@ -29233,7 +35463,7 @@ Anthony Rusdi <33247310+antrusd@users.noreply.github.com> .IP \[bu] 2 Richard Patel .IP \[bu] 2 -庄天翼 +\[u5E84]\[u5929]\[u7FFC] .IP \[bu] 2 SwitchJS .IP \[bu] 2 @@ -29260,6 +35490,62 @@ Carlos Ferreyra Saksham Khanna .IP \[bu] 2 dausruddin <5763466+dausruddin@users.noreply.github.com> +.IP \[bu] 2 +zero\-24 +.IP \[bu] 2 +Xiaoxing Ye +.IP \[bu] 2 +Barry Muldrey +.IP \[bu] 2 +Sebastian Brandt +.IP \[bu] 2 +Marco Molteni +.IP \[bu] 2 +Ankur Gupta +.IP \[bu] 2 +Maciej Zimnoch +.IP \[bu] 2 +anuar45 +.IP \[bu] 2 +Fernando +.IP \[bu] 2 +David Cole +.IP \[bu] 2 +Wei He +.IP \[bu] 2 +Outvi V <19144373+outloudvi@users.noreply.github.com> +.IP \[bu] 2 +Thomas Kriechbaumer +.IP \[bu] 2 +Tennix +.IP \[bu] 2 +Ole Sch\[:u]tt +.IP \[bu] 2 +Kuang\-che Wu +.IP \[bu] 2 +Thomas Eales +.IP \[bu] 2 +Paul Tinsley +.IP \[bu] 2 +Felix Hungenberg +.IP \[bu] 2 +Benjamin Richter +.IP \[bu] 2 +landall +.IP \[bu] 2 +thestigma +.IP \[bu] 2 +jtagcat <38327267+jtagcat@users.noreply.github.com> +.IP \[bu] 2 +Damon Permezel +.IP \[bu] 2 +boosh +.IP \[bu] 2 +unbelauscht <58393353+unbelauscht@users.noreply.github.com> +.IP \[bu] 2 +Motonori IWAMURO +.IP \[bu] 2 +Benjapol Worakan .SH Contact the rclone project .SS Forum .PP @@ -29277,12 +35563,12 @@ There you can file bug reports or contribute pull requests. .PP You can also follow me on twitter for rclone announcements: .IP \[bu] 2 -[\@njcw](https://twitter.com/njcw) +[\[at]njcw](https://twitter.com/njcw) .SS Email .PP Or if all else fails or you want to ask something private or confidential email Nick Craig\-Wood (mailto:nick@craig-wood.com). -Please don't email me requests for help \- those are better directed to -the forum \- thanks! +Please don\[cq]t email me requests for help \- those are better directed +to the forum \- thanks! .SH AUTHORS Nick Craig\-Wood.

    ／
    "" 0x22 ＂