Rclone on rclone - rsync for cloud storage

Sia

Nick Craig-Wood — Wed, 02 Oct 2019 00:00:00 UTC

Sia

Sia (sia.tech) is a decentralized cloud storage platform based on the blockchain technology. With rclone you can use it like any other remote filesystem or mount Sia folders locally. The technology behind it involves a number of new concepts such as Siacoins and Wallet, Blockchain and Consensus, Renting and Hosting, and so on. If you are new to it, you'd better first familiarize yourself using their excellent support documentation.

Introduction

Before you can use rclone with Sia, you will need to have a running copy of Sia-UI or siad (the Sia daemon) locally on your computer or on local network (e.g. a NAS). Please follow the Get started guide and install one.

rclone interacts with Sia network by talking to the Sia daemon via HTTP API which is usually available on port 9980. By default you will run the daemon locally on the same computer so it's safe to leave the API password blank (the API URL will be http://127.0.0.1:9980 making external access impossible).

However, if you want to access Sia daemon running on another node, for example due to memory constraints or because you want to share single daemon between several rclone and Sia-UI instances, you'll need to make a few more provisions:

Ensure you have Sia daemon installed directly or in a docker container because Sia-UI does not support this mode natively.
Run it on externally accessible port, for example provide --api-addr :9980 and --disable-api-security arguments on the daemon command line.
Enforce API password for the siad daemon via environment variable SIA_API_PASSWORD or text file named apipassword in the daemon directory.
Set rclone backend option api_password taking it from above locations.

Notes:

If your wallet is locked, rclone cannot unlock it automatically. You should either unlock it in advance by using Sia-UI or via command line siac wallet unlock. Alternatively you can make siad unlock your wallet automatically upon startup by running it with environment variable SIA_WALLET_PASSWORD.
If siad cannot find the SIA_API_PASSWORD variable or the apipassword file in the SIA_DIR directory, it will generate a random password and store in the text file named apipassword under YOUR_HOME/.sia/ directory on Unix or C:\Users\YOUR_HOME\AppData\Local\Sia\apipassword on Windows. Remember this when you configure password in rclone.
The only way to use siad without API password is to run it on localhost with command line argument --authorize-api=false, but this is insecure and strongly discouraged.

Configuration

Here is an example of how to make a sia remote called mySia. 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> mySia
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
...
29 / Sia Decentralized Cloud
   \ "sia"
...
Storage> sia
Sia daemon API URL, like http://sia.daemon.host:9980.
Note that siad must run with --disable-api-security to open API port for other hosts (not recommended).
Keep default if Sia daemon runs on localhost.
Enter a string value. Press Enter for the default ("http://127.0.0.1:9980").
api_url> http://127.0.0.1:9980
Sia Daemon API Password.
Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank (default)
y/g/n> y
Enter the password:
password:
Confirm the password:
password:
Edit advanced config?
y) Yes
n) No (default)
y/n> n
--------------------
[mySia]
type = sia
api_url = http://127.0.0.1:9980
api_password = *** ENCRYPTED ***
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Once configured, you can then use rclone like this:

List directories in top level of your Sia storage
```
rclone lsd mySia:
```
List all the files in your Sia storage
```
rclone ls mySia:
```
Upload a local directory to the Sia directory called backup
```
rclone copy /home/source mySia:backup
```

Standard options

Here are the Standard options specific to sia (Sia Decentralized Cloud).

--sia-api-url

Sia daemon API URL, like http://sia.daemon.host:9980.

Note that siad must run with --disable-api-security to open API port for other hosts (not recommended). Keep default if Sia daemon runs on localhost.

Properties:

Config: api_url
Env Var: RCLONE_SIA_API_URL
Type: string
Default: "http://127.0.0.1:9980"

--sia-api-password

Sia Daemon API Password.

Can be found in the apipassword file located in HOME/.sia/ or in the daemon directory.

NB Input to this must be obscured - see rclone obscure.

Properties:

Config: api_password
Env Var: RCLONE_SIA_API_PASSWORD
Type: string
Required: false

Advanced options

Here are the Advanced options specific to sia (Sia Decentralized Cloud).

--sia-user-agent

Siad User Agent

Sia daemon requires the 'Sia-Agent' user agent by default for security

Properties:

Config: user_agent
Env Var: RCLONE_SIA_USER_AGENT
Type: string
Default: "Sia-Agent"

--sia-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

Config: encoding
Env Var: RCLONE_SIA_ENCODING
Type: Encoding
Default: Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot

--sia-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_SIA_DESCRIPTION
Type: string
Required: false

Limitations

Modification times not supported
Checksums not supported
rclone about not supported
rclone can work only with Siad or Sia-UI at the moment, the SkyNet daemon is not supported yet.
Sia does not allow control characters or symbols like question and pound signs in file names. rclone will transparently encode them for you, but you'd better be aware

1Fichier

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

1Fichier

This is a backend for the 1fichier cloud storage service. Note that a Premium subscription is required to use the API.

Paths are specified as remote:path

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

Configuration

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
Configuration complete.
Options:
- type: fichier
- api_key: example_key
Keep this "remote" remote?
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 (replace remote with the name you gave your remote):

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

Modification times 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 the first or last character in the name:

Character	Value	Replacement
SP	0x20	␠

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

Standard options

Here are the Standard options specific to fichier (1Fichier).

--fichier-api-key

Your API Key, get it from https://1fichier.com/console/params.pl.

Properties:

Config: api_key
Env Var: RCLONE_FICHIER_API_KEY
Type: string
Required: false

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.

Properties:

Config: shared_folder
Env Var: RCLONE_FICHIER_SHARED_FOLDER
Type: string
Required: false

--fichier-file-password

If you want to download a shared file that is password protected, add this parameter.

NB Input to this must be obscured - see rclone obscure.

Properties:

Config: file_password
Env Var: RCLONE_FICHIER_FILE_PASSWORD
Type: string
Required: false

--fichier-folder-password

If you want to list the files in a shared folder that is password protected, add this parameter.

NB Input to this must be obscured - see rclone obscure.

Properties:

Config: folder_password
Env Var: RCLONE_FICHIER_FOLDER_PASSWORD
Type: string
Required: false

--fichier-cdn

Set if you wish to use CDN download links.

Properties:

Config: cdn
Env Var: RCLONE_FICHIER_CDN
Type: bool
Default: false

--fichier-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

Config: encoding
Env Var: RCLONE_FICHIER_ENCODING
Type: Encoding
Default: Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot

--fichier-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_FICHIER_DESCRIPTION
Type: string
Required: false

Limitations

rclone about is not supported by the 1Fichier backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

See List of backends that do not support rclone about and rclone about.

Akamai Netstorage

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Akamai NetStorage

Paths are specified as remote: You may put subdirectories in too, e.g. remote:/path/to/dir. If you have a CP code you can use that as the folder after the domain such as <domain>/<cpcode>/<internal directories within cpcode>.

For example, this is commonly configured with or without a CP code:

With a CP code. [your-domain-prefix]-nsu.akamaihd.net/123456/subdirectory/
Without a CP code. [your-domain-prefix]-nsu.akamaihd.net

See all buckets

rclone lsd remote:

The initial setup for Netstorage involves getting an account and secret. Use rclone config to walk you through the setup process.

Configuration

Here's an example of how to make a remote called ns1.

To begin the interactive configuration process, enter this command:
```
rclone config
```

Type n to create a new remote.

n) New remote
d) Delete remote
q) Quit config
e/n/d/q> n

For this example, enter ns1 when you reach the name> prompt.
```
name> ns1
```

Enter netstorage as the 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
XX / NetStorage
   \ "netstorage"
Storage> netstorage

Select between the HTTP or HTTPS protocol. Most users should choose HTTPS, which is the default. HTTP is provided primarily for debugging purposes.

Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / HTTP protocol
   \ "http"
 2 / HTTPS protocol
   \ "https"
protocol> 1

Specify your NetStorage host, CP code, and any necessary content paths using this format: <domain>/<cpcode>/<content>/
```
Enter a string value. Press Enter for the default ("").
host> baseball-nsu.akamaihd.net/123456/content/
```

Set the netstorage account name

Enter a string value. Press Enter for the default ("").
account> username

Set the Netstorage account secret/G2O key which will be used for authentication purposes. Select the y option to set your own password then enter your secret. Note: The secret is stored in the rclone.conf file with hex-encoded encryption.
```
y) Yes type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
```

View the summary and confirm your remote configuration.

[ns1]
type = netstorage
protocol = http
host = baseball-nsu.akamaihd.net/123456/content/
account = username
secret = *** ENCRYPTED ***
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This remote is called ns1 and can now be used.

Example operations

Get started with rclone and NetStorage with these examples. For additional rclone commands, visit https://rclone.org/commands/.

See contents of a directory in your project

rclone lsd ns1:/974012/testing/

Sync the contents local with remote

rclone sync . ns1:/974012/testing/

Upload local content to remote

rclone copy notes.txt ns1:/974012/testing/

Delete content on remote

rclone delete ns1:/974012/testing/notes.txt

Move or copy content between CP codes

Your credentials must have access to two CP codes on the same remote. You can't perform operations between different remotes.

rclone move ns1:/974012/testing/notes.txt ns1:/974450/testing2/

Features

Symlink Support

The Netstorage backend changes the rclone --links, -l behavior. When uploading, instead of creating the .rclonelink file, use the "symlink" API in order to create the corresponding symlink on the remote. The .rclonelink file will not be created, the upload will be intercepted and only the symlink file that matches the source file name with no suffix will be created on the remote.

This will effectively allow commands like copy/copyto, move/moveto and sync to upload from local to remote and download from remote to local directories with symlinks. Due to internal rclone limitations, it is not possible to upload an individual symlink file to any remote backend. You can always use the "backend symlink" command to create a symlink on the NetStorage server, refer to "symlink" section below.

Individual symlink files on the remote can be used with the commands like "cat" to print the destination name, or "delete" to delete symlink, or copy, copy/to and move/moveto to download from the remote to local. Note: individual symlink files on the remote should be specified including the suffix .rclonelink.

Note: No file with the suffix .rclonelink should ever exist on the server since it is not possible to actually upload/create a file with .rclonelink suffix with rclone, it can only exist if it is manually created through a non-rclone method on the remote.

Implicit vs. Explicit Directories

With NetStorage, directories can exist in one of two forms:

Explicit Directory. This is an actual, physical directory that you have created in a storage group.
Implicit Directory. This refers to a directory within a path that has not been physically created. For example, during upload of a file, nonexistent subdirectories can be specified in the target path. NetStorage creates these as "implicit." While the directories aren't physically created, they exist implicitly and the noted path is connected with the uploaded file.

Rclone will intercept all file uploads and mkdir commands for the NetStorage remote and will explicitly issue the mkdir command for each directory in the uploading path. This will help with the interoperability with the other Akamai services such as SFTP and the Content Management Shell (CMShell). Rclone will not guarantee correctness of operations with implicit directories which might have been created as a result of using an upload API directly.

`--fast-list` / ListR support

NetStorage remote supports the ListR feature by using the "list" NetStorage API action to return a lexicographical list of all objects within the specified CP code, recursing into subdirectories as they're encountered.

Rclone will use the ListR method for some commands by default. Commands such as lsf -R will use ListR by default. To disable this, include the --disable listR option to use the non-recursive method of listing objects.
Rclone will not use the ListR method for some commands. Commands such as sync don't use ListR by default. To force using the ListR method, include the --fast-list option.

There are pros and cons of using the ListR method, refer to rclone documentation. In general, the sync command over an existing deep tree on the remote will run faster with the "--fast-list" flag but with extra memory usage as a side effect. It might also result in higher CPU utilization but the whole task can be completed faster.

Note: There is a known limitation that "lsf -R" will display number of files in the directory and directory size as -1 when ListR method is used. The workaround is to pass "--disable listR" flag if these numbers are important in the output.

Purge

NetStorage remote supports the purge feature by using the "quick-delete" NetStorage API action. The quick-delete action is disabled by default for security reasons and can be enabled for the account through the Akamai portal. Rclone will first try to use quick-delete action for the purge command and if this functionality is disabled then will fall back to a standard delete method.

Note: Read the NetStorage Usage API for considerations when using "quick-delete". In general, using quick-delete method will not delete the tree immediately and objects targeted for quick-delete may still be accessible.

Standard options

Here are the Standard options specific to netstorage (Akamai NetStorage).

--netstorage-host

Domain+path of NetStorage host to connect to.

Format should be <domain>/<internal folders>

Properties:

Config: host
Env Var: RCLONE_NETSTORAGE_HOST
Type: string
Required: true

--netstorage-account

Set the NetStorage account name

Properties:

Config: account
Env Var: RCLONE_NETSTORAGE_ACCOUNT
Type: string
Required: true

--netstorage-secret

Set the NetStorage account secret/G2O key for authentication.

Please choose the 'y' option to set your own password then enter your secret.

NB Input to this must be obscured - see rclone obscure.

Properties:

Config: secret
Env Var: RCLONE_NETSTORAGE_SECRET
Type: string
Required: true

Advanced options

Here are the Advanced options specific to netstorage (Akamai NetStorage).

--netstorage-protocol

Select between HTTP or HTTPS protocol.

Most users should choose HTTPS, which is the default. HTTP is provided primarily for debugging purposes.

Properties:

Config: protocol
Env Var: RCLONE_NETSTORAGE_PROTOCOL
Type: string
Default: "https"
Examples:
- "http"
  - HTTP protocol
- "https"
  - HTTPS protocol

--netstorage-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_NETSTORAGE_DESCRIPTION
Type: string
Required: false

Backend commands

Here are the commands specific to the netstorage backend.

Run them with:

rclone backend COMMAND remote:

The help below will explain what arguments each command takes.

See the backend command for more info on how to pass options and arguments.

These can be run on a running backend using the rc command backend/command.

du

Return disk usage information for a specified directory.

rclone backend du remote: [options] [<arguments>+]

The usage information returned, includes the targeted directory as well as all files stored in any sub-directories that may exist.

symlink

You can create a symbolic link in ObjectStore with the symlink action.

rclone backend symlink remote: [options] [<arguments>+]

The desired path location (including applicable sub-directories) ending in the object that will be the target of the symlink (for example, /links/mylink). Include the file extension for the object, if applicable.

Usage example:

rclone backend symlink <src> <path>

Alias

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Alias

The alias remote provides a new name for another remote.

Paths may be as deep as required or a local path, e.g. remote:directory/subdirectory or /directory/subdirectory.

During the initial setup with rclone config you will specify the target remote. The target remote can either be a local path or another remote.

Subfolders can be used in target remote. Assume an alias remote named backup with the target mydrive:private/backup. Invoking rclone mkdir backup:desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/desktop.

There will be no special handling of paths containing .. segments. Invoking rclone mkdir backup:../desktop is exactly the same as invoking rclone mkdir mydrive:private/backup/../desktop. The empty path is not allowed as a remote. To alias the current directory use . instead.

The target remote can also be a connection string. This can be used to modify the config of a remote for different uses, e.g. the alias myDriveTrash with the target remote myDrive,trashed_only: can be used to only show the trashed files in myDrive.

Configuration

Here is an example of how to make an alias called remote for local folder. First run:

rclone config

This will guide you through an interactive setup process:

No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Alias for an existing remote
   \ "alias"
[snip]
Storage> alias
Remote or path to alias.
Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
remote> /mnt/storage/backup
Remote config
Configuration complete.
Options:
- type: alias
- remote: /mnt/storage/backup
Keep this "remote" remote?
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 (replace remote with the name you gave your remote):

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

Properties:

Config: remote
Env Var: RCLONE_ALIAS_REMOTE
Type: string
Required: true

Advanced options

Here are the Advanced options specific to alias (Alias for an existing remote).

--alias-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_ALIAS_DESCRIPTION
Type: string
Required: false

Amazon Drive

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Amazon Drive

Amazon Drive, formerly known as Amazon Cloud Drive, was a cloud storage service run by Amazon for consumers.

From 2023-12-31, Amazon Drive has been discontinued by Amazon so the Amazon Drive backend has been removed.

You can still use Amazon Photos to access your photos and videos.

Amazon S3

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Amazon S3 Storage Providers

The S3 backend can be used with a number of different providers:

AWS S3 Home Config
Alibaba Cloud (Aliyun) Object Storage System (OSS) Home Config
Ceph Home Config
China Mobile Ecloud Elastic Object Storage (EOS) Home Config
Cloudflare R2 Home Config
Arvan Cloud Object Storage (AOS) Home Config
Bizfly Cloud Simple Storage Home Config
Cubbit DS3 Home Config
DigitalOcean Spaces Home Config
Dreamhost Home Config
Exaba Home Config
Fastly Object Storage Home Config
FileLu S5 (S3-Compatible Object Storage) Home Config
GCS Home Config
Hetzner Home Config
Hitachi Content Platform (HCP) Home Config
Huawei OBS Home Config
IBM COS S3 Home Config
IDrive e2 Home Config
Impossible Cloud Home Config
Intercolo Object Storage Home Config
IONOS Cloud Home Config
Leviia Object Storage Home Config
Liara Object Storage Home Config
Linode Object Storage Home Config
Magalu Object Storage Home Config
MEGA S4 Object Storage Home Config
Minio Home Config
Outscale Home Config
OVHcloud Home Config
Petabox Home Config
Pure Storage FlashBlade Home Config
Qiniu Cloud Object Storage (Kodo) Home Config
Rabata Cloud Storage Home Config
RackCorp Object Storage Home Config
Rclone Serve S3 Home Config
Scaleway Home Config
Seagate Lyve Cloud Home Config
SeaweedFS Home Config
Selectel Home Config
Servercore Object Storage Home Config
Spectra Logic Home Config
Storj Home Config
Synology C2 Object Storage Home Config
Tencent Cloud Object Storage (COS) Home Config
US3 Home Config
Wasabi Home Config
Zadara Object Storage Home Config
Zata Home Config

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

Once you have made a remote (see the provider specific section above) you can use it like this:

See all buckets

rclone lsd remote:

Make a new bucket

rclone mkdir remote:bucket

List the contents of a bucket

rclone ls remote:bucket

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

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

Configuration

Here is an example of making an s3 configuration for the AWS S3 provider. Most applies to the other providers as well, any differences are described below.

First run

rclone config

This will guide you through an interactive setup process.

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "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 / DigitalOcean 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 Pacific (Hong Kong) Region
14 | Needs location constraint ap-east-1.
   \ "ap-east-1"
   / South America (Sao Paulo) Region
15 | Needs location constraint sa-east-1.
   \ "sa-east-1"
region> 1
Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region.
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 Flexible Retrieval storage class
   \ "GLACIER"
 7 / Glacier Deep Archive storage class
   \ "DEEP_ARCHIVE"
 8 / Intelligent-Tiering storage class
   \ "INTELLIGENT_TIERING"
 9 / Glacier Instant Retrieval storage class
   \ "GLACIER_IR"
storage_class> 1
Remote config
Configuration complete.
Options:
- 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:
Keep this "remote" remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d>

Modification times and hashes

Modification times

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

If the modification time needs to be updated rclone will attempt to perform a server side copy to update the modification if the object can be copied in a single part. In the case the object is larger than 5Gb or is in Glacier or Glacier Deep Archive storage the object will be uploaded rather than copied.

Note that reading this from the object takes an additional HEAD request as the metadata isn't returned in object listings.

Hashes

For small objects which weren't uploaded as multipart uploads (objects sized below --s3-upload-cutoff if uploaded with rclone) rclone uses the ETag: header as an MD5 checksum.

However for objects which were uploaded as multipart uploads or with server side encryption (SSE-AWS or SSE-C) the ETag header is no longer the MD5 sum of the data, so rclone adds an additional piece of metadata X-Amz-Meta-Md5chksum which is a base64 encoded MD5 hash (in the same format as is required for Content-MD5). You can use base64 -d and hexdump to check this value manually:

echo 'VWTGdNx3LyXQDfA0e2Edxw==' | base64 -d | hexdump

or you can use rclone check to verify the hashes are OK.

For large objects, calculating this hash can take some time so the addition of this hash can be disabled with --s3-disable-checksum. This will mean that these objects do not have an MD5 checksum.

Note that reading this from the object takes an additional HEAD request as the metadata isn't returned in object listings.

Reducing costs

Avoiding HEAD requests to read the modification time

By default, rclone will use the modification time of objects stored in S3 for syncing. This is stored in object metadata which unfortunately takes an extra HEAD request to read which can be expensive (in time and money).

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

The extra API calls can be avoided when syncing (using rclone sync or rclone copy) in a few different ways, each with its own tradeoffs.

--size-only
- Only checks the size of files.
- Uses no extra transactions.
- If the file doesn't change size then rclone won't detect it has changed.
- rclone sync --size-only /path/to/source s3:bucket
--checksum
- Checks the size and MD5 checksum of files.
- Uses no extra transactions.
- The most accurate detection of changes possible.
- Will cause the source to read an MD5 checksum which, if it is a local disk, will cause lots of disk activity.
- If the source and destination are both S3 this is the recommended flag to use for maximum efficiency.
- rclone sync --checksum /path/to/source s3:bucket
--update --use-server-modtime
- Uses no extra transactions.
- Modification time becomes the time the object was uploaded.
- For many operations this is sufficient to determine if it needs uploading.
- Using --update along with --use-server-modtime, avoids the extra API call and uploads files whose local modification time is newer than the time it was last uploaded.
- Files created with timestamps in the past will be missed by the sync.
- rclone sync --update --use-server-modtime /path/to/source s3:bucket

These flags can and should be used in combination with --fast-list - see below.

If using rclone mount or any command using the VFS (eg rclone serve) commands then you might want to consider using the VFS flag --no-modtime which will stop rclone reading the modification time for every object. You could also use --use-server-modtime if you are happy with the modification times of the objects being the time of upload.

Avoiding GET requests to read directory listings

Rclone's default directory traversal is to process each directory individually. This takes one API call per directory. Using the --fast-list flag will read all info about the objects into memory first using a smaller number of API calls (one per 1000 objects). See the rclone docs for more details.

rclone sync --fast-list --checksum /path/to/source s3:bucket

--fast-list trades off API transactions for memory use. As a rough guide rclone uses 1k of memory per object stored, so using --fast-list on a sync of a million objects will use roughly 1 GiB of RAM.

If you are only copying a small number of files into a big repository then using --no-traverse is a good idea. This finds objects directly instead of through directory listings. You can do a "top-up" sync very cheaply by using --max-age and --no-traverse to copy only recent files, eg

rclone copy --max-age 24h --no-traverse /path/to/source s3:bucket

You'd then do a full rclone sync less often.

Note that --fast-list isn't required in the top-up sync.

Avoiding HEAD requests after PUT

By default, rclone will HEAD every object it uploads. It does this to check the object got uploaded correctly.

You can disable this with the --s3-no-head option - see there for more details.

Setting this flag increases the chance for undetected upload failures.

Increasing performance

Using server-side copy

If you are copying objects between S3 buckets in the same region, you should use server-side copy. This is much faster than downloading and re-uploading the objects, as no data is transferred.

For rclone to use server-side copy, you must use the same remote for the source and destination.

rclone copy s3:source-bucket s3:destination-bucket

When using server-side copy, the performance is limited by the rate at which rclone issues API requests to S3. See below for how to increase the number of API requests rclone makes.

Increasing the rate of API requests

You can increase the rate of API requests to S3 by increasing the parallelism using --transfers and --checkers options.

Rclone uses a very conservative defaults for these settings, as not all providers support high rates of requests. Depending on your provider, you can increase significantly the number of transfers and checkers.

For example, with AWS S3, if you can increase the number of checkers to values like 200. If you are doing a server-side copy, you can also increase the number of transfers to 200.

rclone sync --transfers 200 --checkers 200 --checksum s3:source-bucket s3:destination-bucket

You will need to experiment with these values to find the optimal settings for your setup.

Data integrity

Rclone does its best to verify every part of an upload or download to the s3 provider using various hashes.

Every HTTP transaction to/from the provider has a X-Amz-Content-Sha256 or a Content-Md5 header to guard against corruption of the HTTP body. The HTTP Header is protected by the signature passed in the Authorization header.

All communications with the provider is done over https for encryption and additional error protection.

Single part uploads

Rclone uploads single part uploads with a Content-Md5 using the MD5 hash read from the source. The provider checks this is correct on receipt of the data.
Rclone then does a HEAD request (disable with --s3-no-head) to read the ETag back which is the MD5 of the file and checks that with what it sent.

Note that if the source does not have an MD5 then the single part uploads will not have hash protection. In this case it is recommended to use --s3-upload-cutoff 0 so all files are uploaded as multipart uploads.

Multipart uploads

For files above --s3-upload-cutoff rclone splits the file into multiple parts for upload.

Each part is protected with both an X-Amz-Content-Sha256 and a Content-Md5

When rclone has finished the upload of all the parts it then completes the upload by sending:

The MD5 hash of each part
The number of parts
This info is all protected with a X-Amz-Content-Sha256

The provider checks the MD5 for all the parts it has received against what rclone sends and if it is good it returns OK.

Rclone then does a HEAD request (disable with --s3-no-head) and checks the ETag is what it expects (in this case it should be the MD5 sum of all the MD5 sums of all the parts with the number of parts on the end).

If the source has an MD5 sum then rclone will attach the X-Amz-Meta-Md5chksum with it as the ETag for a multipart upload can't easily be checked against the file as the chunk size must be known in order to calculate it.

Downloads

Rclone checks the MD5 hash of the data downloaded against either the ETag or the X-Amz-Meta-Md5chksum metadata (if present) which rclone uploads with multipart uploads.

Further checking

At each stage rclone and the provider are sending and checking hashes of everything. Rclone deliberately HEADs each object after upload to check it arrived safely for extra security. (You can disable this with --s3-no-head).

If you require further assurance that your data is intact you can use rclone check to check the hashes locally vs the remote.

And if you are feeling ultimately paranoid use rclone check --download which will download the files and check them against the local copies. (Note that this doesn't use disk to do this - it streams them in memory).

Versions

When bucket versioning is enabled (this can be done with rclone with the rclone backend versioning command) 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.

Old versions of files, where available, are visible using the --s3-versions flag.

It is also possible to view a bucket as it was at a certain point in time, using the --s3-version-at flag. This will show the file versions as they were at that time, showing files that have been deleted afterwards, and hiding files that were created since.

If you wish to remove all the old versions then you can use the rclone backend cleanup-hidden remote:bucket command which will delete all the old hidden versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, e.g. rclone backend cleanup-hidden remote:bucket/path/to/stuff.

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 --s3-versions flag.

$ rclone -q ls s3:cleanup-test
        9 one.txt

$ rclone -q --s3-versions ls s3:cleanup-test
        9 one.txt
        8 one-v2016-07-04-141032-000.txt
       16 one-v2016-07-04-141003-000.txt
       15 one-v2016-07-02-155621-000.txt

Retrieve an old version

$ rclone -q --s3-versions copy s3:cleanup-test/one-v2016-07-04-141003-000.txt /tmp

$ ls -l /tmp/one-v2016-07-04-141003-000.txt
-rw-rw-r-- 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt

Clean up all the old versions and show that they've gone.

$ rclone -q backend cleanup-hidden s3:cleanup-test

$ rclone -q ls s3:cleanup-test
        9 one.txt

$ rclone -q --s3-versions ls s3:cleanup-test
        9 one.txt

Versions naming caveat

When using --s3-versions flag rclone is relying on the file name to work out whether the objects are versions or not. Versions' names are created by inserting timestamp between file name and its extension.

        9 file.txt
        8 file-v2023-07-17-161032-000.txt
       16 file-v2023-06-15-141003-000.txt

If there are real files present with the same names as versions, then behaviour of --s3-versions can be unpredictable.

Cleanup

If you run rclone cleanup s3:bucket then it will remove all pending multipart uploads older than 24 hours. You can use the --interactive/i or --dry-run flag to see exactly what it will do. If you want more control over the expiry date then run rclone backend cleanup s3:bucket -o max-age=1h to expire all uploads older than one hour. You can use rclone backend list-multipart-uploads s3:bucket to see the pending multipart uploads.

Restricted filename characters

S3 allows any valid UTF-8 string as a key.

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

The following characters are replaced since these are problematic when dealing with the REST API:

Character	Value	Replacement
NUL	0x00	␀
/	0x2F	／

The encoding will also encode these file names as they don't seem to work with the SDK properly:

File name	Replacement
.	．
..	．．

Important note about double slashes (`//`)

Object keys containing consecutive forward slashes (//) are not supported by rclone.

When rclone encounters an object key with // (e.g., a//b), it will normalize the path to use a single slash (e.g., a/b). This normalization can cause "object not found" errors when trying to access the original object, as rclone will look for the normalized path instead of the actual object key.

Example:

Original S3 object key: folder//file.txt
rclone interprets it as: folder/file.txt
Result: "object not found" error when trying to access folder//file.txt

Workaround: Avoid using consecutive forward slashes (//) in S3 object keys when using rclone. If you have existing objects with // in their keys, you will need to rename them to use single slashes or access them through other means.

Multipart uploads

rclone supports multipart uploads with S3 which means that it can upload files bigger than 5 GiB.

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 5 GiB 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 extra memory equal to: --transfers × --s3-upload-concurrency × --s3-chunk-size. Single part uploads do not use extra memory.

Single part transfers can be faster than multipart transfers or slower depending on your latency from S3 - the more latency, the more likely single part transfers will be faster.

Increasing --s3-upload-concurrency will increase throughput (8 would be a sensible value) and increasing --s3-chunk-size also increases throughput (16M would be sensible). Increasing either of these will use more memory. The default values are high enough to gain most of the possible performance without using too much memory.

Buckets and Regions

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

Authentication

There are a number of ways to supply rclone with a set of AWS credentials, with and without using the environment.

The different authentication methods are tried in this order:

Directly in the rclone configuration file (env_auth = false in the config file):
- access_key_id and secret_access_key are required.
- session_token can be optionally set when using AWS STS.
Runtime configuration (env_auth = true in the config file):
- Export the following environment variables before running rclone:
  - Access Key ID: AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY
  - Secret Access Key: AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY
  - Session Token: AWS_SESSION_TOKEN (optional)
- Or, use a named profile:
  - Profile files are standard files used by AWS CLI tools
  - By default it will use the profile in your home directory (e.g. ~/.aws/credentials on unix based systems) file and the "default" profile, to change set these environment variables or config keys:
    - AWS_SHARED_CREDENTIALS_FILE to control which file or the shared_credentials_file config key.
    - AWS_PROFILE to control which profile to use or the profile config key.
- 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).
- Or, use process credentials to read config from an external program.

With env_auth = true rclone (which uses the SDK for Go v2) should support all authentication methods that the aws CLI tool does and the other AWS SDKs.

If none of these option actually end up providing rclone with AWS credentials then S3 interaction will be non-authenticated (see the anonymous access section for more info).

Assume Role (Cross-Account Access)

If you need to access S3 resources in a different AWS account, you can use IAM role assumption. This is useful for cross-account access scenarios where you have credentials in one account but need to access resources in another account.

To use assume role, configure the following parameters:

role_arn - The ARN (Amazon Resource Name) of the IAM role to assume in the target account. Format: arn:aws:iam::ACCOUNT-ID:role/ROLE-NAME
role_session_name (optional) - A name for the assumed role session. If not specified, rclone will generate one automatically.
role_session_duration (optional) - Duration for which the assumed role credentials are valid. If not specified, AWS default duration will be used (typically 1 hour).
role_external_id (optional) - An external ID required by the role's trust policy for additional security. This is typically used when the role is accessed by a third party.

The assume role feature works with both direct credentials (env_auth = false) and environment-based authentication (env_auth = true). Rclone will first authenticate using the base credentials, then use those credentials to assume the specified role.

Example configuration for cross-account access:

[s3-cross-account]
type = s3
provider = AWS
env_auth = true
region = us-east-1
role_arn = arn:aws:iam::123456789012:role/CrossAccountS3Role
role_session_name = rclone-session
role_external_id = unique-role-external-id-12345

In this example:

Base credentials are obtained from the environment (IAM role, credentials file, or environment variables)
These credentials are then used to assume the role CrossAccountS3Role in account 123456789012
An external ID is provided for additional security as required by the role's trust policy

The target role's trust policy in the destination account must allow the source account or user to assume it. Example trust policy:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::SOURCE-ACCOUNT-ID:root"
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "sts:ExternalID": "unique-role-external-id-12345"
        }
      }
    }
  ]
}

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
CreateBucket (unless using s3-no-check-bucket)

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:

This is a policy that can be used when creating bucket. It assumes that USER_NAME has been created.
The Resource entry must include both resource ARNs, as one implies the bucket and the other implies the bucket's objects.
When using s3-no-check-bucket and the bucket already exists, the "arn:aws:s3:::BUCKET_NAME" doesn't have to be included.

For reference, here's an Ansible script that will generate one or more buckets that will work with rclone sync.

Key Management System (KMS)

If you are using server-side encryption with KMS then you must make sure rclone is configured with server_side_encryption = aws:kms otherwise you will find you can't transfer small objects - these will create checksum errors.

Glacier and Glacier Deep Archive

You can upload objects using the glacier storage class or transition them to glacier using a lifecycle policy. The bucket can still be synced or copied into normally, but if rclone tries to access data from the glacier storage class you will see an error like below.

2017/09/11 19:07:43 Failed to sync: failed to open source object: Object in GLACIER, restore first: path/to/file

In this case you need to restore the object(s) in question before accessing object contents. The restore section below shows how to do this with rclone.

Note that rclone only speaks the S3 API it does not speak the Glacier Vault API, so rclone cannot directly access Glacier Vaults.

Object-lock enabled S3 bucket

According to AWS's documentation on S3 Object Lock:

If you configure a default retention period on a bucket, requests to upload objects in such a bucket must include the Content-MD5 header.

Rclone automatically computes and includes the Content-MD5 header when uploading objects with Object Lock parameters set. No special configuration is needed.

Setting Object Lock retention

Rclone supports setting Object Lock retention on uploaded objects with the following options:

--s3-object-lock-mode - Set the Object Lock mode (GOVERNANCE or COMPLIANCE)
--s3-object-lock-retain-until-date - Set the retention date (RFC3339 format or duration like 365d, 24h)
--s3-object-lock-legal-hold-status - Set legal hold (ON or OFF)

Example - upload files with 1 year GOVERNANCE retention:

rclone copy local:/data remote:bucket \
    --s3-object-lock-mode GOVERNANCE \
    --s3-object-lock-retain-until-date 365d

Copying Object Lock settings from source

When using --metadata, you can use the special value copy to preserve the source object's Object Lock settings:

rclone copy source:bucket dest:bucket \
    --metadata \
    --s3-object-lock-mode copy \
    --s3-object-lock-retain-until-date copy

You can also mix copied and explicit values. For example, to change the mode from COMPLIANCE to GOVERNANCE while preserving the original retention date:

rclone copy source:bucket dest:bucket \
    --metadata \
    --s3-object-lock-mode GOVERNANCE \
    --s3-object-lock-retain-until-date copy

Additional Object Lock options

--s3-bypass-governance-retention - Required to delete or overwrite objects with GOVERNANCE mode retention before the retention date expires
--s3-bucket-object-lock-enabled - Enable Object Lock when creating a new bucket with rclone mkdir
--s3-object-lock-set-after-upload - Set Object Lock via separate API calls after upload (for providers that don't support Object Lock headers during PUT)

Standard options

Here are the Standard options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).

--s3-provider

Choose your S3 provider.

Properties:

Config: provider
Env Var: RCLONE_S3_PROVIDER
Type: string
Required: false
Examples:
- "AWS"
  - Amazon Web Services (AWS) S3
- "Alibaba"
  - Alibaba Cloud Object Storage System (OSS) formerly Aliyun
- "ArvanCloud"
  - Arvan Cloud Object Storage (AOS)
- "BizflyCloud"
  - Bizfly Cloud Simple Storage
- "Ceph"
  - Ceph Object Storage
- "ChinaMobile"
  - China Mobile Ecloud Elastic Object Storage (EOS)
- "Cloudflare"
  - Cloudflare R2 Storage
- "Cubbit"
  - Cubbit DS3 Object Storage
- "DigitalOcean"
  - DigitalOcean Spaces
- "Dreamhost"
  - Dreamhost DreamObjects
- "Exaba"
  - Exaba Object Storage
- "Fastly"
  - Fastly Object Storage
- "FileLu"
  - FileLu S5 (S3-Compatible Object Storage)
- "FlashBlade"
  - Pure Storage FlashBlade Object Storage
- "GCS"
  - Google Cloud Storage
- "HCP"
  - Hitachi Content Platform (HCP)
- "Hetzner"
  - Hetzner Object Storage
- "HuaweiOBS"
  - Huawei Object Storage Service
- "IBMCOS"
  - IBM COS S3
- "IDrive"
  - IDrive e2
- "ImpossibleCloud"
  - Impossible Cloud Object Storage
- "Intercolo"
  - Intercolo Object Storage
- "IONOS"
  - IONOS Cloud
- "Leviia"
  - Leviia Object Storage
- "Liara"
  - Liara Object Storage
- "Linode"
  - Linode Object Storage
- "LyveCloud"
  - Seagate Lyve Cloud
- "Magalu"
  - Magalu Object Storage
- "Mega"
  - MEGA S4 Object Storage
- "Minio"
  - Minio Object Storage
- "Netease"
  - Netease Object Storage (NOS)
- "Outscale"
  - OUTSCALE Object Storage (OOS)
- "OVHcloud"
  - OVHcloud Object Storage
- "Petabox"
  - Petabox Object Storage
- "Qiniu"
  - Qiniu Object Storage (Kodo)
- "Rabata"
  - Rabata Cloud Storage
- "RackCorp"
  - RackCorp Object Storage
- "Rclone"
  - Rclone S3 Server
- "Scaleway"
  - Scaleway Object Storage
- "SeaweedFS"
  - SeaweedFS S3
- "Selectel"
  - Selectel Object Storage
- "Servercore"
  - Servercore Object Storage
- "SpectraLogic"
  - Spectra Logic Black Pearl
- "Storj"
  - Storj (S3 Compatible Gateway)
- "Synology"
  - Synology C2 Object Storage
- "TencentCOS"
  - Tencent Cloud Object Storage (COS)
- "US3"
  - US3 Object Storage
- "Wasabi"
  - Wasabi Object Storage
- "Zadara"
  - Zadara Object Storage
- "Zata"
  - Zata (S3 compatible Gateway)
- "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.

Properties:

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.

Properties:

Config: access_key_id
Env Var: RCLONE_S3_ACCESS_KEY_ID
Type: string
Required: false

--s3-secret-access-key

AWS Secret Access Key (password).

Leave blank for anonymous access or runtime credentials.

Properties:

Config: secret_access_key
Env Var: RCLONE_S3_SECRET_ACCESS_KEY
Type: string
Required: false

--s3-region

Region to connect to.

Leave blank if you are using an S3 clone and you don't have a region.

Properties:

Config: region
Env Var: RCLONE_S3_REGION
Provider: AWS,BizflyCloud,Ceph,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,LyveCloud,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Scaleway,SeaweedFS,Selectel,Servercore,Synology,Wasabi,Zadara,Zata,Other
Type: string
Required: false
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.
  - Provider: AWS
- "us-east-2"
  - US East (Ohio) Region.
  - Needs location constraint us-east-2.
  - Provider: AWS
- "us-west-1"
  - US West (Northern California) Region.
  - Needs location constraint us-west-1.
  - Provider: AWS
- "us-west-2"
  - US West (Oregon) Region.
  - Needs location constraint us-west-2.
  - Provider: AWS
- "ca-central-1"
  - Canada (Central) Region.
  - Needs location constraint ca-central-1.
  - Provider: AWS
- "eu-west-1"
  - EU (Ireland) Region.
  - Needs location constraint EU or eu-west-1.
  - Provider: AWS
- "eu-west-2"
  - EU (London) Region.
  - Needs location constraint eu-west-2.
  - Provider: AWS
- "eu-west-3"
  - EU (Paris) Region.
  - Needs location constraint eu-west-3.
  - Provider: AWS
- "eu-north-1"
  - EU (Stockholm) Region.
  - Needs location constraint eu-north-1.
  - Provider: AWS
- "eu-south-1"
  - EU (Milan) Region.
  - Needs location constraint eu-south-1.
  - Provider: AWS
- "eu-central-1"
  - EU (Frankfurt) Region.
  - Needs location constraint eu-central-1.
  - Provider: AWS
- "ap-southeast-1"
  - Asia Pacific (Singapore) Region.
  - Needs location constraint ap-southeast-1.
  - Provider: AWS
- "ap-southeast-2"
  - Asia Pacific (Sydney) Region.
  - Needs location constraint ap-southeast-2.
  - Provider: AWS
- "ap-northeast-1"
  - Asia Pacific (Tokyo) Region.
  - Needs location constraint ap-northeast-1.
  - Provider: AWS
- "ap-northeast-2"
  - Asia Pacific (Seoul).
  - Needs location constraint ap-northeast-2.
  - Provider: AWS
- "ap-northeast-3"
  - Asia Pacific (Osaka-Local).
  - Needs location constraint ap-northeast-3.
  - Provider: AWS
- "ap-south-1"
  - Asia Pacific (Mumbai).
  - Needs location constraint ap-south-1.
  - Provider: AWS
- "ap-east-1"
  - Asia Pacific (Hong Kong) Region.
  - Needs location constraint ap-east-1.
  - Provider: AWS
- "sa-east-1"
  - South America (Sao Paulo) Region.
  - Needs location constraint sa-east-1.
  - Provider: AWS
- "il-central-1"
  - Israel (Tel Aviv) Region.
  - Needs location constraint il-central-1.
  - Provider: AWS
- "me-south-1"
  - Middle East (Bahrain) Region.
  - Needs location constraint me-south-1.
  - Provider: AWS
- "af-south-1"
  - Africa (Cape Town) Region.
  - Needs location constraint af-south-1.
  - Provider: AWS
- "cn-north-1"
  - China (Beijing) Region.
  - Needs location constraint cn-north-1.
  - Provider: AWS
- "cn-northwest-1"
  - China (Ningxia) Region.
  - Needs location constraint cn-northwest-1.
  - Provider: AWS
- "us-gov-east-1"
  - AWS GovCloud (US-East) Region.
  - Needs location constraint us-gov-east-1.
  - Provider: AWS
- "us-gov-west-1"
  - AWS GovCloud (US) Region.
  - Needs location constraint us-gov-west-1.
  - Provider: AWS
- "hn"
  - Ha Noi
  - Provider: BizflyCloud
- "hcm"
  - Ho Chi Minh
  - Provider: BizflyCloud
- ""
  - Use this if unsure.
  - Will use v4 signatures and an empty region.
  - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "other-v2-signature"
  - Use this only if v4 signatures don't work.
  - E.g. pre Jewel/v10 CEPH.
  - Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,SeaweedFS,Wasabi,Other
- "auto"
  - R2 buckets are automatically distributed across Cloudflare's data centers for low latency.
  - Provider: Cloudflare
- "eu-west-1"
  - Europe West
  - Provider: Cubbit
- "au-east-1"
  - AU East 1
  - Provider: Fastly
- "eu-central"
  - EU Central
  - Provider: Fastly
- "eu-south-1"
  - EU South 1
  - Provider: Fastly
- "eu-west-1"
  - EU West 1
  - Provider: Fastly
- "jp-central-1"
  - JP Central 1
  - Provider: Fastly
- "uk-east-1"
  - UK East 1
  - Provider: Fastly
- "us-central-1"
  - US Central 1
  - Provider: Fastly
- "us-east"
  - US East
  - Provider: Fastly
- "us-east-1"
  - US East 1
  - Provider: Fastly
- "us-west"
  - US West
  - Provider: Fastly
- "us-west-1"
  - US West 1
  - Provider: Fastly
- "global"
  - Global
  - Provider: FileLu
- "us-east"
  - North America (US-East)
  - Provider: FileLu
- "eu-central"
  - Europe (EU-Central)
  - Provider: FileLu
- "ap-southeast"
  - Asia Pacific (AP-Southeast)
  - Provider: FileLu
- "me-central"
  - Middle East (ME-Central)
  - Provider: FileLu
- "hel1"
  - Helsinki
  - Provider: Hetzner
- "fsn1"
  - Falkenstein
  - Provider: Hetzner
- "nbg1"
  - Nuremberg
  - Provider: Hetzner
- "af-south-1"
  - AF-Johannesburg
  - Provider: HuaweiOBS
- "ap-southeast-2"
  - AP-Bangkok
  - Provider: HuaweiOBS
- "ap-southeast-3"
  - AP-Singapore
  - Provider: HuaweiOBS
- "cn-east-3"
  - CN East-Shanghai1
  - Provider: HuaweiOBS
- "cn-east-2"
  - CN East-Shanghai2
  - Provider: HuaweiOBS
- "cn-north-1"
  - CN North-Beijing1
  - Provider: HuaweiOBS
- "cn-north-4"
  - CN North-Beijing4
  - Provider: HuaweiOBS
- "cn-south-1"
  - CN South-Guangzhou
  - Provider: HuaweiOBS
- "ap-southeast-1"
  - CN-Hong Kong
  - Provider: HuaweiOBS
- "sa-argentina-1"
  - LA-Buenos Aires1
  - Provider: HuaweiOBS
- "sa-peru-1"
  - LA-Lima1
  - Provider: HuaweiOBS
- "na-mexico-1"
  - LA-Mexico City1
  - Provider: HuaweiOBS
- "sa-chile-1"
  - LA-Santiago2
  - Provider: HuaweiOBS
- "sa-brazil-1"
  - LA-Sao Paulo1
  - Provider: HuaweiOBS
- "ru-northwest-2"
  - RU-Moscow2
  - Provider: HuaweiOBS
- "eu-central-2"
  - Frankfurt, Germany
  - Provider: ImpossibleCloud
- "eu-west-1"
  - Amsterdam, Netherlands
  - Provider: ImpossibleCloud
- "eu-west-2"
  - London, UK
  - Provider: ImpossibleCloud
- "eu-west-3"
  - Paris, France
  - Provider: ImpossibleCloud
- "eu-east-1"
  - Poznań, Poland
  - Provider: ImpossibleCloud
- "eu-north-1"
  - Copenhagen, Denmark
  - Provider: ImpossibleCloud
- "us-east-1"
  - New York, USA
  - Provider: ImpossibleCloud
- "de-fra"
  - Frankfurt, Germany
  - Provider: Intercolo
- "de"
  - Frankfurt, Germany
  - Provider: IONOS,OVHcloud
- "eu-central-2"
  - Berlin, Germany
  - Provider: IONOS
- "eu-central-3"
  - Berlin, Germany
  - Provider: IONOS
- "eu-central-4"
  - Frankfurt, Germany
  - Provider: IONOS
- "eu-south-2"
  - Logrono, Spain
  - Provider: IONOS
- "us-central-1"
  - Lenexa, USA
  - Provider: IONOS
- "eu-west-2"
  - Paris, France
  - Provider: Outscale
- "us-east-2"
  - New Jersey, USA
  - Provider: Outscale
- "us-west-1"
  - California, USA
  - Provider: Outscale
- "cloudgouv-eu-west-1"
  - SecNumCloud, Paris, France
  - Provider: Outscale
- "ap-northeast-1"
  - Tokyo, Japan
  - Provider: Outscale
- "gra"
  - Gravelines, France
  - Provider: OVHcloud
- "rbx"
  - Roubaix, France
  - Provider: OVHcloud
- "sbg"
  - Strasbourg, France
  - Provider: OVHcloud
- "eu-west-par"
  - Paris, France (3AZ)
  - Provider: OVHcloud
- "uk"
  - London, United Kingdom
  - Provider: OVHcloud
- "waw"
  - Warsaw, Poland
  - Provider: OVHcloud
- "bhs"
  - Beauharnois, Canada
  - Provider: OVHcloud
- "ca-east-tor"
  - Toronto, Canada
  - Provider: OVHcloud
- "sgp"
  - Singapore
  - Provider: OVHcloud
- "ap-southeast-syd"
  - Sydney, Australia
  - Provider: OVHcloud
- "ap-south-mum"
  - Mumbai, India
  - Provider: OVHcloud
- "us-east-va"
  - Vint Hill, Virginia, USA
  - Provider: OVHcloud
- "us-west-or"
  - Hillsboro, Oregon, USA
  - Provider: OVHcloud
- "rbx-archive"
  - Roubaix, France (Cold Archive)
  - Provider: OVHcloud
- "us-east-1"
  - US East (N. Virginia)
  - Provider: Petabox,Rabata
- "eu-central-1"
  - Europe (Frankfurt)
  - Provider: Petabox
- "ap-southeast-1"
  - Asia Pacific (Singapore)
  - Provider: Petabox
- "me-south-1"
  - Middle East (Bahrain)
  - Provider: Petabox
- "sa-east-1"
  - South America (São Paulo)
  - Provider: Petabox
- "cn-east-1"
  - The default endpoint - a good choice if you are unsure.
  - East China Region 1.
  - Needs location constraint cn-east-1.
  - Provider: Qiniu
- "cn-east-2"
  - East China Region 2.
  - Needs location constraint cn-east-2.
  - Provider: Qiniu
- "cn-north-1"
  - North China Region 1.
  - Needs location constraint cn-north-1.
  - Provider: Qiniu
- "cn-south-1"
  - South China Region 1.
  - Needs location constraint cn-south-1.
  - Provider: Qiniu
- "us-north-1"
  - North America Region.
  - Needs location constraint us-north-1.
  - Provider: Qiniu
- "ap-southeast-1"
  - Southeast Asia Region 1.
  - Needs location constraint ap-southeast-1.
  - Provider: Qiniu
- "ap-northeast-1"
  - Northeast Asia Region 1.
  - Needs location constraint ap-northeast-1.
  - Provider: Qiniu
- "eu-west-1"
  - EU (Ireland)
  - Provider: Rabata
- "eu-west-2"
  - EU (London)
  - Provider: Rabata
- "global"
  - Global CDN (All locations) Region
  - Provider: RackCorp
- "au"
  - Australia (All states)
  - Provider: RackCorp
- "au-nsw"
  - NSW (Australia) Region
  - Provider: RackCorp
- "au-qld"
  - QLD (Australia) Region
  - Provider: RackCorp
- "au-vic"
  - VIC (Australia) Region
  - Provider: RackCorp
- "au-wa"
  - Perth (Australia) Region
  - Provider: RackCorp
- "ph"
  - Manila (Philippines) Region
  - Provider: RackCorp
- "th"
  - Bangkok (Thailand) Region
  - Provider: RackCorp
- "hk"
  - HK (Hong Kong) Region
  - Provider: RackCorp
- "mn"
  - Ulaanbaatar (Mongolia) Region
  - Provider: RackCorp
- "kg"
  - Bishkek (Kyrgyzstan) Region
  - Provider: RackCorp
- "id"
  - Jakarta (Indonesia) Region
  - Provider: RackCorp
- "jp"
  - Tokyo (Japan) Region
  - Provider: RackCorp
- "sg"
  - SG (Singapore) Region
  - Provider: RackCorp
- "de"
  - Frankfurt (Germany) Region
  - Provider: RackCorp
- "us"
  - USA (AnyCast) Region
  - Provider: RackCorp
- "us-east-1"
  - New York (USA) Region
  - Provider: RackCorp
- "us-west-1"
  - Freemont (USA) Region
  - Provider: RackCorp
- "nz"
  - Auckland (New Zealand) Region
  - Provider: RackCorp
- "nl-ams"
  - Amsterdam, The Netherlands
  - Provider: Scaleway
- "fr-par"
  - Paris, France
  - Provider: Scaleway
- "pl-waw"
  - Warsaw, Poland
  - Provider: Scaleway
- "ru-1"
  - St. Petersburg
  - Provider: Selectel,Servercore
- "ru-3"
  - St. Petersburg
  - Provider: Selectel
- "ru-7"
  - Moscow
  - Provider: Selectel,Servercore
- "gis-1"
  - Moscow
  - Provider: Selectel,Servercore
- "kz-1"
  - Kazakhstan
  - Provider: Selectel
- "uz-2"
  - Uzbekistan
  - Provider: Selectel
- "uz-2"
  - Tashkent, Uzbekistan
  - Provider: Servercore
- "kz-1"
  - Almaty, Kazakhstan
  - Provider: Servercore
- "eu-001"
  - Europe Region 1
  - Provider: Synology
- "eu-002"
  - Europe Region 2
  - Provider: Synology
- "us-001"
  - US Region 1
  - Provider: Synology
- "us-002"
  - US Region 2
  - Provider: Synology
- "tw-001"
  - Asia (Taiwan)
  - Provider: Synology
- "us-east-1"
  - The default region.
  - Leave location constraint empty.
  - Provider: Zadara
- "us-east-1"
  - Indore, Madhya Pradesh, India
  - Provider: Zata

--s3-endpoint

Endpoint for S3 API.

Required when using an S3 clone.

Properties:

Config: endpoint
Env Var: RCLONE_S3_ENDPOINT
Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cloudflare,Cubbit,DigitalOcean,Dreamhost,Exaba,Fastly,FileLu,FlashBlade,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,Rabata,RackCorp,Rclone,Scaleway,SeaweedFS,Selectel,Servercore,SpectraLogic,Storj,Synology,TencentCOS,US3,Wasabi,Zadara,Zata,Other
Type: string
Required: false
Examples:
- "oss-accelerate.aliyuncs.com"
  - Global Accelerate
  - Provider: Alibaba
- "oss-accelerate-overseas.aliyuncs.com"
  - Global Accelerate (outside mainland China)
  - Provider: Alibaba
- "oss-cn-hangzhou.aliyuncs.com"
  - East China 1 (Hangzhou)
  - Provider: Alibaba
- "oss-cn-shanghai.aliyuncs.com"
  - East China 2 (Shanghai)
  - Provider: Alibaba
- "oss-cn-qingdao.aliyuncs.com"
  - North China 1 (Qingdao)
  - Provider: Alibaba
- "oss-cn-beijing.aliyuncs.com"
  - North China 2 (Beijing)
  - Provider: Alibaba
- "oss-cn-zhangjiakou.aliyuncs.com"
  - North China 3 (Zhangjiakou)
  - Provider: Alibaba
- "oss-cn-huhehaote.aliyuncs.com"
  - North China 5 (Hohhot)
  - Provider: Alibaba
- "oss-cn-wulanchabu.aliyuncs.com"
  - North China 6 (Ulanqab)
  - Provider: Alibaba
- "oss-cn-shenzhen.aliyuncs.com"
  - South China 1 (Shenzhen)
  - Provider: Alibaba
- "oss-cn-heyuan.aliyuncs.com"
  - South China 2 (Heyuan)
  - Provider: Alibaba
- "oss-cn-guangzhou.aliyuncs.com"
  - South China 3 (Guangzhou)
  - Provider: Alibaba
- "oss-cn-chengdu.aliyuncs.com"
  - West China 1 (Chengdu)
  - Provider: Alibaba
- "oss-cn-hongkong.aliyuncs.com"
  - Hong Kong (Hong Kong)
  - Provider: Alibaba
- "oss-us-west-1.aliyuncs.com"
  - US West 1 (Silicon Valley)
  - Provider: Alibaba
- "oss-us-east-1.aliyuncs.com"
  - US East 1 (Virginia)
  - Provider: Alibaba
- "oss-ap-southeast-1.aliyuncs.com"
  - Southeast Asia Southeast 1 (Singapore)
  - Provider: Alibaba
- "oss-ap-southeast-2.aliyuncs.com"
  - Asia Pacific Southeast 2 (Sydney)
  - Provider: Alibaba
- "oss-ap-southeast-3.aliyuncs.com"
  - Southeast Asia Southeast 3 (Kuala Lumpur)
  - Provider: Alibaba
- "oss-ap-southeast-5.aliyuncs.com"
  - Asia Pacific Southeast 5 (Jakarta)
  - Provider: Alibaba
- "oss-ap-northeast-1.aliyuncs.com"
  - Asia Pacific Northeast 1 (Japan)
  - Provider: Alibaba
- "oss-ap-south-1.aliyuncs.com"
  - Asia Pacific South 1 (Mumbai)
  - Provider: Alibaba
- "oss-eu-central-1.aliyuncs.com"
  - Central Europe 1 (Frankfurt)
  - Provider: Alibaba
- "oss-eu-west-1.aliyuncs.com"
  - West Europe (London)
  - Provider: Alibaba
- "oss-me-east-1.aliyuncs.com"
  - Middle East 1 (Dubai)
  - Provider: Alibaba
- "s3.ir-thr-at1.arvanstorage.ir"
  - The default endpoint - a good choice if you are unsure.
  - Tehran Iran (Simin)
  - Provider: ArvanCloud
- "s3.ir-tbz-sh1.arvanstorage.ir"
  - Tabriz Iran (Shahriar)
  - Provider: ArvanCloud
- "hn.ss.bfcplatform.vn"
  - Hanoi endpoint
  - Provider: BizflyCloud
- "hcm.ss.bfcplatform.vn"
  - Ho Chi Minh endpoint
  - Provider: BizflyCloud
- "eos-wuxi-1.cmecloud.cn"
  - The default endpoint - a good choice if you are unsure.
  - East China (Suzhou)
  - Provider: ChinaMobile
- "eos-jinan-1.cmecloud.cn"
  - East China (Jinan)
  - Provider: ChinaMobile
- "eos-ningbo-1.cmecloud.cn"
  - East China (Hangzhou)
  - Provider: ChinaMobile
- "eos-shanghai-1.cmecloud.cn"
  - East China (Shanghai-1)
  - Provider: ChinaMobile
- "eos-zhengzhou-1.cmecloud.cn"
  - Central China (Zhengzhou)
  - Provider: ChinaMobile
- "eos-hunan-1.cmecloud.cn"
  - Central China (Changsha-1)
  - Provider: ChinaMobile
- "eos-zhuzhou-1.cmecloud.cn"
  - Central China (Changsha-2)
  - Provider: ChinaMobile
- "eos-guangzhou-1.cmecloud.cn"
  - South China (Guangzhou-2)
  - Provider: ChinaMobile
- "eos-dongguan-1.cmecloud.cn"
  - South China (Guangzhou-3)
  - Provider: ChinaMobile
- "eos-beijing-1.cmecloud.cn"
  - North China (Beijing-1)
  - Provider: ChinaMobile
- "eos-beijing-2.cmecloud.cn"
  - North China (Beijing-2)
  - Provider: ChinaMobile
- "eos-beijing-4.cmecloud.cn"
  - North China (Beijing-3)
  - Provider: ChinaMobile
- "eos-huhehaote-1.cmecloud.cn"
  - North China (Huhehaote)
  - Provider: ChinaMobile
- "eos-chengdu-1.cmecloud.cn"
  - Southwest China (Chengdu)
  - Provider: ChinaMobile
- "eos-chongqing-1.cmecloud.cn"
  - Southwest China (Chongqing)
  - Provider: ChinaMobile
- "eos-guiyang-1.cmecloud.cn"
  - Southwest China (Guiyang)
  - Provider: ChinaMobile
- "eos-xian-1.cmecloud.cn"
  - Nouthwest China (Xian)
  - Provider: ChinaMobile
- "eos-yunnan.cmecloud.cn"
  - Yunnan China (Kunming)
  - Provider: ChinaMobile
- "eos-yunnan-2.cmecloud.cn"
  - Yunnan China (Kunming-2)
  - Provider: ChinaMobile
- "eos-tianjin-1.cmecloud.cn"
  - Tianjin China (Tianjin)
  - Provider: ChinaMobile
- "eos-jilin-1.cmecloud.cn"
  - Jilin China (Changchun)
  - Provider: ChinaMobile
- "eos-hubei-1.cmecloud.cn"
  - Hubei China (Xiangyan)
  - Provider: ChinaMobile
- "eos-jiangxi-1.cmecloud.cn"
  - Jiangxi China (Nanchang)
  - Provider: ChinaMobile
- "eos-gansu-1.cmecloud.cn"
  - Gansu China (Lanzhou)
  - Provider: ChinaMobile
- "eos-shanxi-1.cmecloud.cn"
  - Shanxi China (Taiyuan)
  - Provider: ChinaMobile
- "eos-liaoning-1.cmecloud.cn"
  - Liaoning China (Shenyang)
  - Provider: ChinaMobile
- "eos-hebei-1.cmecloud.cn"
  - Hebei China (Shijiazhuang)
  - Provider: ChinaMobile
- "eos-fujian-1.cmecloud.cn"
  - Fujian China (Xiamen)
  - Provider: ChinaMobile
- "eos-guangxi-1.cmecloud.cn"
  - Guangxi China (Nanning)
  - Provider: ChinaMobile
- "eos-anhui-1.cmecloud.cn"
  - Anhui China (Huainan)
  - Provider: ChinaMobile
- "s3.cubbit.eu"
  - Cubbit DS3 Object Storage endpoint
  - Provider: Cubbit
- "s3.{tenant_name}.cubbit.eu"
  - Multi-tenant endpoint - replace {tenant_name} with your actual tenant name. Do not select this directly
  - Provider: Cubbit
- "syd1.digitaloceanspaces.com"
  - DigitalOcean Spaces Sydney 1
  - Provider: DigitalOcean
- "sfo3.digitaloceanspaces.com"
  - DigitalOcean Spaces San Francisco 3
  - Provider: DigitalOcean
- "sfo2.digitaloceanspaces.com"
  - DigitalOcean Spaces San Francisco 2
  - Provider: DigitalOcean
- "fra1.digitaloceanspaces.com"
  - DigitalOcean Spaces Frankfurt 1
  - Provider: DigitalOcean
- "nyc3.digitaloceanspaces.com"
  - DigitalOcean Spaces New York 3
  - Provider: DigitalOcean
- "ams3.digitaloceanspaces.com"
  - DigitalOcean Spaces Amsterdam 3
  - Provider: DigitalOcean
- "sgp1.digitaloceanspaces.com"
  - DigitalOcean Spaces Singapore 1
  - Provider: DigitalOcean
- "lon1.digitaloceanspaces.com"
  - DigitalOcean Spaces London 1
  - Provider: DigitalOcean
- "tor1.digitaloceanspaces.com"
  - DigitalOcean Spaces Toronto 1
  - Provider: DigitalOcean
- "blr1.digitaloceanspaces.com"
  - DigitalOcean Spaces Bangalore 1
  - Provider: DigitalOcean
- "objects-us-east-1.dream.io"
  - Dream Objects endpoint
  - Provider: Dreamhost
- "au-east-1.object.fastlystorage.app"
  - AU East 1
  - Provider: Fastly
- "eu-central.object.fastlystorage.app"
  - EU Central
  - Provider: Fastly
- "eu-south-1.object.fastlystorage.app"
  - EU South 1
  - Provider: Fastly
- "eu-west-1.object.fastlystorage.app"
  - EU West 1
  - Provider: Fastly
- "jp-central-1.object.fastlystorage.app"
  - JP Central 1
  - Provider: Fastly
- "uk-east-1.object.fastlystorage.app"
  - UK East 1
  - Provider: Fastly
- "us-central-1.object.fastlystorage.app"
  - US Central 1
  - Provider: Fastly
- "us-east.object.fastlystorage.app"
  - US East
  - Provider: Fastly
- "us-east-1.object.fastlystorage.app"
  - US East 1
  - Provider: Fastly
- "us-west.object.fastlystorage.app"
  - US West
  - Provider: Fastly
- "us-west-1.object.fastlystorage.app"
  - US West 1
  - Provider: Fastly
- "s5lu.com"
  - Global FileLu S5 endpoint
  - Provider: FileLu
- "us.s5lu.com"
  - North America (US-East) region endpoint
  - Provider: FileLu
- "eu.s5lu.com"
  - Europe (EU-Central) region endpoint
  - Provider: FileLu
- "ap.s5lu.com"
  - Asia Pacific (AP-Southeast) region endpoint
  - Provider: FileLu
- "me.s5lu.com"
  - Middle East (ME-Central) region endpoint
  - Provider: FileLu
- "https://storage.googleapis.com"
  - Google Cloud Storage endpoint
  - Provider: GCS
- "hel1.your-objectstorage.com"
  - Helsinki
  - Provider: Hetzner
- "fsn1.your-objectstorage.com"
  - Falkenstein
  - Provider: Hetzner
- "nbg1.your-objectstorage.com"
  - Nuremberg
  - Provider: Hetzner
- "obs.af-south-1.myhuaweicloud.com"
  - AF-Johannesburg
  - Provider: HuaweiOBS
- "obs.ap-southeast-2.myhuaweicloud.com"
  - AP-Bangkok
  - Provider: HuaweiOBS
- "obs.ap-southeast-3.myhuaweicloud.com"
  - AP-Singapore
  - Provider: HuaweiOBS
- "obs.cn-east-3.myhuaweicloud.com"
  - CN East-Shanghai1
  - Provider: HuaweiOBS
- "obs.cn-east-2.myhuaweicloud.com"
  - CN East-Shanghai2
  - Provider: HuaweiOBS
- "obs.cn-north-1.myhuaweicloud.com"
  - CN North-Beijing1
  - Provider: HuaweiOBS
- "obs.cn-north-4.myhuaweicloud.com"
  - CN North-Beijing4
  - Provider: HuaweiOBS
- "obs.cn-south-1.myhuaweicloud.com"
  - CN South-Guangzhou
  - Provider: HuaweiOBS
- "obs.ap-southeast-1.myhuaweicloud.com"
  - CN-Hong Kong
  - Provider: HuaweiOBS
- "obs.sa-argentina-1.myhuaweicloud.com"
  - LA-Buenos Aires1
  - Provider: HuaweiOBS
- "obs.sa-peru-1.myhuaweicloud.com"
  - LA-Lima1
  - Provider: HuaweiOBS
- "obs.na-mexico-1.myhuaweicloud.com"
  - LA-Mexico City1
  - Provider: HuaweiOBS
- "obs.sa-chile-1.myhuaweicloud.com"
  - LA-Santiago2
  - Provider: HuaweiOBS
- "obs.sa-brazil-1.myhuaweicloud.com"
  - LA-Sao Paulo1
  - Provider: HuaweiOBS
- "obs.ru-northwest-2.myhuaweicloud.com"
  - RU-Moscow2
  - Provider: HuaweiOBS
- "s3.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Endpoint
  - Provider: IBMCOS
- "s3.dal.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Dallas Endpoint
  - Provider: IBMCOS
- "s3.wdc.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Washington DC Endpoint
  - Provider: IBMCOS
- "s3.sjc.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region San Jose Endpoint
  - Provider: IBMCOS
- "s3.private.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Private Endpoint
  - Provider: IBMCOS
- "s3.private.dal.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Dallas Private Endpoint
  - Provider: IBMCOS
- "s3.private.wdc.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region Washington DC Private Endpoint
  - Provider: IBMCOS
- "s3.private.sjc.us.cloud-object-storage.appdomain.cloud"
  - US Cross Region San Jose Private Endpoint
  - Provider: IBMCOS
- "s3.us-east.cloud-object-storage.appdomain.cloud"
  - US Region East Endpoint
  - Provider: IBMCOS
- "s3.private.us-east.cloud-object-storage.appdomain.cloud"
  - US Region East Private Endpoint
  - Provider: IBMCOS
- "s3.us-south.cloud-object-storage.appdomain.cloud"
  - US Region South Endpoint
  - Provider: IBMCOS
- "s3.private.us-south.cloud-object-storage.appdomain.cloud"
  - US Region South Private Endpoint
  - Provider: IBMCOS
- "s3.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Endpoint
  - Provider: IBMCOS
- "s3.fra.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Frankfurt Endpoint
  - Provider: IBMCOS
- "s3.mil.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Milan Endpoint
  - Provider: IBMCOS
- "s3.ams.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Amsterdam Endpoint
  - Provider: IBMCOS
- "s3.private.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Private Endpoint
  - Provider: IBMCOS
- "s3.private.fra.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Frankfurt Private Endpoint
  - Provider: IBMCOS
- "s3.private.mil.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Milan Private Endpoint
  - Provider: IBMCOS
- "s3.private.ams.eu.cloud-object-storage.appdomain.cloud"
  - EU Cross Region Amsterdam Private Endpoint
  - Provider: IBMCOS
- "s3.eu-gb.cloud-object-storage.appdomain.cloud"
  - Great Britain Endpoint
  - Provider: IBMCOS
- "s3.private.eu-gb.cloud-object-storage.appdomain.cloud"
  - Great Britain Private Endpoint
  - Provider: IBMCOS
- "s3.eu-de.cloud-object-storage.appdomain.cloud"
  - EU Region DE Endpoint
  - Provider: IBMCOS
- "s3.private.eu-de.cloud-object-storage.appdomain.cloud"
  - EU Region DE Private Endpoint
  - Provider: IBMCOS
- "s3.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Endpoint
  - Provider: IBMCOS
- "s3.tok.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Tokyo Endpoint
  - Provider: IBMCOS
- "s3.hkg.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Hong Kong Endpoint
  - Provider: IBMCOS
- "s3.seo.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Seoul Endpoint
  - Provider: IBMCOS
- "s3.private.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Private Endpoint
  - Provider: IBMCOS
- "s3.private.tok.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Tokyo Private Endpoint
  - Provider: IBMCOS
- "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Hong Kong Private Endpoint
  - Provider: IBMCOS
- "s3.private.seo.ap.cloud-object-storage.appdomain.cloud"
  - APAC Cross Regional Seoul Private Endpoint
  - Provider: IBMCOS
- "s3.jp-tok.cloud-object-storage.appdomain.cloud"
  - APAC Region Japan Endpoint
  - Provider: IBMCOS
- "s3.private.jp-tok.cloud-object-storage.appdomain.cloud"
  - APAC Region Japan Private Endpoint
  - Provider: IBMCOS
- "s3.au-syd.cloud-object-storage.appdomain.cloud"
  - APAC Region Australia Endpoint
  - Provider: IBMCOS
- "s3.private.au-syd.cloud-object-storage.appdomain.cloud"
  - APAC Region Australia Private Endpoint
  - Provider: IBMCOS
- "s3.ams03.cloud-object-storage.appdomain.cloud"
  - Amsterdam Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.ams03.cloud-object-storage.appdomain.cloud"
  - Amsterdam Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.che01.cloud-object-storage.appdomain.cloud"
  - Chennai Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.che01.cloud-object-storage.appdomain.cloud"
  - Chennai Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.mel01.cloud-object-storage.appdomain.cloud"
  - Melbourne Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.mel01.cloud-object-storage.appdomain.cloud"
  - Melbourne Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.osl01.cloud-object-storage.appdomain.cloud"
  - Oslo Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.osl01.cloud-object-storage.appdomain.cloud"
  - Oslo Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.tor01.cloud-object-storage.appdomain.cloud"
  - Toronto Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.tor01.cloud-object-storage.appdomain.cloud"
  - Toronto Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.seo01.cloud-object-storage.appdomain.cloud"
  - Seoul Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.seo01.cloud-object-storage.appdomain.cloud"
  - Seoul Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.mon01.cloud-object-storage.appdomain.cloud"
  - Montreal Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.mon01.cloud-object-storage.appdomain.cloud"
  - Montreal Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.mex01.cloud-object-storage.appdomain.cloud"
  - Mexico Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.mex01.cloud-object-storage.appdomain.cloud"
  - Mexico Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.sjc04.cloud-object-storage.appdomain.cloud"
  - San Jose Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.sjc04.cloud-object-storage.appdomain.cloud"
  - San Jose Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.mil01.cloud-object-storage.appdomain.cloud"
  - Milan Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.mil01.cloud-object-storage.appdomain.cloud"
  - Milan Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.hkg02.cloud-object-storage.appdomain.cloud"
  - Hong Kong Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.hkg02.cloud-object-storage.appdomain.cloud"
  - Hong Kong Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.par01.cloud-object-storage.appdomain.cloud"
  - Paris Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.par01.cloud-object-storage.appdomain.cloud"
  - Paris Single Site Private Endpoint
  - Provider: IBMCOS
- "s3.sng01.cloud-object-storage.appdomain.cloud"
  - Singapore Single Site Endpoint
  - Provider: IBMCOS
- "s3.private.sng01.cloud-object-storage.appdomain.cloud"
  - Singapore Single Site Private Endpoint
  - Provider: IBMCOS
- "eu-central-2.storage.impossibleapi.net"
  - Frankfurt, Germany
  - Provider: ImpossibleCloud
- "eu-west-1.storage.impossibleapi.net"
  - Amsterdam, Netherlands
  - Provider: ImpossibleCloud
- "eu-west-2.storage.impossibleapi.net"
  - London, UK
  - Provider: ImpossibleCloud
- "eu-west-3.storage.impossibleapi.net"
  - Paris, France
  - Provider: ImpossibleCloud
- "eu-east-1.storage.impossibleapi.net"
  - Poznań, Poland
  - Provider: ImpossibleCloud
- "eu-north-1.storage.impossibleapi.net"
  - Copenhagen, Denmark
  - Provider: ImpossibleCloud
- "us-east-1.storage.impossibleapi.net"
  - New York, USA
  - Provider: ImpossibleCloud
- "de-fra.i3storage.com"
  - Frankfurt, Germany
  - Provider: Intercolo
- "s3.eu-central-1.ionoscloud.com"
  - Frankfurt, Germany
  - Provider: IONOS
- "s3.eu-central-2.ionoscloud.com"
  - Berlin, Germany
  - Provider: IONOS
- "s3.eu-central-3.ionoscloud.com"
  - Berlin, Germany
  - Provider: IONOS
- "s3.eu-central-4.ionoscloud.com"
  - Frankfurt, Germany
  - Provider: IONOS
- "s3.eu-south-2.ionoscloud.com"
  - Logrono, Spain
  - Provider: IONOS
- "s3.us-central-1.ionoscloud.com"
  - Lenexa, USA
  - Provider: IONOS
- "s3.leviia.com"
  - The default endpoint
  - Leviia
  - Provider: Leviia
- "storage.iran.liara.space"
  - The default endpoint
  - Iran
  - Provider: Liara
- "nl-ams-1.linodeobjects.com"
  - Amsterdam, NL (nl-ams-1)
  - Provider: Linode
- "us-southeast-1.linodeobjects.com"
  - Atlanta, GA, US (us-southeast-1)
  - Provider: Linode
- "in-maa-1.linodeobjects.com"
  - Chennai, IN (in-maa-1)
  - Provider: Linode
- "us-ord-1.linodeobjects.com"
  - Chicago, IL, US (us-ord-1)
  - Provider: Linode
- "eu-central-1.linodeobjects.com"
  - Frankfurt, DE (eu-central-1)
  - Provider: Linode
- "id-cgk-1.linodeobjects.com"
  - Jakarta, ID (id-cgk-1)
  - Provider: Linode
- "gb-lon-1.linodeobjects.com"
  - London 2, UK (gb-lon-1)
  - Provider: Linode
- "us-lax-1.linodeobjects.com"
  - Los Angeles, CA, US (us-lax-1)
  - Provider: Linode
- "es-mad-1.linodeobjects.com"
  - Madrid, ES (es-mad-1)
  - Provider: Linode
- "us-mia-1.linodeobjects.com"
  - Miami, FL, US (us-mia-1)
  - Provider: Linode
- "it-mil-1.linodeobjects.com"
  - Milan, IT (it-mil-1)
  - Provider: Linode
- "us-east-1.linodeobjects.com"
  - Newark, NJ, US (us-east-1)
  - Provider: Linode
- "jp-osa-1.linodeobjects.com"
  - Osaka, JP (jp-osa-1)
  - Provider: Linode
- "fr-par-1.linodeobjects.com"
  - Paris, FR (fr-par-1)
  - Provider: Linode
- "br-gru-1.linodeobjects.com"
  - Sao Paulo, BR (br-gru-1)
  - Provider: Linode
- "us-sea-1.linodeobjects.com"
  - Seattle, WA, US (us-sea-1)
  - Provider: Linode
- "ap-south-1.linodeobjects.com"
  - Singapore, SG (ap-south-1)
  - Provider: Linode
- "sg-sin-1.linodeobjects.com"
  - Singapore 2, SG (sg-sin-1)
  - Provider: Linode
- "se-sto-1.linodeobjects.com"
  - Stockholm, SE (se-sto-1)
  - Provider: Linode
- "jp-tyo-1.linodeobjects.com"
  - Tokyo 3, JP (jp-tyo-1)
  - Provider: Linode
- "us-iad-10.linodeobjects.com"
  - Washington, DC, US (us-iad-10)
  - Provider: Linode
- "s3.us-west-1.{account_name}.lyve.seagate.com"
  - US West 1 - California
  - Provider: LyveCloud
- "s3.eu-west-1.{account_name}.lyve.seagate.com"
  - EU West 1 - Ireland
  - Provider: LyveCloud
- "br-se1.magaluobjects.com"
  - São Paulo, SP (BR), br-se1
  - Provider: Magalu
- "br-ne1.magaluobjects.com"
  - Fortaleza, CE (BR), br-ne1
  - Provider: Magalu
- "s3.eu-amsterdam.megas4.com"
  - Mega S4 Amsterdam
  - Provider: Mega
- "s3.eu-luxembourg.megas4.com"
  - Mega S4 Luxembourg
  - Provider: Mega
- "s3.eu-paris.megas4.com"
  - Mega S4 Paris
  - Provider: Mega
- "s3.eu-barcelona.megas4.com"
  - Mega S4 Barcelona
  - Provider: Mega
- "s3.ca-montreal.megas4.com"
  - Mega S4 Montreal
  - Provider: Mega
- "s3.ca-vancouver.megas4.com"
  - Mega S4 Vancouver
  - Provider: Mega
- "s3.ap-tokyo.megas4.com"
  - Mega S4 Tokyo
  - Provider: Mega
- "s3.eu-central-1.s4.mega.io"
  - Mega S4 eu-central-1 (Amsterdam, legacy)
  - Provider: Mega
- "s3.eu-central-2.s4.mega.io"
  - Mega S4 eu-central-2 (Bettembourg, legacy)
  - Provider: Mega
- "s3.ca-central-1.s4.mega.io"
  - Mega S4 ca-central-1 (Montreal, legacy)
  - Provider: Mega
- "s3.ca-west-1.s4.mega.io"
  - Mega S4 ca-west-1 (Vancouver, legacy)
  - Provider: Mega
- "oos.eu-west-2.outscale.com"
  - Outscale EU West 2 (Paris)
  - Provider: Outscale
- "oos.us-east-2.outscale.com"
  - Outscale US east 2 (New Jersey)
  - Provider: Outscale
- "oos.us-west-1.outscale.com"
  - Outscale EU West 1 (California)
  - Provider: Outscale
- "oos.cloudgouv-eu-west-1.outscale.com"
  - Outscale SecNumCloud (Paris)
  - Provider: Outscale
- "oos.ap-northeast-1.outscale.com"
  - Outscale AP Northeast 1 (Japan)
  - Provider: Outscale
- "s3.gra.io.cloud.ovh.net"
  - OVHcloud Gravelines, France
  - Provider: OVHcloud
- "s3.rbx.io.cloud.ovh.net"
  - OVHcloud Roubaix, France
  - Provider: OVHcloud
- "s3.sbg.io.cloud.ovh.net"
  - OVHcloud Strasbourg, France
  - Provider: OVHcloud
- "s3.eu-west-par.io.cloud.ovh.net"
  - OVHcloud Paris, France (3AZ)
  - Provider: OVHcloud
- "s3.de.io.cloud.ovh.net"
  - OVHcloud Frankfurt, Germany
  - Provider: OVHcloud
- "s3.uk.io.cloud.ovh.net"
  - OVHcloud London, United Kingdom
  - Provider: OVHcloud
- "s3.waw.io.cloud.ovh.net"
  - OVHcloud Warsaw, Poland
  - Provider: OVHcloud
- "s3.bhs.io.cloud.ovh.net"
  - OVHcloud Beauharnois, Canada
  - Provider: OVHcloud
- "s3.ca-east-tor.io.cloud.ovh.net"
  - OVHcloud Toronto, Canada
  - Provider: OVHcloud
- "s3.sgp.io.cloud.ovh.net"
  - OVHcloud Singapore
  - Provider: OVHcloud
- "s3.ap-southeast-syd.io.cloud.ovh.net"
  - OVHcloud Sydney, Australia
  - Provider: OVHcloud
- "s3.ap-south-mum.io.cloud.ovh.net"
  - OVHcloud Mumbai, India
  - Provider: OVHcloud
- "s3.us-east-va.io.cloud.ovh.us"
  - OVHcloud Vint Hill, Virginia, USA
  - Provider: OVHcloud
- "s3.us-west-or.io.cloud.ovh.us"
  - OVHcloud Hillsboro, Oregon, USA
  - Provider: OVHcloud
- "s3.rbx-archive.io.cloud.ovh.net"
  - OVHcloud Roubaix, France (Cold Archive)
  - Provider: OVHcloud
- "s3.petabox.io"
  - US East (N. Virginia)
  - Provider: Petabox
- "s3.us-east-1.petabox.io"
  - US East (N. Virginia)
  - Provider: Petabox
- "s3.eu-central-1.petabox.io"
  - Europe (Frankfurt)
  - Provider: Petabox
- "s3.ap-southeast-1.petabox.io"
  - Asia Pacific (Singapore)
  - Provider: Petabox
- "s3.me-south-1.petabox.io"
  - Middle East (Bahrain)
  - Provider: Petabox
- "s3.sa-east-1.petabox.io"
  - South America (São Paulo)
  - Provider: Petabox
- "s3-cn-east-1.qiniucs.com"
  - East China Endpoint 1
  - Provider: Qiniu
- "s3-cn-east-2.qiniucs.com"
  - East China Endpoint 2
  - Provider: Qiniu
- "s3-cn-north-1.qiniucs.com"
  - North China Endpoint 1
  - Provider: Qiniu
- "s3-cn-south-1.qiniucs.com"
  - South China Endpoint 1
  - Provider: Qiniu
- "s3-us-north-1.qiniucs.com"
  - North America Endpoint 1
  - Provider: Qiniu
- "s3-ap-southeast-1.qiniucs.com"
  - Southeast Asia Endpoint 1
  - Provider: Qiniu
- "s3-ap-northeast-1.qiniucs.com"
  - Northeast Asia Endpoint 1
  - Provider: Qiniu
- "s3.us-east-1.rabata.io"
  - US East (N. Virginia)
  - Provider: Rabata
- "s3.eu-west-1.rabata.io"
  - EU West (Ireland)
  - Provider: Rabata
- "s3.eu-west-2.rabata.io"
  - EU West (London)
  - Provider: Rabata
- "s3.rackcorp.com"
  - Global (AnyCast) Endpoint
  - Provider: RackCorp
- "au.s3.rackcorp.com"
  - Australia (Anycast) Endpoint
  - Provider: RackCorp
- "au-nsw.s3.rackcorp.com"
  - Sydney (Australia) Endpoint
  - Provider: RackCorp
- "au-qld.s3.rackcorp.com"
  - Brisbane (Australia) Endpoint
  - Provider: RackCorp
- "au-vic.s3.rackcorp.com"
  - Melbourne (Australia) Endpoint
  - Provider: RackCorp
- "au-wa.s3.rackcorp.com"
  - Perth (Australia) Endpoint
  - Provider: RackCorp
- "ph.s3.rackcorp.com"
  - Manila (Philippines) Endpoint
  - Provider: RackCorp
- "th.s3.rackcorp.com"
  - Bangkok (Thailand) Endpoint
  - Provider: RackCorp
- "hk.s3.rackcorp.com"
  - HK (Hong Kong) Endpoint
  - Provider: RackCorp
- "mn.s3.rackcorp.com"
  - Ulaanbaatar (Mongolia) Endpoint
  - Provider: RackCorp
- "kg.s3.rackcorp.com"
  - Bishkek (Kyrgyzstan) Endpoint
  - Provider: RackCorp
- "id.s3.rackcorp.com"
  - Jakarta (Indonesia) Endpoint
  - Provider: RackCorp
- "jp.s3.rackcorp.com"
  - Tokyo (Japan) Endpoint
  - Provider: RackCorp
- "sg.s3.rackcorp.com"
  - SG (Singapore) Endpoint
  - Provider: RackCorp
- "de.s3.rackcorp.com"
  - Frankfurt (Germany) Endpoint
  - Provider: RackCorp
- "us.s3.rackcorp.com"
  - USA (AnyCast) Endpoint
  - Provider: RackCorp
- "us-east-1.s3.rackcorp.com"
  - New York (USA) Endpoint
  - Provider: RackCorp
- "us-west-1.s3.rackcorp.com"
  - Freemont (USA) Endpoint
  - Provider: RackCorp
- "nz.s3.rackcorp.com"
  - Auckland (New Zealand) Endpoint
  - Provider: RackCorp
- "s3.nl-ams.scw.cloud"
  - Amsterdam Endpoint
  - Provider: Scaleway
- "s3.fr-par.scw.cloud"
  - Paris Endpoint
  - Provider: Scaleway
- "s3.pl-waw.scw.cloud"
  - Warsaw Endpoint
  - Provider: Scaleway
- "localhost:8333"
  - SeaweedFS S3 localhost
  - Provider: SeaweedFS
- "s3.ru-1.storage.selcloud.ru"
  - St. Petersburg
  - Provider: Selectel
- "s3.ru-3.storage.selcloud.ru"
  - St. Petersburg
  - Provider: Selectel
- "s3.ru-7.storage.selcloud.ru"
  - Moscow
  - Provider: Selectel,Servercore
- "s3.gis-1.storage.selcloud.ru"
  - Moscow
  - Provider: Selectel,Servercore
- "s3.kz-1.storage.selcloud.ru"
  - Kazakhstan
  - Provider: Selectel
- "s3.uz-2.storage.selcloud.ru"
  - Uzbekistan
  - Provider: Selectel
- "s3.ru-1.storage.selcloud.ru"
  - Saint Petersburg
  - Provider: Servercore
- "s3.uz-2.srvstorage.uz"
  - Tashkent, Uzbekistan
  - Provider: Servercore
- "s3.kz-1.srvstorage.kz"
  - Almaty, Kazakhstan
  - Provider: Servercore
- "gateway.storjshare.io"
  - Global Hosted Gateway
  - Provider: Storj
- "eu-001.s3.synologyc2.net"
  - EU Endpoint 1
  - Provider: Synology
- "eu-002.s3.synologyc2.net"
  - EU Endpoint 2
  - Provider: Synology
- "us-001.s3.synologyc2.net"
  - US Endpoint 1
  - Provider: Synology
- "us-002.s3.synologyc2.net"
  - US Endpoint 2
  - Provider: Synology
- "tw-001.s3.synologyc2.net"
  - TW Endpoint 1
  - Provider: Synology
- "cos.ap-beijing.myqcloud.com"
  - Beijing Region
  - Provider: TencentCOS
- "cos.ap-nanjing.myqcloud.com"
  - Nanjing Region
  - Provider: TencentCOS
- "cos.ap-shanghai.myqcloud.com"
  - Shanghai Region
  - Provider: TencentCOS
- "cos.ap-guangzhou.myqcloud.com"
  - Guangzhou Region
  - Provider: TencentCOS
- "cos.ap-chengdu.myqcloud.com"
  - Chengdu Region
  - Provider: TencentCOS
- "cos.ap-chongqing.myqcloud.com"
  - Chongqing Region
  - Provider: TencentCOS
- "cos.ap-hongkong.myqcloud.com"
  - Hong Kong (China) Region
  - Provider: TencentCOS
- "cos.ap-singapore.myqcloud.com"
  - Singapore Region
  - Provider: TencentCOS
- "cos.ap-mumbai.myqcloud.com"
  - Mumbai Region
  - Provider: TencentCOS
- "cos.ap-seoul.myqcloud.com"
  - Seoul Region
  - Provider: TencentCOS
- "cos.ap-bangkok.myqcloud.com"
  - Bangkok Region
  - Provider: TencentCOS
- "cos.ap-tokyo.myqcloud.com"
  - Tokyo Region
  - Provider: TencentCOS
- "cos.na-siliconvalley.myqcloud.com"
  - Silicon Valley Region
  - Provider: TencentCOS
- "cos.na-ashburn.myqcloud.com"
  - Virginia Region
  - Provider: TencentCOS
- "cos.na-toronto.myqcloud.com"
  - Toronto Region
  - Provider: TencentCOS
- "cos.eu-frankfurt.myqcloud.com"
  - Frankfurt Region
  - Provider: TencentCOS
- "cos.eu-moscow.myqcloud.com"
  - Moscow Region
  - Provider: TencentCOS
- "cos.accelerate.myqcloud.com"
  - Use Tencent COS Accelerate Endpoint
  - Provider: TencentCOS
- "s3-cn-bj.ufileos.com"
  - North China (Beijing 2)
  - Provider: US3
- "s3-cn-wlcb.ufileos.com"
  - North China (Ulanqab)
  - Provider: US3
- "s3-cn-sh2.ufileos.com"
  - Shanghai
  - Provider: US3
- "s3-cn-gd.ufileos.com"
  - South China (Guangzhou)
  - Provider: US3
- "s3-hk.ufileos.com"
  - Hongkong
  - Provider: US3
- "s3-us-ca.ufileos.com"
  - United States (Los Angeles)
  - Provider: US3
- "s3-sg.ufileos.com"
  - Singapore
  - Provider: US3
- "s3-idn-jakarta.ufileos.com"
  - Indonesia (Jakarta)
  - Provider: US3
- "s3-tw-tp.ufileos.com"
  - Taiwan (Taipei)
  - Provider: US3
- "s3-afr-nigeria.ufileos.com"
  - Nigeria (Lagos)
  - Provider: US3
- "s3-bra-saopaulo.ufileos.com"
  - Brazil (São Paulo)
  - Provider: US3
- "s3-uae-dubai.ufileos.com"
  - United Arab Emirates (Dubai)
  - Provider: US3
- "s3-ge-fra.ufileos.com"
  - Germany (Frankfurt)
  - Provider: US3
- "s3-vn-sng.ufileos.com"
  - Vietnam (Ho Chi Minh City)
  - Provider: US3
- "s3-us-ws.ufileos.com"
  - United States (Washington)
  - Provider: US3
- "s3-ind-mumbai.ufileos.com"
  - India (Mumbai)
  - Provider: US3
- "s3-kr-seoul.ufileos.com"
  - Seoul (South Korea)
  - Provider: US3
- "s3-jpn-tky.ufileos.com"
  - Japan (Tokyo)
  - Provider: US3
- "s3-th-bkk.ufileos.com"
  - Bangkok (Thailand)
  - Provider: US3
- "s3-uk-london.ufileos.com"
  - United Kingdom (London)
  - Provider: US3
- "s3-rus-mosc.ufileos.com"
  - Russia (Moscow)
  - Provider: US3
- "s3-cn-guiyang1.ufileos.com"
  - Guiyang 1
  - Provider: US3
- "s3-pk-khi.ufileos.com"
  - Pakistan
  - Provider: US3
- "s3.wasabisys.com"
  - Wasabi US East 1 (N. Virginia)
  - Provider: Wasabi
- "s3.us-east-2.wasabisys.com"
  - Wasabi US East 2 (N. Virginia)
  - Provider: Wasabi
- "s3.us-central-1.wasabisys.com"
  - Wasabi US Central 1 (Texas)
  - Provider: Wasabi
- "s3.us-west-1.wasabisys.com"
  - Wasabi US West 1 (Oregon)
  - Provider: Wasabi
- "s3.ca-central-1.wasabisys.com"
  - Wasabi CA Central 1 (Toronto)
  - Provider: Wasabi
- "s3.eu-central-1.wasabisys.com"
  - Wasabi EU Central 1 (Amsterdam)
  - Provider: Wasabi
- "s3.eu-central-2.wasabisys.com"
  - Wasabi EU Central 2 (Frankfurt)
  - Provider: Wasabi
- "s3.eu-west-1.wasabisys.com"
  - Wasabi EU West 1 (London)
  - Provider: Wasabi
- "s3.eu-west-2.wasabisys.com"
  - Wasabi EU West 2 (Paris)
  - Provider: Wasabi
- "s3.eu-south-1.wasabisys.com"
  - Wasabi EU South 1 (Milan)
  - Provider: Wasabi
- "s3.ap-northeast-1.wasabisys.com"
  - Wasabi AP Northeast 1 (Tokyo) endpoint
  - Provider: Wasabi
- "s3.ap-northeast-2.wasabisys.com"
  - Wasabi AP Northeast 2 (Osaka) endpoint
  - Provider: Wasabi
- "s3.ap-southeast-1.wasabisys.com"
  - Wasabi AP Southeast 1 (Singapore)
  - Provider: Wasabi
- "s3.ap-southeast-2.wasabisys.com"
  - Wasabi AP Southeast 2 (Sydney)
  - Provider: Wasabi
- "idr01.zata.ai"
  - South Asia Endpoint
  - Provider: Zata

--s3-location-constraint

Location constraint - must be set to match the Region.

Leave blank if not sure. Used when creating buckets only.

Properties:

Config: location_constraint
Env Var: RCLONE_S3_LOCATION_CONSTRAINT
Provider: AWS,ArvanCloud,Ceph,ChinaMobile,DigitalOcean,Dreamhost,Exaba,GCS,HCP,Hetzner,IBMCOS,ImpossibleCloud,LyveCloud,Minio,Netease,Qiniu,Rabata,RackCorp,SeaweedFS,Synology,Wasabi,Zata,Other
Type: string
Required: false
Examples:
- ""
  - Empty for US Region, Northern Virginia, or Pacific Northwest
  - Provider: AWS
- "us-east-2"
  - US East (Ohio) Region
  - Provider: AWS
- "us-west-1"
  - US West (Northern California) Region
  - Provider: AWS
- "us-west-2"
  - US West (Oregon) Region
  - Provider: AWS
- "ca-central-1"
  - Canada (Central) Region
  - Provider: AWS
- "eu-west-1"
  - EU (Ireland) Region
  - Provider: AWS
- "eu-west-2"
  - EU (London) Region
  - Provider: AWS
- "eu-west-3"
  - EU (Paris) Region
  - Provider: AWS
- "eu-north-1"
  - EU (Stockholm) Region
  - Provider: AWS
- "eu-south-1"
  - EU (Milan) Region
  - Provider: AWS
- "EU"
  - EU Region
  - Provider: AWS
- "ap-southeast-1"
  - Asia Pacific (Singapore) Region
  - Provider: AWS
- "ap-southeast-2"
  - Asia Pacific (Sydney) Region
  - Provider: AWS
- "ap-northeast-1"
  - Asia Pacific (Tokyo) Region
  - Provider: AWS
- "ap-northeast-2"
  - Asia Pacific (Seoul) Region
  - Provider: AWS
- "ap-northeast-3"
  - Asia Pacific (Osaka-Local) Region
  - Provider: AWS
- "ap-south-1"
  - Asia Pacific (Mumbai) Region
  - Provider: AWS
- "ap-east-1"
  - Asia Pacific (Hong Kong) Region
  - Provider: AWS
- "sa-east-1"
  - South America (Sao Paulo) Region
  - Provider: AWS
- "il-central-1"
  - Israel (Tel Aviv) Region
  - Provider: AWS
- "me-south-1"
  - Middle East (Bahrain) Region
  - Provider: AWS
- "af-south-1"
  - Africa (Cape Town) Region
  - Provider: AWS
- "cn-north-1"
  - China (Beijing) Region
  - Provider: AWS
- "cn-northwest-1"
  - China (Ningxia) Region
  - Provider: AWS
- "us-gov-east-1"
  - AWS GovCloud (US-East) Region
  - Provider: AWS
- "us-gov-west-1"
  - AWS GovCloud (US) Region
  - Provider: AWS
- "ir-thr-at1"
  - Tehran Iran (Simin)
  - Provider: ArvanCloud
- "ir-tbz-sh1"
  - Tabriz Iran (Shahriar)
  - Provider: ArvanCloud
- "wuxi1"
  - East China (Suzhou)
  - Provider: ChinaMobile
- "jinan1"
  - East China (Jinan)
  - Provider: ChinaMobile
- "ningbo1"
  - East China (Hangzhou)
  - Provider: ChinaMobile
- "shanghai1"
  - East China (Shanghai-1)
  - Provider: ChinaMobile
- "zhengzhou1"
  - Central China (Zhengzhou)
  - Provider: ChinaMobile
- "hunan1"
  - Central China (Changsha-1)
  - Provider: ChinaMobile
- "zhuzhou1"
  - Central China (Changsha-2)
  - Provider: ChinaMobile
- "guangzhou1"
  - South China (Guangzhou-2)
  - Provider: ChinaMobile
- "dongguan1"
  - South China (Guangzhou-3)
  - Provider: ChinaMobile
- "beijing1"
  - North China (Beijing-1)
  - Provider: ChinaMobile
- "beijing2"
  - North China (Beijing-2)
  - Provider: ChinaMobile
- "beijing4"
  - North China (Beijing-3)
  - Provider: ChinaMobile
- "huhehaote1"
  - North China (Huhehaote)
  - Provider: ChinaMobile
- "chengdu1"
  - Southwest China (Chengdu)
  - Provider: ChinaMobile
- "chongqing1"
  - Southwest China (Chongqing)
  - Provider: ChinaMobile
- "guiyang1"
  - Southwest China (Guiyang)
  - Provider: ChinaMobile
- "xian1"
  - Northwest China (Xian)
  - Provider: ChinaMobile
- "yunnan"
  - Yunnan China (Kunming)
  - Provider: ChinaMobile
- "yunnan2"
  - Yunnan China (Kunming-2)
  - Provider: ChinaMobile
- "tianjin1"
  - Tianjin China (Tianjin)
  - Provider: ChinaMobile
- "jilin1"
  - Jilin China (Changchun)
  - Provider: ChinaMobile
- "hubei1"
  - Hubei China (Xiangyan)
  - Provider: ChinaMobile
- "jiangxi1"
  - Jiangxi China (Nanchang)
  - Provider: ChinaMobile
- "gansu1"
  - Gansu China (Lanzhou)
  - Provider: ChinaMobile
- "shanxi1"
  - Shanxi China (Taiyuan)
  - Provider: ChinaMobile
- "liaoning1"
  - Liaoning China (Shenyang)
  - Provider: ChinaMobile
- "hebei1"
  - Hebei China (Shijiazhuang)
  - Provider: ChinaMobile
- "fujian1"
  - Fujian China (Xiamen)
  - Provider: ChinaMobile
- "guangxi1"
  - Guangxi China (Nanning)
  - Provider: ChinaMobile
- "anhui1"
  - Anhui China (Huainan)
  - Provider: ChinaMobile
- "us-standard"
  - US Cross Region Standard
  - Provider: IBMCOS
- "us-vault"
  - US Cross Region Vault
  - Provider: IBMCOS
- "us-cold"
  - US Cross Region Cold
  - Provider: IBMCOS
- "us-flex"
  - US Cross Region Flex
  - Provider: IBMCOS
- "us-east-standard"
  - US East Region Standard
  - Provider: IBMCOS
- "us-east-vault"
  - US East Region Vault
  - Provider: IBMCOS
- "us-east-cold"
  - US East Region Cold
  - Provider: IBMCOS
- "us-east-flex"
  - US East Region Flex
  - Provider: IBMCOS
- "us-south-standard"
  - US South Region Standard
  - Provider: IBMCOS
- "us-south-vault"
  - US South Region Vault
  - Provider: IBMCOS
- "us-south-cold"
  - US South Region Cold
  - Provider: IBMCOS
- "us-south-flex"
  - US South Region Flex
  - Provider: IBMCOS
- "eu-standard"
  - EU Cross Region Standard
  - Provider: IBMCOS
- "eu-vault"
  - EU Cross Region Vault
  - Provider: IBMCOS
- "eu-cold"
  - EU Cross Region Cold
  - Provider: IBMCOS
- "eu-flex"
  - EU Cross Region Flex
  - Provider: IBMCOS
- "eu-gb-standard"
  - Great Britain Standard
  - Provider: IBMCOS
- "eu-gb-vault"
  - Great Britain Vault
  - Provider: IBMCOS
- "eu-gb-cold"
  - Great Britain Cold
  - Provider: IBMCOS
- "eu-gb-flex"
  - Great Britain Flex
  - Provider: IBMCOS
- "ap-standard"
  - APAC Standard
  - Provider: IBMCOS
- "ap-vault"
  - APAC Vault
  - Provider: IBMCOS
- "ap-cold"
  - APAC Cold
  - Provider: IBMCOS
- "ap-flex"
  - APAC Flex
  - Provider: IBMCOS
- "mel01-standard"
  - Melbourne Standard
  - Provider: IBMCOS
- "mel01-vault"
  - Melbourne Vault
  - Provider: IBMCOS
- "mel01-cold"
  - Melbourne Cold
  - Provider: IBMCOS
- "mel01-flex"
  - Melbourne Flex
  - Provider: IBMCOS
- "tor01-standard"
  - Toronto Standard
  - Provider: IBMCOS
- "tor01-vault"
  - Toronto Vault
  - Provider: IBMCOS
- "tor01-cold"
  - Toronto Cold
  - Provider: IBMCOS
- "tor01-flex"
  - Toronto Flex
  - Provider: IBMCOS
- "cn-east-1"
  - East China Region 1
  - Provider: Qiniu
- "cn-east-2"
  - East China Region 2
  - Provider: Qiniu
- "cn-north-1"
  - North China Region 1
  - Provider: Qiniu
- "cn-south-1"
  - South China Region 1
  - Provider: Qiniu
- "us-north-1"
  - North America Region 1
  - Provider: Qiniu
- "ap-southeast-1"
  - Southeast Asia Region 1
  - Provider: Qiniu
- "ap-northeast-1"
  - Northeast Asia Region 1
  - Provider: Qiniu
- "us-east-1"
  - US East (N. Virginia)
  - Provider: Rabata
- "eu-west-1"
  - EU (Ireland)
  - Provider: Rabata
- "eu-west-2"
  - EU (London)
  - Provider: Rabata
- "global"
  - Global CDN Region
  - Provider: RackCorp
- "au"
  - Australia (All locations)
  - Provider: RackCorp
- "au-nsw"
  - NSW (Australia) Region
  - Provider: RackCorp
- "au-qld"
  - QLD (Australia) Region
  - Provider: RackCorp
- "au-vic"
  - VIC (Australia) Region
  - Provider: RackCorp
- "au-wa"
  - Perth (Australia) Region
  - Provider: RackCorp
- "ph"
  - Manila (Philippines) Region
  - Provider: RackCorp
- "th"
  - Bangkok (Thailand) Region
  - Provider: RackCorp
- "hk"
  - HK (Hong Kong) Region
  - Provider: RackCorp
- "mn"
  - Ulaanbaatar (Mongolia) Region
  - Provider: RackCorp
- "kg"
  - Bishkek (Kyrgyzstan) Region
  - Provider: RackCorp
- "id"
  - Jakarta (Indonesia) Region
  - Provider: RackCorp
- "jp"
  - Tokyo (Japan) Region
  - Provider: RackCorp
- "sg"
  - SG (Singapore) Region
  - Provider: RackCorp
- "de"
  - Frankfurt (Germany) Region
  - Provider: RackCorp
- "us"
  - USA (AnyCast) Region
  - Provider: RackCorp
- "us-east-1"
  - New York (USA) Region
  - Provider: RackCorp
- "us-west-1"
  - Fremont (USA) Region
  - Provider: RackCorp
- "nz"
  - Auckland (New Zealand) Region
  - Provider: RackCorp

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

If the acl is an empty string then no X-Amz-Acl: header is added and the default (private) will be used.

Properties:

Config: acl
Env Var: RCLONE_S3_ACL
Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
Type: string
Required: false
Examples:
- "private"
  - Owner gets FULL_CONTROL.
  - No one else has access rights (default).
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,US3,Wasabi,Zata,Other
- "public-read"
  - Owner gets FULL_CONTROL.
  - The AllUsers group gets READ access.
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,US3,Wasabi,Zata,Other
- "public-read-write"
  - Owner gets FULL_CONTROL.
  - The AllUsers group gets READ and WRITE access.
  - Granting this on a bucket is generally not recommended.
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "authenticated-read"
  - Owner gets FULL_CONTROL.
  - The AuthenticatedUsers group gets READ access.
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "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.
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "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.
  - Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,TencentCOS,Wasabi,Zata,Other
- "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.
  - Provider: IBMCOS
- "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.
  - Provider: IBMCOS
- "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.
  - Provider: IBMCOS
- "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.
  - Provider: IBMCOS
- "default"
  - Owner gets Full_CONTROL.
  - No one else has access rights (default).
  - Provider: TencentCOS

--s3-server-side-encryption

The server-side encryption algorithm used when storing this object in S3.

Properties:

Config: server_side_encryption
Env Var: RCLONE_S3_SERVER_SIDE_ENCRYPTION
Provider: AWS,Ceph,ChinaMobile,Minio
Type: string
Required: false
Examples:
- ""
  - None
  - Provider: AWS,Ceph,ChinaMobile,Minio
- "AES256"
  - AES256
  - Provider: AWS,Ceph,ChinaMobile,Minio
- "aws:kms"
  - aws:kms
  - Provider: AWS,Ceph,Minio

--s3-sse-kms-key-id

If using KMS ID you must provide the ARN of Key.

Properties:

Config: sse_kms_key_id
Env Var: RCLONE_S3_SSE_KMS_KEY_ID
Provider: AWS,Ceph,Minio
Type: string
Required: false
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.

Properties:

Config: storage_class
Env Var: RCLONE_S3_STORAGE_CLASS
Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,Scaleway,TencentCOS,US3
Type: string
Required: false
Examples:
- ""
  - Default
  - Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3
- "STANDARD"
  - Standard storage class
  - Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3
- "REDUCED_REDUNDANCY"
  - Reduced redundancy storage class
  - Provider: AWS
- "STANDARD_IA"
  - Standard Infrequent Access storage class
  - Provider: AWS,OVHcloud
- "ONEZONE_IA"
  - One Zone Infrequent Access storage class
  - Provider: AWS
- "GLACIER"
  - Glacier Flexible Retrieval storage class
  - Provider: AWS
- "DEEP_ARCHIVE"
  - Glacier Deep Archive storage class
  - Provider: AWS
- "INTELLIGENT_TIERING"
  - Intelligent-Tiering storage class
  - Provider: AWS
- "GLACIER_IR"
  - Glacier Instant Retrieval storage class
  - Provider: AWS,Magalu
- "GLACIER"
  - Archive storage mode
  - Provider: Alibaba,ChinaMobile,Qiniu
- "STANDARD_IA"
  - Infrequent access storage mode
  - Provider: Alibaba,ChinaMobile,TencentCOS,US3
- "EXPRESS_ONEZONE"
  - High Performance storage class
  - Provider: OVHcloud
- "ONEZONE_IA"
  - Standard Infrequent Access storage class
  - Provider: OVHcloud
- "GLACIER"
  - Active Archive storage class
  - Provider: OVHcloud
- "GLACIER_IR"
  - Active Archive storage class
  - Provider: OVHcloud
- "DEEP_ARCHIVE"
  - Cold Archive storage class
  - Provider: OVHcloud
- "INTELLIGENT_TIERING"
  - Standard storage class
  - Provider: OVHcloud
- "LINE"
  - Infrequent access storage mode
  - Provider: Qiniu
- "DEEP_ARCHIVE"
  - Deep archive storage mode
  - Provider: Qiniu
- ""
  - Default.
  - Provider: Scaleway
- "STANDARD"
  - The Standard class for any upload.
  - Suitable for on-demand content like streaming or CDN.
  - Available in all regions.
  - Provider: Scaleway
- "GLACIER"
  - Archived storage.
  - Prices are lower, but it needs to be restored first to be accessed.
  - Available in the FR-PAR region only.
  - Provider: Scaleway
- "ONEZONE_IA"
  - One Zone - Infrequent Access.
  - A good choice for storing secondary backup copies or easily re-creatable data.
  - Available in all regions.
  - Provider: Scaleway
- "ARCHIVE"
  - Archive storage mode
  - Provider: TencentCOS,US3

--s3-ibm-api-key

IBM API Key to be used to obtain IAM token

Properties:

Config: ibm_api_key
Env Var: RCLONE_S3_IBM_API_KEY
Provider: IBMCOS
Type: string
Required: false

--s3-ibm-resource-instance-id

IBM service instance id

Properties:

Config: ibm_resource_instance_id
Env Var: RCLONE_S3_IBM_RESOURCE_INSTANCE_ID
Provider: IBMCOS
Type: string
Required: false

--s3-bucket-object-lock-enabled

Enable Object Lock when creating new buckets.

Properties:

Config: bucket_object_lock_enabled
Env Var: RCLONE_S3_BUCKET_OBJECT_LOCK_ENABLED
Type: bool
Default: false

Advanced options

Here are the Advanced options specific to s3 (Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, BizflyCloud, Ceph, ChinaMobile, Cloudflare, Cubbit, DigitalOcean, Dreamhost, Exaba, Fastly, FileLu, FlashBlade, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, Intercolo, IONOS, Leviia, Liara, Linode, LyveCloud, Magalu, Mega, Minio, Netease, Outscale, OVHcloud, Petabox, Qiniu, Rabata, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, Other).

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

If the "acl" and "bucket_acl" are empty strings then no X-Amz-Acl: header is added and the default (private) will be used.

Properties:

Config: bucket_acl
Env Var: RCLONE_S3_BUCKET_ACL
Provider: AWS,Alibaba,ArvanCloud,BizflyCloud,Ceph,ChinaMobile,Cubbit,DigitalOcean,Dreamhost,Exaba,FileLu,GCS,HCP,Hetzner,HuaweiOBS,IBMCOS,IDrive,ImpossibleCloud,Intercolo,IONOS,Leviia,Liara,Linode,LyveCloud,Magalu,Mega,Minio,Netease,Outscale,OVHcloud,Petabox,Qiniu,RackCorp,Scaleway,SeaweedFS,Servercore,TencentCOS,US3,Wasabi,Zata,Other
Type: string
Required: false
Examples:
- "private"
  - Owner gets FULL_CONTROL.
  - No one else has access rights (default).
- "public-read"
  - Owner gets FULL_CONTROL.
  - The AllUsers group gets READ access.
- "public-read-write"
  - Owner gets FULL_CONTROL.
  - The AllUsers group gets READ and WRITE access.
  - Granting this on a bucket is generally not recommended.
- "authenticated-read"
  - Owner gets FULL_CONTROL.
  - The AuthenticatedUsers group gets READ access.

--s3-requester-pays

Enables requester pays option when interacting with S3 bucket.

Properties:

Config: requester_pays
Env Var: RCLONE_S3_REQUESTER_PAYS
Provider: AWS
Type: bool
Default: false

--s3-sse-customer-algorithm

If using SSE-C, the server-side encryption algorithm used when storing this object in S3.

Properties:

Config: sse_customer_algorithm
Env Var: RCLONE_S3_SSE_CUSTOMER_ALGORITHM
Provider: AWS,Ceph,ChinaMobile,Minio
Type: string
Required: false
Examples:
- ""
  - None
- "AES256"
  - AES256

--s3-sse-customer-key

To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data.

Alternatively you can provide --sse-customer-key-base64.

Properties:

Config: sse_customer_key
Env Var: RCLONE_S3_SSE_CUSTOMER_KEY
Provider: AWS,Ceph,ChinaMobile,Minio
Type: string
Required: false
Examples:
- ""
  - None

--s3-sse-customer-key-base64

If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data.

Alternatively you can provide --sse-customer-key.

Properties:

Config: sse_customer_key_base64
Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_BASE64
Provider: AWS,Ceph,ChinaMobile,Minio
Type: string
Required: false
Examples:
- ""
  - None

--s3-sse-customer-key-md5

If using SSE-C you may provide the secret encryption key MD5 checksum (optional).

If you leave it blank, this is calculated automatically from the sse_customer_key provided.

Properties:

Config: sse_customer_key_md5
Env Var: RCLONE_S3_SSE_CUSTOMER_KEY_MD5
Provider: AWS,Ceph,ChinaMobile,Minio
Type: string
Required: false
Examples:
- ""
  - None

--s3-upload-cutoff

Cutoff for switching to chunked upload.

Any files larger than this will be uploaded in chunks of chunk_size. The minimum is 0 and the maximum is 5 GiB.

Properties:

Config: upload_cutoff
Env Var: RCLONE_S3_UPLOAD_CUTOFF
Type: SizeSuffix
Default: 200Mi

--s3-chunk-size

Chunk size to use for uploading.

When uploading files larger than upload_cutoff or files with unknown size (e.g. from "rclone rcat" or uploaded with "rclone mount" or google photos or google docs) they will be uploaded as multipart uploads using this chunk size.

Note that "--s3-upload-concurrency" chunks of this size are buffered in memory per transfer.

If you are transferring large files over high-speed links and you have enough memory, then increasing this will speed up the transfers.

Rclone will automatically increase the chunk size when uploading a large file of known size to stay below the 10,000 chunks limit.

Files of unknown size are uploaded with the configured chunk_size. Since the default chunk size is 5 MiB and there can be at most 10,000 chunks, this means that by default the maximum size of a file you can stream upload is 48 GiB. If you wish to stream upload larger files then you will need to increase chunk_size.

Increasing the chunk size decreases the accuracy of the progress statistics displayed with "-P" flag. Rclone treats chunk as sent when it's buffered by the AWS SDK, when in fact it may still be uploading. A bigger chunk size means a bigger AWS SDK buffer and progress reporting more deviating from the truth.

Properties:

Config: chunk_size
Env Var: RCLONE_S3_CHUNK_SIZE
Type: SizeSuffix
Default: 5Mi

--s3-max-upload-parts

Maximum number of parts in a multipart upload.

This option defines the maximum number of multipart chunks to use when doing a multipart upload.

This can be useful if a service does not support the AWS S3 specification of 10,000 chunks.

Rclone will automatically increase the chunk size when uploading a large file of a known size to stay below this number of chunks limit.

Properties:

Config: max_upload_parts
Env Var: RCLONE_S3_MAX_UPLOAD_PARTS
Type: int
Default: 10000

--s3-copy-cutoff

Cutoff for switching to multipart copy.

Any files larger than this that need to be server-side copied will be copied in chunks of this size.

The minimum is 0 and the maximum is 5 GiB.

Properties:

Config: copy_cutoff
Env Var: RCLONE_S3_COPY_CUTOFF
Type: SizeSuffix
Default: 4.656Gi

--s3-disable-checksum

Don't store MD5 checksum with object metadata.

Normally rclone will calculate the MD5 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.

Properties:

Config: disable_checksum
Env Var: RCLONE_S3_DISABLE_CHECKSUM
Type: bool
Default: false

--s3-shared-credentials-file

Path to the shared credentials file.

If env_auth = true then rclone can use a shared credentials file.

If this variable is empty rclone will look for the "AWS_SHARED_CREDENTIALS_FILE" env variable. If the env value is empty it will default to the current user's home directory.

Linux/OSX: "$HOME/.aws/credentials"
Windows:   "%USERPROFILE%\.aws\credentials"

Properties:

Config: shared_credentials_file
Env Var: RCLONE_S3_SHARED_CREDENTIALS_FILE
Type: string
Required: false

--s3-profile

Profile to use in the shared credentials file.

If env_auth = true then rclone can use a shared credentials file. This variable controls which profile is used in that file.

If empty it will default to the environment variable "AWS_PROFILE" or "default" if that environment variable is also not set.

Properties:

Config: profile
Env Var: RCLONE_S3_PROFILE
Type: string
Required: false

--s3-session-token

An AWS session token.

Properties:

Config: session_token
Env Var: RCLONE_S3_SESSION_TOKEN
Type: string
Required: false

--s3-role-arn

ARN of the IAM role to assume.

Leave blank if not using assume role.

Properties:

Config: role_arn
Env Var: RCLONE_S3_ROLE_ARN
Type: string
Required: false

--s3-role-session-name

Session name for assumed role.

If empty, a session name will be generated automatically.

Properties:

Config: role_session_name
Env Var: RCLONE_S3_ROLE_SESSION_NAME
Type: string
Required: false

--s3-role-session-duration

Session duration for assumed role.

If empty, the default session duration will be used.

Properties:

Config: role_session_duration
Env Var: RCLONE_S3_ROLE_SESSION_DURATION
Type: string
Required: false

--s3-role-external-id

External ID for assumed role.

Leave blank if not using an external ID.

Properties:

Config: role_external_id
Env Var: RCLONE_S3_ROLE_EXTERNAL_ID
Type: string
Required: false

--s3-upload-concurrency

Concurrency for multipart uploads and copies.

This is the number of chunks of the same file that are uploaded concurrently for multipart uploads and copies.

If you are uploading small numbers of large files over high-speed links and these uploads do not fully utilize your bandwidth, then increasing this may help to speed up the transfers.

Properties:

Config: upload_concurrency
Env Var: RCLONE_S3_UPLOAD_CONCURRENCY
Type: int
Default: 4

--s3-force-path-style

If true use path style access if false use virtual hosted style.

If this is true (the default) then rclone will use path style access, if false then rclone will use virtual path style. See the AWS S3 docs for more info.

Some providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to false - rclone will do this automatically based on the provider setting.

Note that if your bucket isn't a valid DNS name, i.e. has '.' or '_' in, you'll need to set this to true.

Properties:

Config: force_path_style
Env Var: RCLONE_S3_FORCE_PATH_STYLE
Type: bool
Default: true

--s3-v2-auth

If true use v2 authentication.

If this is false (the default) then rclone will use v4 authentication. If it is set then rclone will use v2 authentication.

Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.

Properties:

Config: v2_auth
Env Var: RCLONE_S3_V2_AUTH
Type: bool
Default: false

--s3-use-dual-stack

If true use AWS S3 dual-stack endpoint (IPv6 support).

See AWS Docs on Dualstack Endpoints

Properties:

Config: use_dual_stack
Env Var: RCLONE_S3_USE_DUAL_STACK
Type: bool
Default: false

--s3-use-accelerate-endpoint

If true use the AWS S3 accelerated endpoint.

See: AWS S3 Transfer acceleration

Properties:

Config: use_accelerate_endpoint
Env Var: RCLONE_S3_USE_ACCELERATE_ENDPOINT
Provider: AWS
Type: bool
Default: false

--s3-use-arn-region

If true, enables arn region support for the service.

Properties:

Config: use_arn_region
Env Var: RCLONE_S3_USE_ARN_REGION
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.

Properties:

Config: leave_parts_on_error
Env Var: RCLONE_S3_LEAVE_PARTS_ON_ERROR
Provider: AWS
Type: bool
Default: false

--s3-list-chunk

Size of listing chunk (response list for each ListObject S3 request).

This option is also known as "MaxKeys", "max-items", or "page-size" from the AWS S3 specification. Most services truncate the response list to 1000 objects even if requested more than that. In AWS S3 this is a global maximum and cannot be changed, see AWS S3. In Ceph, this can be increased with the "rgw list buckets max chunk" option.

Properties:

Config: list_chunk
Env Var: RCLONE_S3_LIST_CHUNK
Type: int
Default: 1000

--s3-list-version

Version of ListObjects to use: 1,2 or 0 for auto.

When S3 originally launched it only provided the ListObjects call to enumerate objects in a bucket.

However in May 2016 the ListObjectsV2 call was introduced. This is much higher performance and should be used if at all possible.

If set to the default, 0, rclone will guess according to the provider set which list objects method to call. If it guesses wrong, then it may be set manually here.

Properties:

Config: list_version
Env Var: RCLONE_S3_LIST_VERSION
Type: int
Default: 0

--s3-list-url-encode

Whether to url encode listings: true/false/unset

Some providers support URL encoding listings and where this is available this is more reliable when using control characters in file names. If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here.

Properties:

Config: list_url_encode
Env Var: RCLONE_S3_LIST_URL_ENCODE
Type: Tristate
Default: unset

--s3-no-check-bucket

If set, don't attempt to check the bucket exists or create it.

This can be useful when trying to minimise the number of transactions rclone does if you know the bucket exists already.

It can also be needed if the user you are using does not have bucket creation permissions. Before v1.52.0 this would have passed silently due to a bug.

Properties:

Config: no_check_bucket
Env Var: RCLONE_S3_NO_CHECK_BUCKET
Type: bool
Default: false

--s3-no-head

If set, don't HEAD uploaded objects to check integrity.

This can be useful when trying to minimise the number of transactions rclone does.

Setting it means that if rclone receives a 200 OK message after uploading an object with PUT then it will assume that it got uploaded properly.

In particular it will assume:

the metadata, including modtime, storage class and content type was as uploaded
the size was as uploaded

It reads the following items from the response for a single part PUT:

the MD5SUM
The uploaded date

For multipart uploads these items aren't read.

If an source object of unknown length is uploaded then rclone will do a HEAD request.

Setting this flag increases the chance for undetected upload failures, in particular an incorrect size, so it isn't recommended for normal operation. In practice the chance of an undetected upload failure is very small even with this flag.

Properties:

Config: no_head
Env Var: RCLONE_S3_NO_HEAD
Type: bool
Default: false

--s3-no-head-object

If set, do not do HEAD before GET when getting objects.

Properties:

Config: no_head_object
Env Var: RCLONE_S3_NO_HEAD_OBJECT
Type: bool
Default: false

--s3-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

Config: encoding
Env Var: RCLONE_S3_ENCODING
Type: Encoding
Default: Slash,InvalidUtf8,Dot

--s3-memory-pool-flush-time

How often internal memory buffer pools will be flushed. (no longer used)

Properties:

Config: memory_pool_flush_time
Env Var: RCLONE_S3_MEMORY_POOL_FLUSH_TIME
Type: Duration
Default: 1m0s

--s3-memory-pool-use-mmap

Whether to use mmap buffers in internal memory pool. (no longer used)

Properties:

Config: memory_pool_use_mmap
Env Var: RCLONE_S3_MEMORY_POOL_USE_MMAP
Type: bool
Default: false

--s3-disable-http2

Disable usage of http2 for S3 backends.

There is currently an unsolved issue with the s3 (specifically minio) backend and HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be disabled here. When the issue is solved this flag will be removed.

See: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631

Properties:

Config: disable_http2
Env Var: RCLONE_S3_DISABLE_HTTP2
Type: bool
Default: false

--s3-download-url

Custom endpoint for downloads. This is usually set to a CloudFront CDN URL as AWS S3 offers cheaper egress for data downloaded through the CloudFront network.

Properties:

Config: download_url
Env Var: RCLONE_S3_DOWNLOAD_URL
Type: string
Required: false

--s3-directory-markers

Upload an empty object with a trailing slash when a new directory is created

Empty folders are unsupported for bucket based remotes, this option creates an empty object ending with "/", to persist the folder.

Properties:

Config: directory_markers
Env Var: RCLONE_S3_DIRECTORY_MARKERS
Type: bool
Default: false

--s3-use-multipart-etag

Whether to use ETag in multipart uploads for verification

This should be true, false or left unset to use the default for the provider.

Properties:

Config: use_multipart_etag
Env Var: RCLONE_S3_USE_MULTIPART_ETAG
Type: Tristate
Default: unset

--s3-use-unsigned-payload

Whether to use an unsigned payload in PutObject

Rclone has to avoid the AWS SDK seeking the body when calling PutObject. The AWS provider can add checksums in the trailer to avoid seeking but other providers can't.

This should be true, false or left unset to use the default for the provider.

Properties:

Config: use_unsigned_payload
Env Var: RCLONE_S3_USE_UNSIGNED_PAYLOAD
Type: Tristate
Default: unset

--s3-use-presigned-request

Whether to use a presigned request or PutObject for single part uploads

If this is false rclone will use PutObject from the AWS SDK to upload an object.

Versions of rclone < 1.59 use presigned requests to upload a single part object and setting this flag to true will re-enable that functionality. This shouldn't be necessary except in exceptional circumstances or for testing.

Properties:

Config: use_presigned_request
Env Var: RCLONE_S3_USE_PRESIGNED_REQUEST
Type: bool
Default: false

--s3-use-data-integrity-protections

If true use AWS S3 data integrity protections.

See AWS Docs on Data Integrity Protections

Properties:

Config: use_data_integrity_protections
Env Var: RCLONE_S3_USE_DATA_INTEGRITY_PROTECTIONS
Type: Tristate
Default: unset

--s3-versions

Include old versions in directory listings.

Properties:

Config: versions
Env Var: RCLONE_S3_VERSIONS
Type: bool
Default: false

--s3-version-at

Show file versions as they were at the specified time.

The parameter should be a date, "2006-01-02", datetime "2006-01-02 15:04:05" or a duration for that long ago, eg "100d" or "1h".

Note that when using this no file write operations are permitted, so you can't upload files or delete them.

See the time option docs for valid formats.

Properties:

Config: version_at
Env Var: RCLONE_S3_VERSION_AT
Type: Time
Default: off

--s3-version-deleted

Show deleted file markers when using versions.

This shows deleted file markers in the listing when using versions. These will appear as 0 size files. The only operation which can be performed on them is deletion.

Deleting a delete marker will reveal the previous version.

Deleted files will always show with a timestamp.

Properties:

Config: version_deleted
Env Var: RCLONE_S3_VERSION_DELETED
Type: bool
Default: false

--s3-decompress

If set this will decompress gzip encoded objects.

It is possible to upload objects to S3 with "Content-Encoding: gzip" set. Normally rclone will download these files as compressed objects.

If this flag is set then rclone will decompress these files with "Content-Encoding: gzip" as they are received. This means that rclone can't check the size and hash but the file contents will be decompressed.

Properties:

Config: decompress
Env Var: RCLONE_S3_DECOMPRESS
Type: bool
Default: false

--s3-might-gzip

Set this if the backend might gzip objects.

Normally providers will not alter objects when they are downloaded. If an object was not uploaded with Content-Encoding: gzip then it won't be set on download.

However some providers may gzip objects even if they weren't uploaded with Content-Encoding: gzip (eg Cloudflare).

A symptom of this would be receiving errors like

ERROR corrupted on transfer: sizes differ NNN vs MMM

If you set this flag and rclone downloads an object with Content-Encoding: gzip set and chunked transfer encoding, then rclone will decompress the object on the fly.

If this is set to unset (the default) then rclone will choose according to the provider setting what to apply, but you can override rclone's choice here.

Properties:

Config: might_gzip
Env Var: RCLONE_S3_MIGHT_GZIP
Type: Tristate
Default: unset

--s3-use-accept-encoding-gzip

Whether to send Accept-Encoding: gzip header.

By default, rclone will append Accept-Encoding: gzip to the request to download compressed objects whenever possible.

However some providers such as Google Cloud Storage may alter the HTTP headers, breaking the signature of the request.

A symptom of this would be receiving errors like

SignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.

In this case, you might want to try disabling this option.

Properties:

Config: use_accept_encoding_gzip
Env Var: RCLONE_S3_USE_ACCEPT_ENCODING_GZIP
Type: Tristate
Default: unset

--s3-no-system-metadata

Suppress setting and reading of system metadata

Properties:

Config: no_system_metadata
Env Var: RCLONE_S3_NO_SYSTEM_METADATA
Type: bool
Default: false

--s3-sts-endpoint

Endpoint for STS (deprecated).

Leave blank if using AWS to use the default endpoint for the region.

Properties:

Config: sts_endpoint
Env Var: RCLONE_S3_STS_ENDPOINT
Provider: AWS
Type: string
Required: false

--s3-use-already-exists

Set if rclone should report BucketAlreadyExists errors on bucket creation.

At some point during the evolution of the s3 protocol, AWS started returning an AlreadyOwnedByYou error when attempting to create a bucket that the user already owned, rather than a BucketAlreadyExists error.

Unfortunately exactly what has been implemented by s3 clones is a little inconsistent, some return AlreadyOwnedByYou, some return BucketAlreadyExists and some return no error at all.

This is important to rclone because it ensures the bucket exists by creating it on quite a lot of operations (unless --s3-no-check-bucket is used).

If rclone knows the provider can return AlreadyOwnedByYou or returns no error then it can report BucketAlreadyExists errors when the user attempts to create a bucket not owned by them. Otherwise rclone ignores the BucketAlreadyExists error which can lead to confusion.

This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.

Properties:

Config: use_already_exists
Env Var: RCLONE_S3_USE_ALREADY_EXISTS
Type: Tristate
Default: unset

--s3-use-multipart-uploads

Set if rclone should use multipart uploads.

You can change this if you want to disable the use of multipart uploads. This shouldn't be necessary in normal operation.

This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.

Properties:

Config: use_multipart_uploads
Env Var: RCLONE_S3_USE_MULTIPART_UPLOADS
Type: Tristate
Default: unset

--s3-list-versions-oldest-first

Set if the backend returns object versions oldest first.

The S3 standard returns object versions newest first. Some backends (e.g. Hitachi HCP) return them oldest first instead.

Set this quirk if --s3-version-at or --s3-versions produce incorrect results with your backend.

This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.

Properties:

Config: list_versions_oldest_first
Env Var: RCLONE_S3_LIST_VERSIONS_OLDEST_FIRST
Type: Tristate
Default: unset

--s3-use-x-id

Set if rclone should add x-id URL parameters.

You can change this if you want to disable the AWS SDK from adding x-id URL parameters.

This shouldn't be necessary in normal operation.

This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.

Properties:

Config: use_x_id
Env Var: RCLONE_S3_USE_X_ID
Type: Tristate
Default: unset

--s3-sign-accept-encoding

Set if rclone should include Accept-Encoding as part of the signature.

You can change this if you want to stop rclone including Accept-Encoding as part of the signature.

This shouldn't be necessary in normal operation.

This should be automatically set correctly for all providers rclone knows about - please make a bug report if not.

Properties:

Config: sign_accept_encoding
Env Var: RCLONE_S3_SIGN_ACCEPT_ENCODING
Type: Tristate
Default: unset

--s3-directory-bucket

Set to use AWS Directory Buckets

If you are using an AWS Directory Bucket then set this flag.

This will ensure no Content-Md5 headers are sent and ensure ETag headers are not interpreted as MD5 sums. X-Amz-Meta-Md5chksum will be set on all objects whether single or multipart uploaded.

This also sets no_check_bucket = true.

Note that Directory Buckets do not support:

Versioning
Content-Encoding: gzip

Rclone limitations with Directory Buckets:

rclone does not support creating Directory Buckets with rclone mkdir
... or removing them with rclone rmdir yet
Directory Buckets do not appear when doing rclone lsf at the top level.
Rclone can't remove auto created directories yet. In theory this should work with directory_markers = true but it doesn't.
Directories don't seem to appear in recursive (ListR) listings.

Properties:

Config: directory_bucket
Env Var: RCLONE_S3_DIRECTORY_BUCKET
Provider: AWS
Type: bool
Default: false

--s3-sdk-log-mode

Set to debug the SDK

This can be set to a comma separated list of the following functions:

Signing
Retries
Request
RequestWithBody
Response
ResponseWithBody
DeprecatedUsage
RequestEventMessage
ResponseEventMessage

Use Off to disable and All to set all log levels. You will need to use -vv to see the debug level logs.

Properties:

Config: sdk_log_mode
Env Var: RCLONE_S3_SDK_LOG_MODE
Type: Bits
Default: Off

--s3-ibm-iam-endpoint

IBM IAM Endpoint to use for authentication.

Leave blank to use the default public endpoint.

Properties:

Config: ibm_iam_endpoint
Env Var: RCLONE_S3_IBM_IAM_ENDPOINT
Provider: IBMCOS
Type: string
Required: false

--s3-object-lock-mode

Object Lock mode to apply when uploading or copying objects.

Set this to apply Object Lock retention mode to objects. If not set, no Object Lock mode is applied (even with --metadata).

Note: To enable Object Lock retention, you must set BOTH object_lock_mode AND object_lock_retain_until_date. Setting only one has no effect.

GOVERNANCE: Set Object Lock mode to GOVERNANCE
COMPLIANCE: Set Object Lock mode to COMPLIANCE
copy: Copy the mode from the source object (requires --metadata)

See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html

Properties:

Config: object_lock_mode
Env Var: RCLONE_S3_OBJECT_LOCK_MODE
Type: string
Required: false
Examples:
- "GOVERNANCE"
  - Set Object Lock mode to GOVERNANCE
- "COMPLIANCE"
  - Set Object Lock mode to COMPLIANCE
- "copy"
  - Copy from source object (requires --metadata)

--s3-object-lock-retain-until-date

Object Lock retention until date to apply when uploading or copying objects.

Set this to apply Object Lock retention date to objects. If not set, no retention date is applied (even with --metadata).

Note: To enable Object Lock retention, you must set BOTH object_lock_mode AND object_lock_retain_until_date. Setting only one has no effect.

Accepts:

RFC 3339 format: 2030-01-02T15:04:05Z
Duration from now: 365d, 1y, 6M (days, years, months)
copy: Copy the date from the source object (requires --metadata)

See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html

Properties:

Config: object_lock_retain_until_date
Env Var: RCLONE_S3_OBJECT_LOCK_RETAIN_UNTIL_DATE
Type: string
Required: false
Examples:
- "copy"
  - Copy from source object (requires --metadata)
- "2030-01-01T00:00:00Z"
  - Set specific date (RFC 3339 format)
- "365d"
  - Set retention for 365 days from now
- "1y"
  - Set retention for 1 year from now

--s3-object-lock-legal-hold-status

Object Lock legal hold status to apply when uploading or copying objects.

Set this to apply Object Lock legal hold to objects. If not set, no legal hold is applied (even with --metadata).

Note: Legal hold is independent of retention and can be set separately.

ON: Enable legal hold
OFF: Disable legal hold
copy: Copy the legal hold status from the source object (requires --metadata)

See: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html

Properties:

Config: object_lock_legal_hold_status
Env Var: RCLONE_S3_OBJECT_LOCK_LEGAL_HOLD_STATUS
Type: string
Required: false
Examples:
- "ON"
  - Enable legal hold
- "OFF"
  - Disable legal hold
- "copy"
  - Copy from source object (requires --metadata)

--s3-bypass-governance-retention

Allow deleting or modifying objects locked with GOVERNANCE mode.

Properties:

Config: bypass_governance_retention
Env Var: RCLONE_S3_BYPASS_GOVERNANCE_RETENTION
Type: bool
Default: false

--s3-object-lock-set-after-upload

Set Object Lock via separate API calls after upload.

Use this for S3-compatible providers that don't support setting Object Lock headers during PUT operations. When enabled, Object Lock is set via separate PutObjectRetention and PutObjectLegalHold API calls after the upload completes.

This adds extra API calls per object, so only enable if your provider requires it.

Properties:

Config: object_lock_set_after_upload
Env Var: RCLONE_S3_OBJECT_LOCK_SET_AFTER_UPLOAD
Type: bool
Default: false

--s3-object-lock-supported

Whether the provider supports S3 Object Lock.

This should be true, false or left unset to use the default for the provider.

Set to false for providers that don't fully support the S3 Object Lock API (e.g. GCS which uses non-standard headers for bypass governance retention and doesn't implement Legal Hold via the S3 API).

Properties:

Config: object_lock_supported
Env Var: RCLONE_S3_OBJECT_LOCK_SUPPORTED
Type: Tristate
Default: unset

--s3-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_S3_DESCRIPTION
Type: string
Required: false

Metadata

User metadata is stored as x-amz-meta- keys. S3 metadata keys are case insensitive and are always returned in lower case.

Here are the possible system metadata items for the s3 backend.

Name	Help	Type	Example	Read Only
btime	Time of file birth (creation) read from Last-Modified header	RFC 3339	2006-01-02T15:04:05.999999999Z07:00	Y
cache-control	Cache-Control header	string	no-cache	N
content-disposition	Content-Disposition header	string	inline	N
content-encoding	Content-Encoding header	string	gzip	N
content-language	Content-Language header	string	en-US	N
content-type	Content-Type header	string	text/plain	N
mtime	Time of last modification, read from rclone metadata	RFC 3339	2006-01-02T15:04:05.999999999Z07:00	N
object-lock-legal-hold-status	Object Lock legal hold status: ON or OFF	string	OFF	N
object-lock-mode	Object Lock mode: GOVERNANCE or COMPLIANCE	string	GOVERNANCE	N
object-lock-retain-until-date	Object Lock retention until date	RFC 3339	2030-01-02T15:04:05Z	N
tier	Tier of the object	string	GLACIER	Y

See the metadata docs for more info.

Backend commands

Here are the commands specific to the s3 backend.

Run them with:

rclone backend COMMAND remote:

The help below will explain what arguments each command takes.

See the backend command for more info on how to pass options and arguments.

These can be run on a running backend using the rc command backend/command.

restore

Restore objects from GLACIER or INTELLIGENT-TIERING archive tier.

rclone backend restore remote: [options] [<arguments>+]

This command can be used to restore one or more objects from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.

Usage examples:

rclone backend restore s3:bucket/path/to/ --include /object -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS
rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY

This flag also obeys the filters. Test first with --interactive/-i or --dry-run flags.

rclone --interactive backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1

All the objects shown will be marked for restore, then:

rclone backend restore --include "*.txt" s3:bucket/path -o priority=Standard -o lifetime=1

It returns a list of status dictionaries with Remote and Status keys. The Status will be OK if it was successful or an error message if not.

[
    {
        "Status": "OK",
        "Remote": "test.txt"
    },
    {
        "Status": "OK",
        "Remote": "test/file4.txt"
    }
]

Options:

"description": The optional description for the job.
"lifetime": Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING storage.
"priority": Priority of restore: Standard|Expedited|Bulk

restore-status

Show the status for objects being restored from GLACIER or INTELLIGENT-TIERING.

rclone backend restore-status remote: [options] [<arguments>+]

This command can be used to show the status for objects being restored from GLACIER to normal storage or from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.

Usage examples:

rclone backend restore-status s3:bucket/path/to/object
rclone backend restore-status s3:bucket/path/to/directory
rclone backend restore-status -o all s3:bucket/path/to/directory

This command does not obey the filters.

It returns a list of status dictionaries:

[
    {
        "Remote": "file.txt",
        "VersionID": null,
        "RestoreStatus": {
            "IsRestoreInProgress": true,
            "RestoreExpiryDate": "2023-09-06T12:29:19+01:00"
        },
        "StorageClass": "GLACIER"
    },
    {
        "Remote": "test.pdf",
        "VersionID": null,
        "RestoreStatus": {
            "IsRestoreInProgress": false,
            "RestoreExpiryDate": "2023-09-06T12:29:19+01:00"
        },
        "StorageClass": "DEEP_ARCHIVE"
    },
    {
        "Remote": "test.gz",
        "VersionID": null,
        "RestoreStatus": {
            "IsRestoreInProgress": true,
            "RestoreExpiryDate": "null"
        },
        "StorageClass": "INTELLIGENT_TIERING"
    }
]

Options:

"all": If set then show all objects, not just ones with restore status.

list-multipart-uploads

List the unfinished multipart uploads.

rclone backend list-multipart-uploads remote: [options] [<arguments>+]

This command lists the unfinished multipart uploads in JSON format.

Usage examples:

rclone backend list-multipart s3:bucket/path/to/object

It returns a dictionary of buckets with values as lists of unfinished multipart uploads.

You can call it with no bucket in which case it lists all bucket, with a bucket or with a bucket and path.

{
    "rclone": [
        {
            "Initiated": "2020-06-26T14:20:36Z",
            "Initiator": {
                "DisplayName": "XXX",
                "ID": "arn:aws:iam::XXX:user/XXX"
            },
            "Key": "KEY",
            "Owner": {
                "DisplayName": null,
                "ID": "XXX"
            },
            "StorageClass": "STANDARD",
            "UploadId": "XXX"
        }
    ],
    "rclone-1000files": [],
    "rclone-dst": []
}

cleanup

Remove unfinished multipart uploads.

rclone backend cleanup remote: [options] [<arguments>+]

This command removes unfinished multipart uploads of age greater than max-age which defaults to 24 hours.

Note that you can use --interactive/-i or --dry-run with this command to see what it would do.

Usage examples:

rclone backend cleanup s3:bucket/path/to/object
rclone backend cleanup -o max-age=7w s3:bucket/path/to/object

Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.

Options:

"max-age": Max age of upload to delete.

cleanup-hidden

Remove old versions of files.

rclone backend cleanup-hidden remote: [options] [<arguments>+]

This command removes any old hidden versions of files on a versions enabled bucket.

Note that you can use --interactive/-i or --dry-run with this command to see what it would do.

Usage example:

rclone backend cleanup-hidden s3:bucket/path/to/dir

versioning

Set/get versioning support for a bucket.

rclone backend versioning remote: [options] [<arguments>+]

This command sets versioning support if a parameter is passed and then returns the current versioning status for the bucket supplied.

Usage examples:

rclone backend versioning s3:bucket # read status only
rclone backend versioning s3:bucket Enabled
rclone backend versioning s3:bucket Suspended

It may return "Enabled", "Suspended" or "Unversioned". Note that once versioning has been enabled the status can't be set back to "Unversioned".

set

Set command for updating the config parameters.

rclone backend set remote: [options] [<arguments>+]

This set command can be used to update the config parameters for a running s3 backend.

Usage examples:

rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]
rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X

The option keys are named as they are in the config file.

This rebuilds the connection to the s3 backend when it is called with the new parameters. Only new parameters need be passed as the values will default to those currently in use.

It doesn't return anything.

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

Then use it as normal with the name of the public bucket, e.g.

rclone lsd anons3:1000genomes

You will be able to list and copy data but not upload it.

You can also do this entirely on the command line

rclone lsd :s3,provider=AWS:1000genomes

Providers

AWS S3

This is the provider used as main example and described in the configuration section above.

AWS Directory Buckets

From rclone v1.69 Directory Buckets are supported.

You will need to set the directory_buckets = true config parameter or use --s3-directory-buckets.

Note that rclone cannot yet:

Create directory buckets
List directory buckets

See the --s3-directory-buckets flag for more info

AWS Snowball Edge

AWS Snowball is a hardware appliance used for transferring bulk data back to AWS. Its main software interface is S3 object storage.

To use rclone with AWS Snowball Edge devices, configure as standard for an 'S3 Compatible Service'.

If using rclone pre v1.59 be sure to set upload_cutoff = 0 otherwise you will run into authentication header issues as the snowball device does not support query parameter based authentication.

With rclone v1.59 or later setting upload_cutoff should not be necessary.

eg.

[snowball]
type = s3
provider = Other
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = http://[IP of Snowball]:8080
upload_cutoff = 0

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]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "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

ArvanCloud

ArvanCloud ArvanCloud Object Storage goes beyond the limited traditional file storage. It gives you access to backup and archived files and allows sharing. Files like profile image in the app, images sent by users or scanned documents can be stored securely and easily in our Object Storage service.

ArvanCloud 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> ArvanCloud
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, 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> 
Endpoint for S3 API.
Leave blank if using ArvanCloud to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint> s3.arvanstorage.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 Iran-Tehran Region.
   \ ""
[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"
storage_class>
Remote config
--------------------
[ArvanCloud]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = ir-thr-at1
endpoint = s3.arvanstorage.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.

[ArvanCloud]
type = s3
provider = ArvanCloud
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = s3.arvanstorage.com
location_constraint =
acl =
server_side_encryption =
storage_class =

BizflyCloud

Bizfly Cloud Simple Storage is an S3-compatible service with regions in Hanoi (HN) and Ho Chi Minh City (HCM).

Use the endpoint for your region:

HN: hn.ss.bfcplatform.vn
HCM: hcm.ss.bfcplatform.vn

A minimal configuration looks like this.

[bizfly]
type = s3
provider = BizflyCloud
env_auth = false
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region = HN
endpoint = hn.ss.bfcplatform.vn
location_constraint =
acl =
server_side_encryption =
storage_class =

Switch region and endpoint to HCM and hcm.ss.bfcplatform.vn for Ho Chi Minh City.

Ceph

Ceph is an open-source, unified, distributed storage system designed for excellent performance, reliability and scalability. It has an S3 compatible object storage interface.

To use rclone with Ceph, configure as above but leave the region blank and set the endpoint. You should end up with something like this in your config:

[ceph]
type = s3
provider = Ceph
env_auth = false
access_key_id = XXX
secret_access_key = YYY
region =
endpoint = https://ceph.endpoint.example.com
location_constraint =
acl =
server_side_encryption =
storage_class =

If you are using an older version of CEPH (e.g. 10.2.x Jewel) and a version of rclone before v1.59 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.

China Mobile Ecloud Elastic Object Storage (EOS)

Here is an example of making an China Mobile Ecloud Elastic Object Storage (EOS) 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> ChinaMobile
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 ...
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
 ...
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 ...
 4 / China Mobile Ecloud Elastic Object Storage (EOS)
   \ (ChinaMobile)
 ...
provider> ChinaMobile
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> accesskeyid
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> secretaccesskey
Option endpoint.
Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / The default endpoint - a good choice if you are unsure.
 1 | East China (Suzhou)
   \ (eos-wuxi-1.cmecloud.cn)
 2 / East China (Jinan)
   \ (eos-jinan-1.cmecloud.cn)
 3 / East China (Hangzhou)
   \ (eos-ningbo-1.cmecloud.cn)
 4 / East China (Shanghai-1)
   \ (eos-shanghai-1.cmecloud.cn)
 5 / Central China (Zhengzhou)
   \ (eos-zhengzhou-1.cmecloud.cn)
 6 / Central China (Changsha-1)
   \ (eos-hunan-1.cmecloud.cn)
 7 / Central China (Changsha-2)
   \ (eos-zhuzhou-1.cmecloud.cn)
 8 / South China (Guangzhou-2)
   \ (eos-guangzhou-1.cmecloud.cn)
 9 / South China (Guangzhou-3)
   \ (eos-dongguan-1.cmecloud.cn)
10 / North China (Beijing-1)
   \ (eos-beijing-1.cmecloud.cn)
11 / North China (Beijing-2)
   \ (eos-beijing-2.cmecloud.cn)
12 / North China (Beijing-3)
   \ (eos-beijing-4.cmecloud.cn)
13 / North China (Huhehaote)
   \ (eos-huhehaote-1.cmecloud.cn)
14 / Southwest China (Chengdu)
   \ (eos-chengdu-1.cmecloud.cn)
15 / Southwest China (Chongqing)
   \ (eos-chongqing-1.cmecloud.cn)
16 / Southwest China (Guiyang)
   \ (eos-guiyang-1.cmecloud.cn)
17 / Nouthwest China (Xian)
   \ (eos-xian-1.cmecloud.cn)
18 / Yunnan China (Kunming)
   \ (eos-yunnan.cmecloud.cn)
19 / Yunnan China (Kunming-2)
   \ (eos-yunnan-2.cmecloud.cn)
20 / Tianjin China (Tianjin)
   \ (eos-tianjin-1.cmecloud.cn)
21 / Jilin China (Changchun)
   \ (eos-jilin-1.cmecloud.cn)
22 / Hubei China (Xiangyan)
   \ (eos-hubei-1.cmecloud.cn)
23 / Jiangxi China (Nanchang)
   \ (eos-jiangxi-1.cmecloud.cn)
24 / Gansu China (Lanzhou)
   \ (eos-gansu-1.cmecloud.cn)
25 / Shanxi China (Taiyuan)
   \ (eos-shanxi-1.cmecloud.cn)
26 / Liaoning China (Shenyang)
   \ (eos-liaoning-1.cmecloud.cn)
27 / Hebei China (Shijiazhuang)
   \ (eos-hebei-1.cmecloud.cn)
28 / Fujian China (Xiamen)
   \ (eos-fujian-1.cmecloud.cn)
29 / Guangxi China (Nanning)
   \ (eos-guangxi-1.cmecloud.cn)
30 / Anhui China (Huainan)
   \ (eos-anhui-1.cmecloud.cn)
endpoint> 1
Option location_constraint.
Location constraint - must match endpoint.
Used when creating buckets only.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China (Suzhou)
   \ (wuxi1)
 2 / East China (Jinan)
   \ (jinan1)
 3 / East China (Hangzhou)
   \ (ningbo1)
 4 / East China (Shanghai-1)
   \ (shanghai1)
 5 / Central China (Zhengzhou)
   \ (zhengzhou1)
 6 / Central China (Changsha-1)
   \ (hunan1)
 7 / Central China (Changsha-2)
   \ (zhuzhou1)
 8 / South China (Guangzhou-2)
   \ (guangzhou1)
 9 / South China (Guangzhou-3)
   \ (dongguan1)
10 / North China (Beijing-1)
   \ (beijing1)
11 / North China (Beijing-2)
   \ (beijing2)
12 / North China (Beijing-3)
   \ (beijing4)
13 / North China (Huhehaote)
   \ (huhehaote1)
14 / Southwest China (Chengdu)
   \ (chengdu1)
15 / Southwest China (Chongqing)
   \ (chongqing1)
16 / Southwest China (Guiyang)
   \ (guiyang1)
17 / Nouthwest China (Xian)
   \ (xian1)
18 / Yunnan China (Kunming)
   \ (yunnan)
19 / Yunnan China (Kunming-2)
   \ (yunnan2)
20 / Tianjin China (Tianjin)
   \ (tianjin1)
21 / Jilin China (Changchun)
   \ (jilin1)
22 / Hubei China (Xiangyan)
   \ (hubei1)
23 / Jiangxi China (Nanchang)
   \ (jiangxi1)
24 / Gansu China (Lanzhou)
   \ (gansu1)
25 / Shanxi China (Taiyuan)
   \ (shanxi1)
26 / Liaoning China (Shenyang)
   \ (liaoning1)
27 / Hebei China (Shijiazhuang)
   \ (hebei1)
28 / Fujian China (Xiamen)
   \ (fujian1)
29 / Guangxi China (Nanning)
   \ (guangxi1)
30 / Anhui China (Huainan)
   \ (anhui1)
location_constraint> 1
Option 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.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
acl> private
Option server_side_encryption.
The server-side encryption algorithm used when storing this object in S3.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / None
   \ ()
 2 / AES256
   \ (AES256)
server_side_encryption>
Option storage_class.
The storage class to use when storing new objects in ChinaMobile.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Default
   \ ()
 2 / Standard storage class
   \ (STANDARD)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Infrequent access storage mode
   \ (STANDARD_IA)
storage_class>
Edit advanced config?
y) Yes
n) No (default)
y/n> n
--------------------
[ChinaMobile]
type = s3
provider = ChinaMobile
access_key_id = accesskeyid
secret_access_key = secretaccesskey
endpoint = eos-wuxi-1.cmecloud.cn
location_constraint = wuxi1
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Cloudflare R2

Cloudflare R2 Storage allows developers to store large amounts of unstructured data without the costly egress bandwidth fees associated with typical cloud storage services.

Here is an example of making a Cloudflare R2 configuration. First run:

rclone config

This will guide you through an interactive setup process.

Note that all buckets are private, and all are stored in the same "auto" region. It is necessary to use Cloudflare workers to share the content of a bucket publicly.

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> r2
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, Lyve Cloud, Minio, Magalu, Netease, RackCorp, Scaleway, SeaweedFS, Storj, Synology, Tencent COS and Wasabi
   \ (s3)
...
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
...
XX / Cloudflare R2 Storage
   \ (Cloudflare)
...
provider> Cloudflare
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / R2 buckets are automatically distributed across Cloudflare's data centers for low latency.
   \ (auto)
region> 1
Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> https://ACCOUNT_ID.r2.cloudflarestorage.com
Edit advanced config?
y) Yes
n) No (default)
y/n> n
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave your config looking something like:

[r2]
type = s3
provider = Cloudflare
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
region = auto
endpoint = https://ACCOUNT_ID.r2.cloudflarestorage.com
acl = private

Now run rclone lsf r2: to see your buckets and rclone lsf r2:bucket to look within a bucket.

For R2 tokens with the "Object Read & Write" permission, you may also need to add no_check_bucket = true for object uploads to work correctly.

Note that Cloudflare decompresses files uploaded with Content-Encoding: gzip by default which is a deviation from what AWS does. If this is causing a problem then upload the files with --header-upload "Cache-Control: no-transform"

A consequence of this is that Content-Encoding: gzip will never appear in the metadata on Cloudflare.

Cubbit DS3

Cubbit Object Storage is a geo-distributed cloud object storage platform.

To connect to Cubbit DS3 you will need an access key and secret key pair. You can follow this guide to retrieve these keys. They will be needed when prompted by rclone config.

Default region will correspond to eu-west-1 and the endpoint has to be specified as s3.cubbit.eu. If you set a custom tenant endpoint, you must use s3.{tenant_name}.cubbit.eu, because the generic s3.cubbit.eu endpoint will not work in this case.

Going through the whole process of creating a new remote by running rclone config, each prompt should be answered as shown below:

name> cubbit-ds3 (or any name you like)
Storage> s3
provider> Cubbit
env_auth> false
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region> eu-west-1 (or leave empty)
endpoint> s3.cubbit.eu (or s3.{tenant_name}.cubbit.eu)
acl>

The resulting configuration file should look like:

[cubbit-ds3]
type = s3
provider = Cubbit
access_key_id = ACCESS_KEY
secret_access_key = SECRET_KEY
region = eu-west-1
endpoint = s3.cubbit.eu

You can then start using Cubbit DS3 with rclone. For example, to create a new bucket and copy files into it, you can run:

rclone mkdir cubbit-ds3:my-bucket
rclone copy /path/to/files cubbit-ds3:my-bucket

DigitalOcean Spaces

Spaces is an S3-interoperable object storage service from cloud provider DigitalOcean.

To connect to DigitalOcean Spaces you will need an access key and secret key. These can be retrieved on the Applications & API page of the DigitalOcean control panel. They will be needed when prompted by rclone config for your access_key_id and secret_access_key.

When prompted for a region or location_constraint, press enter to use the default value. The region must be included in the endpoint setting (e.g. nyc3.digitaloceanspaces.com). The default values can be used for other settings.

Going through the whole process of creating a new remote by running rclone config, each prompt should be answered as shown below:

Storage> s3
env_auth> 1
access_key_id> YOUR_ACCESS_KEY
secret_access_key> YOUR_SECRET_KEY
region>
endpoint> nyc3.digitaloceanspaces.com
location_constraint>
acl>
storage_class>

The resulting configuration file should look like:

[spaces]
type = s3
provider = DigitalOcean
env_auth = false
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region =
endpoint = nyc3.digitaloceanspaces.com
location_constraint =
acl =
server_side_encryption =
storage_class =

Once configured, you can create a new Space and begin copying files. For example:

rclone mkdir spaces:my-new-space
rclone copy /path/to/files spaces:my-new-space

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 =

Exaba

Exaba is an on-premises, S3-compatible storage for service providers and large enterprises. It is quick to deploy, with dynamic node management, tenant accounting, and a built-in key management system. It delivers secure, high-performance data storage with flexible, usage-based pricing.

A container version exaba/exaba is free for end-users and on that page you can find instructions on how to set it up. You will need to log into the admin first (on port 9006 by default) to set up the container, then you can use the service on port 9000.

You can also join the exaba support slack if you need more help.

An rclone config walkthrough might look like this but details may vary depending exactly on how you have set up the container.

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> exaba

Option Storage.
Type of storage to configure.
Storage> s3

Option provider.
Choose your S3 provider.
provider> Exaba

Option env_auth.
env_auth> 1

Option access_key_id.
access_key_id> XXX

Option secret_access_key.
secret_access_key> YYY

Option region.
region>

Option endpoint.
endpoint> http://127.0.0.1:9000/

Option location_constraint.
location_constraint>

Option acl.
acl>

Edit advanced config?
y) Yes
n) No (default)
y/n> n

And the config generated will end up looking like this:

[exaba]
type = s3
provider = Exaba
access_key_id = XXX
secret_access_key = XXX
endpoint = http://127.0.0.1:9000/

Fastly Object Storage

Fastly Object Storage is an S3-compatible object storage service from Fastly. It provides three regions (US East, US West, and EU Central) with mandatory server-side encryption.

Here is an example of making a 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

Enter name for new remote.
name> fastly

Option Storage.
Type of storage to configure.
Storage> s3

Option provider.
Choose your S3 provider.
provider> Fastly

Option 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.
env_auth> false

Option access_key_id.
AWS Access Key ID.
access_key_id> YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
secret_access_key> YOUR_SECRET_KEY

Option region.
Region where your bucket will be created and your data stored.
region> us-east

Option endpoint.
Endpoint for S3 API.
endpoint> us-east.object.fastlystorage.app

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Fastly
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- region: us-east
- endpoint: us-east.object.fastlystorage.app
Keep this "fastly" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

The resulting configuration file should look like:

[fastly]
type = s3
provider = Fastly
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
region = us-east
endpoint = us-east.object.fastlystorage.app

Google Cloud Storage

GoogleCloudStorage is an S3-interoperable object storage service from Google Cloud Platform.

To connect to Google Cloud Storage you will need an access key and secret key. These can be retrieved by creating an HMAC key.

[gs]
type = s3
provider = GCS
access_key_id = your_access_key
secret_access_key = your_secret_key
endpoint = https://storage.googleapis.com

Note that --s3-versions does not work with GCS when it needs to do directory paging. Rclone will return the error:

s3 protocol error: received versions listing with IsTruncated set with no NextKeyMarker

This is Google bug #312292516.

Hetzner Object Storage

Here is an example of making a Hetzner Object Storage 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

Enter name for new remote.
name> my-hetzner
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[snip]
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Hetzner Object Storage
   \ (Hetzner)
[snip]
provider> Hetzner
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_KEY
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Helsinki
   \ (hel1)
 2 / Falkenstein
   \ (fsn1)
 3 / Nuremberg
   \ (nbg1)
region> 
Option endpoint.
Endpoint for Hetzner Object Storage
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Helsinki
   \ (hel1.your-objectstorage.com)
 2 / Falkenstein
   \ (fsn1.your-objectstorage.com)
 3 / Nuremberg
   \ (nbg1.your-objectstorage.com)
endpoint> 
Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint> 
Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
acl> 
Edit advanced config?
y) Yes
n) No (default)
y/n> 
Configuration complete.
Options:
- type: s3
- provider: Hetzner
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_KEY
Keep this "my-hetzner" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> 
Current remotes:

Name                 Type
====                 ====
my-hetzner           s3

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>

This will leave the config file looking like this.

[my-hetzner]
type = s3
provider = Hetzner
access_key_id = ACCESS_KEY
secret_access_key = SECRET_KEY
region = hel1
endpoint = hel1.your-objectstorage.com
acl = private

Hitachi Content Platform (HCP)

Here is an example of making a Hitachi Content Platform (HCP) 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

Enter name for new remote.
name> my-hcp
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HCP, Hetzner, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[snip]
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Hitachi Content Platform (HCP)
   \ (HCP)
[snip]
provider> HCP
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_KEY
Option endpoint.
Endpoint for HCP S3 compatible API.
Enter a value. Press Enter to leave empty.
endpoint> https://hcp.example.com
Edit advanced config?
y) Yes
n) No (default)
y/n> 
Configuration complete.
Options:
- type: s3
- provider: HCP
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_KEY
- endpoint: https://hcp.example.com
Keep this "my-hcp" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> 
Current remotes:

Name                 Type
====                 ====
my-hcp               s3

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>

This will leave the config file looking like this.

[my-hcp]
type = s3
provider = HCP
access_key_id = ACCESS_KEY
secret_access_key = SECRET_KEY
endpoint = https://hcp.example.com

Known limitations

These limitations have been observed with HCP version 9.7.x.

Automatic directory objects

HCP automatically creates zero-byte directory objects (keys ending in /) for every path component when an object is stored. These directory objects are managed by HCP internally: deleting one via the S3 API does not remove it but instead creates a delete marker with a special version ID (-3) that cannot itself be deleted. As a result, rclone cannot fully purge a bucket on HCP — leftover directory objects will remain after a purge or delete operation.

Transparent gzip decompression

HCP transparently decompresses objects uploaded with Content-Encoding: gzip before storing them. This means the stored object contains the raw (uncompressed) data, while the Content-MD5 sent by rclone was computed over the compressed bytes. HCP will reject such uploads with a BadDigest error. To avoid this, do not set content-encoding: gzip in object metadata when using HCP.

Huawei OBS

Object Storage Service (OBS) provides stable, secure, efficient, and easy-to-use cloud storage that lets you store virtually any volume of unstructured data in any format and access it from anywhere.

OBS provides an S3 interface, you can copy and modify the following configuration and add it to your rclone configuration file.

[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private

Or you can also configure via the interactive command line:

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> obs
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
 9 / Huawei Object Storage Service
   \ (HuaweiOBS)
[snip]
provider> 9
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> your-access-key-id
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> your-secret-access-key
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (af-south-1)
 2 / AP-Bangkok
   \ (ap-southeast-2)
[snip]
region> 1
Option endpoint.
Endpoint for OBS API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / AF-Johannesburg
   \ (obs.af-south-1.myhuaweicloud.com)
 2 / AP-Bangkok
   \ (obs.ap-southeast-2.myhuaweicloud.com)
[snip]
endpoint> 1
Option 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.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl> 1
Edit advanced config?
y) Yes
n) No (default)
y/n>
--------------------
[obs]
type = s3
provider = HuaweiOBS
access_key_id = your-access-key-id
secret_access_key = your-secret-access-key
region = af-south-1
endpoint = obs.af-south-1.myhuaweicloud.com
acl = private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
Current remotes:

Name                 Type
====                 ====
obs                  s3

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

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:

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

Enter the name for the configuration
```
name> <YOUR NAME>
```

Select "s3" storage.

Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "s3"
[snip]
Storage> s3

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

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

Specify the endpoint for IBM COS. For Public IBM COS, choose from the option below. For On Premise IBM COS, enter an endpoint address.

Endpoint for IBM COS S3 API.
Specify if using an IBM COS On Premise.
Choose a number from below, or type in your own value
 1 / US Cross Region Endpoint
   \ "s3-api.us-geo.objectstorage.softlayer.net"
 2 / US Cross Region Dallas Endpoint
   \ "s3-api.dal.us-geo.objectstorage.softlayer.net"
 3 / US Cross Region Washington DC Endpoint
   \ "s3-api.wdc-us-geo.objectstorage.softlayer.net"
 4 / US Cross Region San Jose Endpoint
   \ "s3-api.sjc-us-geo.objectstorage.softlayer.net"
 5 / US Cross Region Private Endpoint
   \ "s3-api.us-geo.objectstorage.service.networklayer.com"
 6 / US Cross Region Dallas Private Endpoint
   \ "s3-api.dal-us-geo.objectstorage.service.networklayer.com"
 7 / US Cross Region Washington DC Private Endpoint
   \ "s3-api.wdc-us-geo.objectstorage.service.networklayer.com"
 8 / US Cross Region San Jose Private Endpoint
   \ "s3-api.sjc-us-geo.objectstorage.service.networklayer.com"
 9 / US Region East Endpoint
   \ "s3.us-east.objectstorage.softlayer.net"
10 / US Region East Private Endpoint
   \ "s3.us-east.objectstorage.service.networklayer.com"
11 / US Region South Endpoint
[snip]
34 / Toronto Single Site Private Endpoint
   \ "s3.tor01.objectstorage.service.networklayer.com"
endpoint>1

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

Specify a canned ACL. IBM Cloud (Storage) supports "public-read" and "private". IBM Cloud(Infra) supports all the canned ACLs. On-Premise COS supports all the canned ACLs.

Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
Choose a number from below, or type in your own value
      1 / Owner gets FULL_CONTROL. No one else has access rights (default). This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise COS
      \ "private"
      2  / Owner gets FULL_CONTROL. The AllUsers group gets READ access. This acl is available on IBM Cloud (Infra), IBM Cloud (Storage), On-Premise IBM COS
      \ "public-read"
      3 / Owner gets FULL_CONTROL. The AllUsers group gets READ and WRITE access. This acl is available on IBM Cloud (Infra), On-Premise IBM COS
      \ "public-read-write"
      4  / Owner gets FULL_CONTROL. The AuthenticatedUsers group gets READ access. Not supported on Buckets. This acl is available on IBM Cloud (Infra) and On-Premise IBM COS
      \ "authenticated-read"
acl> 1

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

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

IBM IAM authentication

If using IBM IAM authentication with IBM API KEY you need to fill in these additional parameters

Select false for env_auth
Leave access_key_id and secret_access_key blank

Paste your ibm_api_key

Option ibm_api_key.
IBM API Key to be used to obtain IAM token
Enter a value of type string. Press Enter for the default (1).
ibm_api_key>

Paste your ibm_resource_instance_id

Option ibm_resource_instance_id.
IBM service instance id
Enter a value of type string. Press Enter for the default (2).
ibm_resource_instance_id>

In advanced settings type true for v2_auth

Option v2_auth.
If true use v2 authentication.
If this is false (the default) then rclone will use v4 authentication.
If it is set then rclone will use v2 authentication.
Use this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.
Enter a boolean value (true or false). Press Enter for the default (true).
v2_auth>

IDrive e2

Here is an example of making an IDrive e2 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

Enter name for new remote.
name> e2

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IDrive e2
   \ (IDrive)
[snip]
provider> IDrive

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> YOUR_SECRET_KEY

Option 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.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | 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> 

Edit advanced config?
y) Yes
n) No (default)
y/n> 

Configuration complete.
Options:
- type: s3
- provider: IDrive
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: q9d9.la12.idrivee2-5.com
Keep this "e2" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Impossible Cloud

Impossible Cloud is a European S3-compatible object storage provider with regions in Europe and the US.

Note: Impossible Cloud does not preserve the Cache-Control, Content-Disposition, Content-Encoding or Content-Language system metadata fields on retrieval, even when they were set at upload time. Because the Content-Encoding response header is also dropped, the --s3-decompress flag has no effect on objects stored there. Other metadata such as Content-Type and the modification time round-trip normally.

Here is an example of making an Impossible Cloud 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

Enter name for new remote.
name> my-impossible-cloud
Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, Hetzner, HuaweiOBS, IBMCOS, IDrive, ImpossibleCloud, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[snip]
Storage> s3
Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Impossible Cloud Object Storage
   \ (ImpossibleCloud)
[snip]
provider> ImpossibleCloud
Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_KEY
Option region.
Region to connect to.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (eu-central-2)
 2 / Amsterdam, Netherlands
   \ (eu-west-1)
 3 / London, UK
   \ (eu-west-2)
 4 / Paris, France
   \ (eu-west-3)
 5 / Poznań, Poland
   \ (eu-east-1)
 6 / Copenhagen, Denmark
   \ (eu-north-1)
 7 / New York, USA
   \ (us-east-1)
region> 1
Option endpoint.
Endpoint for Impossible Cloud Object Storage
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (eu-central-2.storage.impossibleapi.net)
 2 / Amsterdam, Netherlands
   \ (eu-west-1.storage.impossibleapi.net)
 3 / London, UK
   \ (eu-west-2.storage.impossibleapi.net)
 4 / Paris, France
   \ (eu-west-3.storage.impossibleapi.net)
 5 / Poznań, Poland
   \ (eu-east-1.storage.impossibleapi.net)
 6 / Copenhagen, Denmark
   \ (eu-north-1.storage.impossibleapi.net)
 7 / New York, USA
   \ (us-east-1.storage.impossibleapi.net)
endpoint> 1
Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint> 
Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
acl> 
Edit advanced config?
y) Yes
n) No (default)
y/n> 
Configuration complete.
Options:
- type: s3
- provider: ImpossibleCloud
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_KEY
- region: eu-central-2
- endpoint: eu-central-2.storage.impossibleapi.net
Keep this "my-impossible-cloud" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> 
Current remotes:

Name                 Type
====                 ====
my-impossible-cloud  s3

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>

This will leave the config file looking like this.

[my-impossible-cloud]
type = s3
provider = ImpossibleCloud
access_key_id = ACCESS_KEY
secret_access_key = SECRET_KEY
region = eu-central-2
endpoint = eu-central-2.storage.impossibleapi.net
acl = private

Intercolo Object Storage

Intercolo Object Storage offers GDPR-compliant, transparently priced, S3-compatible cloud storage hosted in Frankfurt, Germany.

Here's an example of making a configuration for Intercolo.

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

Enter name for new remote.
name> intercolo

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 xx / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
xx / Intercolo Object Storage
   \ (Intercolo)
[snip]
provider> Intercolo

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> false

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_KEY

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (de-fra)
region> 1

Option endpoint.
Endpoint for Intercolo Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (de-fra.i3storage.com)
endpoint> 1

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
 [snip]
acl> 

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Intercolo
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_KEY
- region: de-fra
- endpoint: de-fra.i3storage.com
Keep this "intercolo" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[intercolo]
type = s3
provider = Intercolo
access_key_id = ACCESS_KEY
secret_access_key = SECRET_KEY
region = de-fra
endpoint = de-fra.i3storage.com

IONOS Cloud

IONOS S3 Object Storage is a service offered by IONOS for storing and accessing unstructured data. To connect to the service, you will need an access key and a secret key. These can be found in the Data Center Designer, by selecting Manager resources > Object Storage Key Manager.

Here is an example of a configuration. First, run rclone config. This will walk you through an interactive setup process. Type n to add the new remote, and then enter a name:

Enter name for new remote.
name> ionos-fra

Type s3 to choose the connection type:

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Type IONOS:

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / IONOS Cloud
   \ (IONOS)
[snip]
provider> IONOS

Press Enter to choose the default option Enter AWS credentials in the next step:

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

Enter your Access Key and Secret key. These can be retrieved in the Data Center Designer, click on the menu "Manager resources" / "Object Storage Key Manager".

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> YOUR_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> YOUR_SECRET_KEY

Choose the region where your bucket is located:

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (de)
 2 / Berlin, Germany
   \ (eu-central-2)
 3 / Logrono, Spain
   \ (eu-south-2)
region> 2

Choose the endpoint from the same region:

Option endpoint.
Endpoint for IONOS S3 Object Storage.
Specify the endpoint from the same region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Frankfurt, Germany
   \ (s3-eu-central-1.ionoscloud.com)
 2 / Berlin, Germany
   \ (s3-eu-central-2.ionoscloud.com)
 3 / Logrono, Spain
   \ (s3-eu-south-2.ionoscloud.com)
endpoint> 1

Press Enter to choose the default option or choose the desired ACL setting:

Option 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.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
[snip]
acl>

Press Enter to skip the advanced config:

Edit advanced config?
y) Yes
n) No (default)
y/n>

Press Enter to save the configuration, and then q to quit the configuration process:

Configuration complete.
Options:
- type: s3
- provider: IONOS
- access_key_id: YOUR_ACCESS_KEY
- secret_access_key: YOUR_SECRET_KEY
- endpoint: s3-eu-central-1.ionoscloud.com
Keep this "ionos-fra" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Done! Now you can try some commands (for macOS, use ./rclone instead of rclone).

Create a bucket (the name must be unique within the whole IONOS S3)
```
rclone mkdir ionos-fra:my-bucket
```
List available buckets
```
rclone lsd ionos-fra:
```

Copy a file from local to remote

rclone copy /Users/file.txt ionos-fra:my-bucket

List contents of a bucket
```
rclone ls ionos-fra:my-bucket
```

Copy a file from remote to local

rclone copy ionos-fra:my-bucket/file.txt

Leviia Cloud Object Storage

Leviia Object Storage, backup and secure your data in a 100% French cloud, independent of GAFAM..

To configure access to Leviia, follow the steps below:

Run rclone config and select n for a new remote.

rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Give the name of the configuration. For example, name it 'leviia'.
```
name> leviia
```

Select s3 storage.

Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Select Leviia provider.

Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ "AWS"
[snip]
15 / Leviia Object Storage
   \ (Leviia)
[snip]
provider> Leviia

Enter your SecretId and SecretKey of Leviia.

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> ZnIx.xxxxxxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
secret_access_key> xxxxxxxxxxx

Select endpoint for Leviia.

   / The default endpoint
 1 | Leviia.
   \ (s3.leviia.com)
[snip]
endpoint> 1

Choose 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
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
[snip]
acl> 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n
Remote config
--------------------
[leviia]
- type: s3
- provider: Leviia
- access_key_id: ZnIx.xxxxxxx
- secret_access_key: xxxxxxxx
- endpoint: s3.leviia.com
- acl: private
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
Current remotes:

Name                 Type
====                 ====
leviia                s3

Liara

Here is an example of making a Liara Object Storage configuration. First run:

rclone config

This will guide you through an interactive setup process.

No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s> n
name> Liara
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 (also Dreamhost, Ceph, ChinaMobile, ArvanCloud, Liara, 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
 1 | US Region, Northern Virginia, or Pacific Northwest.
   | Leave location constraint empty.
   \ "us-east-1"
[snip]
region>
Endpoint for S3 API.
Leave blank if using Liara to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph.
endpoint> storage.iran.liara.space
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"
storage_class>
Remote config
--------------------
[Liara]
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
endpoint = storage.iran.liara.space
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.

[Liara]
type = s3
provider = Liara
env_auth = false
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region =
endpoint = storage.iran.liara.space
location_constraint =
acl =
server_side_encryption =
storage_class =

Linode

Here is an example of making a Linode Object Storage 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

Enter name for new remote.
name> linode

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...Linode, ...and others
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Linode Object Storage
   \ (Linode)
[snip]
provider> Linode

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option endpoint.
Endpoint for Linode Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Amsterdam (Netherlands), nl-ams-1
   \ (nl-ams-1.linodeobjects.com)
 2 / Atlanta, GA (USA), us-southeast-1
   \ (us-southeast-1.linodeobjects.com)
 3 / Chennai (India), in-maa-1
   \ (in-maa-1.linodeobjects.com)
 4 / Chicago, IL (USA), us-ord-1
   \ (us-ord-1.linodeobjects.com)
 5 / Frankfurt (Germany), eu-central-1
   \ (eu-central-1.linodeobjects.com)
 6 / Jakarta (Indonesia), id-cgk-1
   \ (id-cgk-1.linodeobjects.com)
 7 / London 2 (Great Britain), gb-lon-1
   \ (gb-lon-1.linodeobjects.com)
 8 / Los Angeles, CA (USA), us-lax-1
   \ (us-lax-1.linodeobjects.com)
 9 / Madrid (Spain), es-mad-1
   \ (es-mad-1.linodeobjects.com)
10 / Melbourne (Australia), au-mel-1
   \ (au-mel-1.linodeobjects.com)
11 / Miami, FL (USA), us-mia-1
   \ (us-mia-1.linodeobjects.com)
12 / Milan (Italy), it-mil-1
   \ (it-mil-1.linodeobjects.com)
13 / Newark, NJ (USA), us-east-1
   \ (us-east-1.linodeobjects.com)
14 / Osaka (Japan), jp-osa-1
   \ (jp-osa-1.linodeobjects.com)
15 / Paris (France), fr-par-1
   \ (fr-par-1.linodeobjects.com)
16 / São Paulo (Brazil), br-gru-1
   \ (br-gru-1.linodeobjects.com)
17 / Seattle, WA (USA), us-sea-1
   \ (us-sea-1.linodeobjects.com)
18 / Singapore, ap-south-1
   \ (ap-south-1.linodeobjects.com)
19 / Singapore 2, sg-sin-1
   \ (sg-sin-1.linodeobjects.com)
20 / Stockholm (Sweden), se-sto-1
   \ (se-sto-1.linodeobjects.com)
21 / Washington, DC, (USA), us-iad-1
   \ (us-iad-1.linodeobjects.com)
endpoint> 5

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl> 

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Linode
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: eu-central-1.linodeobjects.com
Keep this "linode" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[linode]
type = s3
provider = Linode
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
endpoint = eu-central-1.linodeobjects.com

Magalu

Here is an example of making a Magalu Object Storage 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

Enter name for new remote.
name> magalu

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...Magalu, ...and others
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Magalu Object Storage
   \ (Magalu)
[snip]
provider> Magalu

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option endpoint.
Endpoint for Magalu Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / São Paulo, SP (BR), br-se1
   \ (br-se1.magaluobjects.com)
 2 / Fortaleza, CE (BR), br-ne1
   \ (br-ne1.magaluobjects.com)
endpoint> 2

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl> 

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: magalu
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: br-ne1.magaluobjects.com
Keep this "magalu" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[magalu]
type = s3
provider = Magalu
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
endpoint = br-ne1.magaluobjects.com

MEGA S4

MEGA S4 Object Storage is an S3 compatible object storage system. It has a single pricing tier with no additional charges for data transfers or API requests and it is included in existing Pro plans.

Here is an example of making a 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

Enter name for new remote.
name> megas4

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS,... Mega, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / MEGA S4 Object Storage
   \ (Mega)
[snip]
provider> Mega

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> XXX

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> XXX

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Mega S4 eu-central-1 (Amsterdam)
   \ (s3.eu-central-1.s4.mega.io)
 2 / Mega S4 eu-central-2 (Bettembourg)
   \ (s3.eu-central-2.s4.mega.io)
 3 / Mega S4 ca-central-1 (Montreal)
   \ (s3.ca-central-1.s4.mega.io)
 4 / Mega S4 ca-west-1 (Vancouver)
   \ (s3.ca-west-1.s4.mega.io)
endpoint> 1

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Mega
- access_key_id: XXX
- secret_access_key: XXX
- endpoint: s3.eu-central-1.s4.mega.io
Keep this "megas4" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[megas4]
type = s3
provider = Mega
access_key_id = XXX
secret_access_key = XXX
endpoint = s3.eu-central-1.s4.mega.io

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

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.

Outscale

OUTSCALE Object Storage (OOS) is an enterprise-grade, S3-compatible storage service provided by OUTSCALE, a brand of Dassault Systèmes. For more information about OOS, see the official documentation.

Here is an example of an OOS configuration that you can paste into your rclone configuration file:

[outscale]
type = s3
provider = Outscale
env_auth = false
access_key_id = ABCDEFGHIJ0123456789
secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
region = eu-west-2
endpoint = oos.eu-west-2.outscale.com
acl = private

You can also run rclone config to go through the interactive setup process:

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> outscale

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 X / Amazon S3 Compliant Storage Providers including AWS, ...Outscale, ...and others
   \ (s3)
[snip]
Storage> outscale

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / OUTSCALE Object Storage (OOS)
   \ (Outscale)
[snip]
provider> Outscale

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ABCDEFGHIJ0123456789

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Paris, France
   \ (eu-west-2)
 2 / New Jersey, USA
   \ (us-east-2)
 3 / California, USA
   \ (us-west-1)
 4 / SecNumCloud, Paris, France
   \ (cloudgouv-eu-west-1)
 5 / Tokyo, Japan
   \ (ap-northeast-1)
region> 1

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Outscale EU West 2 (Paris)
   \ (oos.eu-west-2.outscale.com)
 2 / Outscale US east 2 (New Jersey)
   \ (oos.us-east-2.outscale.com)
 3 / Outscale EU West 1 (California)
   \ (oos.us-west-1.outscale.com)
 4 / Outscale SecNumCloud (Paris)
   \ (oos.cloudgouv-eu-west-1.outscale.com)
 5 / Outscale AP Northeast 1 (Japan)
   \ (oos.ap-northeast-1.outscale.com)
endpoint> 1

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl> 1

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Outscale
- access_key_id: ABCDEFGHIJ0123456789
- secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
- endpoint: oos.eu-west-2.outscale.com
Keep this "outscale" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

OVHcloud

OVHcloud Object Storage is an S3-compatible general-purpose object storage platform available in all OVHcloud regions. To use the platform, you will need an access key and secret key. To know more about it and how to interact with the platform, take a look at the documentation.

Here is an example of making an OVHcloud Object Storage configuration with rclone config:

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> ovhcloud-rbx

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[...]
 XX / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, OVHcloud, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[...]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[...]
XX / OVHcloud Object Storage
   \ (OVHcloud)
[...]
provider> OVHcloud

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> my_access

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> my_secret

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Gravelines, France
   \ (gra)
 2 / Roubaix, France
   \ (rbx)
 3 / Strasbourg, France
   \ (sbg)
 4 / Paris, France (3AZ)
   \ (eu-west-par)
 5 / Frankfurt, Germany
   \ (de)
 6 / London, United Kingdom
   \ (uk)
 7 / Warsaw, Poland
   \ (waw)
 8 / Beauharnois, Canada
   \ (bhs)
 9 / Toronto, Canada
   \ (ca-east-tor)
10 / Singapore
   \ (sgp)
11 / Sydney, Australia
   \ (ap-southeast-syd)
12 / Mumbai, India
   \ (ap-south-mum)
13 / Vint Hill, Virginia, USA
   \ (us-east-va)
14 / Hillsboro, Oregon, USA
   \ (us-west-or)
15 / Roubaix, France (Cold Archive)
   \ (rbx-archive)
region> 2

Option endpoint.
Endpoint for OVHcloud Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / OVHcloud Gravelines, France
   \ (s3.gra.io.cloud.ovh.net)
 2 / OVHcloud Roubaix, France
   \ (s3.rbx.io.cloud.ovh.net)
 3 / OVHcloud Strasbourg, France
   \ (s3.sbg.io.cloud.ovh.net)
 4 / OVHcloud Paris, France (3AZ)
   \ (s3.eu-west-par.io.cloud.ovh.net)
 5 / OVHcloud Frankfurt, Germany
   \ (s3.de.io.cloud.ovh.net)
 6 / OVHcloud London, United Kingdom
   \ (s3.uk.io.cloud.ovh.net)
 7 / OVHcloud Warsaw, Poland
   \ (s3.waw.io.cloud.ovh.net)
 8 / OVHcloud Beauharnois, Canada
   \ (s3.bhs.io.cloud.ovh.net)
 9 / OVHcloud Toronto, Canada
   \ (s3.ca-east-tor.io.cloud.ovh.net)
10 / OVHcloud Singapore
   \ (s3.sgp.io.cloud.ovh.net)
11 / OVHcloud Sydney, Australia
   \ (s3.ap-southeast-syd.io.cloud.ovh.net)
12 / OVHcloud Mumbai, India
   \ (s3.ap-south-mum.io.cloud.ovh.net)
13 / OVHcloud Vint Hill, Virginia, USA
   \ (s3.us-east-va.io.cloud.ovh.us)
14 / OVHcloud Hillsboro, Oregon, USA
   \ (s3.us-west-or.io.cloud.ovh.us)
15 / OVHcloud Roubaix, France (Cold Archive)
   \ (s3.rbx-archive.io.cloud.ovh.net)
endpoint> 2

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | 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

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: OVHcloud
- access_key_id: my_access
- secret_access_key: my_secret
- region: rbx
- endpoint: s3.rbx.io.cloud.ovh.net
- acl: private
Keep this "ovhcloud-rbx" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Your configuration file should now look like this:

[ovhcloud-rbx]
type = s3
provider = OVHcloud
access_key_id = my_access
secret_access_key = my_secret
region = rbx
endpoint = s3.rbx.io.cloud.ovh.net
acl = private

Petabox

Here is an example of making a Petabox configuration. First run:

rclone config

This will guide you through an interactive setup process.

No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s> n

Enter name for new remote.
name> My Petabox Storage

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "s3"
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Petabox Object Storage
   \ (Petabox)
[snip]
provider> Petabox

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> YOUR_ACCESS_KEY_ID

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> YOUR_SECRET_ACCESS_KEY

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / US East (N. Virginia)
   \ (us-east-1)
 2 / Europe (Frankfurt)
   \ (eu-central-1)
 3 / Asia Pacific (Singapore)
   \ (ap-southeast-1)
 4 / Middle East (Bahrain)
   \ (me-south-1)
 5 / South America (São Paulo)
   \ (sa-east-1)
region> 1

Option endpoint.
Endpoint for Petabox S3 Object Storage.
Specify the endpoint from the same region.
Choose a number from below, or type in your own value.
 1 / US East (N. Virginia)
   \ (s3.petabox.io)
 2 / US East (N. Virginia)
   \ (s3.us-east-1.petabox.io)
 3 / Europe (Frankfurt)
   \ (s3.eu-central-1.petabox.io)
 4 / Asia Pacific (Singapore)
   \ (s3.ap-southeast-1.petabox.io)
 5 / Middle East (Bahrain)
   \ (s3.me-south-1.petabox.io)
 6 / South America (São Paulo)
   \ (s3.sa-east-1.petabox.io)
endpoint> 1

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | 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

Edit advanced config?
y) Yes
n) No (default)
y/n> No

Configuration complete.
Options:
- type: s3
- provider: Petabox
- access_key_id: YOUR_ACCESS_KEY_ID
- secret_access_key: YOUR_SECRET_ACCESS_KEY
- region: us-east-1
- endpoint: s3.petabox.io
Keep this "My Petabox Storage" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[My Petabox Storage]
type = s3
provider = Petabox
access_key_id = YOUR_ACCESS_KEY_ID
secret_access_key = YOUR_SECRET_ACCESS_KEY
region = us-east-1
endpoint = s3.petabox.io

Pure Storage FlashBlade

Pure Storage FlashBlade is a high performance S3-compatible object store.

FlashBlade supports most modern S3 features including:

ListObjectsV2
Multipart uploads with AWS-compatible ETags
Advanced checksum algorithms (SHA256, CRC32, CRC32C) with trailer support (Purity//FB 4.4.2+)
Object versioning and lifecycle management
Virtual hosted-style requests (requires DNS configuration)

To configure rclone for Pure Storage FlashBlade:

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

Enter name for new remote.
name> flashblade

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
 4 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, FlashBlade, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Outscale, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, Selectel, Storj, Synology, TencentCOS, Wasabi, Qiniu and others
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
 9 / Pure Storage FlashBlade Object Storage
   \ (FlashBlade)
[snip]
provider> FlashBlade

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY_ID

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> https://s3.flashblade.example.com

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: FlashBlade
- access_key_id: ACCESS_KEY_ID
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: https://s3.flashblade.example.com
Keep this "flashblade" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This results in the following configuration being stored in ~/.config/rclone/rclone.conf:

[flashblade]
type = s3
provider = FlashBlade
access_key_id = ACCESS_KEY_ID
secret_access_key = SECRET_ACCESS_KEY
endpoint = https://s3.flashblade.example.com

Note: The FlashBlade endpoint should be the S3 data VIP. For virtual-hosted style requests, ensure proper DNS configuration: subdomains of the endpoint hostname should resolve to a FlashBlade data VIP. For example, if your endpoint is https://s3.flashblade.example.com, then bucket-name.s3.flashblade.example.com should also resolve to the data VIP.

Qiniu Cloud Object Storage (Kodo)

Qiniu Cloud Object Storage (Kodo), a completely independent-researched core technology which is proven by repeated customer experience has occupied absolute leading market leader position. Kodo can be widely applied to mass data management.

To configure access to Qiniu Kodo, follow the steps below:

Run rclone config and select n for a new remote.

rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Give the name of the configuration. For example, name it 'qiniu'.
```
name> qiniu
```

Select s3 storage.

Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Select Qiniu provider.

Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ "AWS"
[snip]
22 / Qiniu Object Storage (Kodo)
   \ (Qiniu)
[snip]
provider> Qiniu

Enter your SecretId and SecretKey of Qiniu Kodo.

Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default ("false").
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ "false"
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ "true"
env_auth> 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
access_key_id> AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
secret_access_key> xxxxxxxxxxx

Select endpoint for Qiniu Kodo. This is the standard endpoint for different region.

   / The default endpoint - a good choice if you are unsure.
 1 | East China Region 1.
   | Needs location constraint cn-east-1.
   \ (cn-east-1)
   / East China Region 2.
 2 | Needs location constraint cn-east-2.
   \ (cn-east-2)
   / North China Region 1.
 3 | Needs location constraint cn-north-1.
   \ (cn-north-1)
   / South China Region 1.
 4 | Needs location constraint cn-south-1.
   \ (cn-south-1)
   / North America Region.
 5 | Needs location constraint us-north-1.
   \ (us-north-1)
   / Southeast Asia Region 1.
 6 | Needs location constraint ap-southeast-1.
   \ (ap-southeast-1)
   / Northeast Asia Region 1.
 7 | Needs location constraint ap-northeast-1.
   \ (ap-northeast-1)
[snip]
endpoint> 1

Option endpoint.
Endpoint for Qiniu Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / East China Endpoint 1
   \ (s3-cn-east-1.qiniucs.com)
 2 / East China Endpoint 2
   \ (s3-cn-east-2.qiniucs.com)
 3 / North China Endpoint 1
   \ (s3-cn-north-1.qiniucs.com)
 4 / South China Endpoint 1
   \ (s3-cn-south-1.qiniucs.com)
 5 / North America Endpoint 1
   \ (s3-us-north-1.qiniucs.com)
 6 / Southeast Asia Endpoint 1
   \ (s3-ap-southeast-1.qiniucs.com)
 7 / Northeast Asia Endpoint 1
   \ (s3-ap-northeast-1.qiniucs.com)
endpoint> 1

Option location_constraint.
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.
Press Enter to leave empty.
 1 / East China Region 1
   \ (cn-east-1)
 2 / East China Region 2
   \ (cn-east-2)
 3 / North China Region 1
   \ (cn-north-1)
 4 / South China Region 1
   \ (cn-south-1)
 5 / North America Region 1
   \ (us-north-1)
 6 / Southeast Asia Region 1
   \ (ap-southeast-1)
 7 / Northeast Asia Region 1
   \ (ap-northeast-1)
location_constraint> 1

Choose acl and storage class.

Note that this ACL is applied when server-side copying objects as S3
doesn't copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
[snip]
acl> 2
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Standard storage class
   \ (STANDARD)
 2 / Infrequent access storage mode
   \ (LINE)
 3 / Archive storage mode
   \ (GLACIER)
 4 / Deep archive storage mode
   \ (DEEP_ARCHIVE)
[snip]
storage_class> 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n
Remote config
--------------------
[qiniu]
- type: s3
- provider: Qiniu
- access_key_id: xxx
- secret_access_key: xxx
- region: cn-east-1
- endpoint: s3-cn-east-1.qiniucs.com
- location_constraint: cn-east-1
- acl: public-read
- storage_class: STANDARD
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
Current remotes:

Name                 Type
====                 ====
qiniu                s3

FileLu S5

FileLu S5 Object Storage is an S3-compatible object storage system. It provides multiple region options (Global, US-East, EU-Central, AP-Southeast, and ME-Central) while using a single endpoint (s5lu.com). FileLu S5 is designed for scalability, security, and simplicity, with predictable pricing and no hidden charges for data transfers or API requests.

Here is an example of making a 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

Enter name for new remote.
name> s5lu

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS,... FileLu, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / FileLu S5 Object Storage
   \ (FileLu)
[snip]
provider> FileLu

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> XXX

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> XXX

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Global
   \ (global)
 2 / North America (US-East)
   \ (us-east)
 3 / Europe (EU-Central)
   \ (eu-central)
 4 / Asia Pacific (AP-Southeast)
   \ (ap-southeast)
 5 / Middle East (ME-Central)
   \ (me-central)
region> 1

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: FileLu
- access_key_id: XXX
- secret_access_key: XXX
- endpoint: s5lu.com
Keep this "s5lu" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[s5lu]
type = s3
provider = FileLu
access_key_id = XXX
secret_access_key = XXX
endpoint = s5lu.com

Rabata

Rabata is an S3-compatible secure cloud storage service that offers flat, transparent pricing (no API request fees) while supporting standard S3 APIs. It is suitable for backup, application storage,media workflows, and archive use cases.

Server side copy is not implemented with Rabata, also meaning modification time of objects cannot be updated.

Rclone config:

rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> Rabata

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Rabata Cloud Storage
   \ (Rabata)
[snip]
provider> Rabata

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY_ID

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option region.
Region where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / US East (N. Virginia)
   \ (us-east-1)
 2 / EU (Ireland)
   \ (eu-west-1)
 3 / EU (London)
   \ (eu-west-2)
region> 3

Option endpoint.
Endpoint for Rabata Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / US East (N. Virginia)
   \ (s3.us-east-1.rabata.io)
 2 / EU West (Ireland)
   \ (s3.eu-west-1.rabata.io)
 3 / EU West (London)
   \ (s3.eu-west-2.rabata.io)
endpoint> 3

Option location_constraint.
location where your bucket will be created and your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / US East (N. Virginia)
   \ (us-east-1)
 2 / EU (Ireland)
   \ (eu-west-1)
 3 / EU (London)
   \ (eu-west-2)
location_constraint> 3

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Rabata
- access_key_id: ACCESS_KEY_ID
- secret_access_key: SECRET_ACCESS_KEY
- region: eu-west-2
- endpoint: s3.eu-west-2.rabata.io
- location_constraint: eu-west-2
Keep this "rabata" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Current remotes:

Name                 Type
====                 ====
rabata               s3

RackCorp

RackCorp Object Storage is an S3 compatible object storage platform from your friendly cloud provider RackCorp. The service is fast, reliable, well priced and located in many strategic locations unserviced by others, to ensure you can maintain data sovereignty.

Before you can use RackCorp Object Storage, you'll need to sign up for an account on our portal. Next you can create an access key, a secret key and buckets, in your location of choice with ease. These details are required for the next steps of configuration, when rclone config asks for your access_key_id and secret_access_key.

Your config should end up looking a bit like this:

[RCS3-demo-config]
type = s3
provider = RackCorp
env_auth = true
access_key_id = YOURACCESSKEY
secret_access_key = YOURSECRETACCESSKEY
region = au-nsw
endpoint = s3.rackcorp.com
location_constraint = au-nsw

Rclone Serve S3

Rclone can serve any remote over the S3 protocol. For details see the rclone serve s3 documentation.

For example, to serve remote:path over s3, run the server like this:

rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path

This will be compatible with an rclone remote which is defined like this:

[serves3]
type = s3
provider = Rclone
endpoint = http://127.0.0.1:8080/
access_key_id = ACCESS_KEY_ID
secret_access_key = SECRET_ACCESS_KEY
use_multipart_uploads = false

Note that setting use_multipart_uploads = false is to work around a bug which will be fixed in due course.

Scaleway

Scaleway The Object Storage platform allows you to store anything from backups, logs and web assets to documents and photos. Files can be dropped from the Scaleway console or transferred through our API and CLI or using any S3-compatible tool.

Scaleway provides an S3 interface which can be configured for use with rclone like this:

[scaleway]
type = s3
provider = Scaleway
env_auth = false
endpoint = s3.nl-ams.scw.cloud
access_key_id = SCWXXXXXXXXXXXXXX
secret_access_key = 1111111-2222-3333-44444-55555555555555
region = nl-ams
location_constraint = nl-ams
acl = private
upload_cutoff = 5M
chunk_size = 5M
copy_cutoff = 5M

Scaleway Glacier is the low-cost S3 Glacier alternative from Scaleway and it works the same way as on S3 by accepting the "GLACIER" storage_class. So you can configure your remote with the storage_class = GLACIER option to upload directly to Scaleway Glacier. Don't forget that in this state you can't read files back after, you will need to restore them to "STANDARD" storage_class first before being able to read them (see "restore" section above)

Seagate Lyve Cloud

Seagate Lyve Cloud is an S3 compatible object storage platform from Seagate intended for enterprise use.

Here is a config run through for a remote called remote - you may choose a different name of course. Note that to create an access key and secret key you will need to create a service account first.

$ rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> remote

Choose s3 backend

Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
[snip]
Storage> s3

Choose LyveCloud as S3 provider

Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Seagate Lyve Cloud
   \ (LyveCloud)
[snip]
provider> LyveCloud

Take the default (just press enter) to enter access key and secret in the config file.

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 boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> XXX

AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> YYY

Leave region blank

Region to connect to.
Leave blank if you are using an S3 clone and you don't have a region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Use this if unsure.
 1 | Will use v4 signatures and an empty region.
   \ ()
   / Use this only if v4 signatures don't work.
 2 | E.g. pre Jewel/v10 CEPH.
   \ (other-v2-signature)
region>

Enter your Lyve Cloud endpoint. This field cannot be kept empty.

Endpoint for Lyve Cloud S3 API.
Required when using an S3 clone.
Please type in your LyveCloud endpoint.
Examples:
- s3.us-west-1.{account_name}.lyve.seagate.com (US West 1 - California)
- s3.eu-west-1.{account_name}.lyve.seagate.com (US West 1 - Ireland)
Enter a value.
endpoint> s3.us-west-1.global.lyve.seagate.com

Leave location constraint blank

Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint>

Choose default ACL (private).

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.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
[snip]
acl>

And the config file should end up looking like this:

[remote]
type = s3
provider = LyveCloud
access_key_id = XXX
secret_access_key = YYY
endpoint = s3.us-east-1.lyvecloud.seagate.com

SeaweedFS

SeaweedFS is a distributed storage system for blobs, objects, files, and data lake, with O(1) disk seek and a scalable file metadata store. It has an S3 compatible object storage interface. SeaweedFS can also act as a gateway to remote S3 compatible object store to cache data and metadata with asynchronous write back, for fast local speed and minimize access cost.

Assuming the SeaweedFS are configured with weed shell as such:

> s3.bucket.create -name foo
> s3.configure -access_key=any -secret_key=any -buckets=foo -user=me -actions=Read,Write,List,Tagging,Admin -apply
{
  "identities": [
    {
      "name": "me",
      "credentials": [
        {
          "accessKey": "any",
          "secretKey": "any"
        }
      ],
      "actions": [
        "Read:foo",
        "Write:foo",
        "List:foo",
        "Tagging:foo",
        "Admin:foo"
      ]
    }
  ]
}

To use rclone with SeaweedFS, above configuration should end up with something like this in your config:

[seaweedfs_s3]
type = s3
provider = SeaweedFS
access_key_id = any
secret_access_key = any
endpoint = localhost:8333

So once set up, for example to copy files into a bucket

rclone copy /path/to/files seaweedfs_s3:foo

Selectel

Selectel Cloud Storage is an S3 compatible storage system which features triple redundancy storage, automatic scaling, high availability and a comprehensive IAM system.

Selectel have a section on their website for configuring rclone which shows how to make the right API keys.

From rclone v1.69 Selectel is a supported operator - please choose the Selectel provider type.

Note that you should use "vHosted" access for the buckets (which is the recommended default), not "path style".

You can use rclone config to make a new provider like this

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> selectel

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including ..., Selectel, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Selectel Object Storage
   \ (Selectel)
[snip]
provider> Selectel

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option region.
Region where your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / St. Petersburg
   \ (ru-1)
region> 1

Option endpoint.
Endpoint for Selectel Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Saint Petersburg
   \ (s3.ru-1.storage.selcloud.ru)
endpoint> 1

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Selectel
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- region: ru-1
- endpoint: s3.ru-1.storage.selcloud.ru
Keep this "selectel" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

And your config should end up looking like this:

[selectel]
type = s3
provider = Selectel
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
region = ru-1
endpoint = s3.ru-1.storage.selcloud.ru

Servercore

Servercore Object Storage is an S3 compatible object storage system that provides scalable and secure storage solutions for businesses of all sizes.

rclone config example:

No remotes found, make a new one\?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> servercore

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including ..., Servercore, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / Servercore Object Storage
   \ (Servercore)
[snip]
provider> Servercore

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option region.
Region where your is data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / St. Petersburg
   \ (ru-1)
 2 / Moscow
   \ (gis-1)
 3 / Moscow
   \ (ru-7)
 4 / Tashkent, Uzbekistan
   \ (uz-2)
 5 / Almaty, Kazakhstan
   \ (kz-1)
region> 1

Option endpoint.
Endpoint for Servercore Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Saint Petersburg
   \ (s3.ru-1.storage.selcloud.ru)
 2 / Moscow
   \ (s3.gis-1.storage.selcloud.ru)
 3 / Moscow
   \ (s3.ru-7.storage.selcloud.ru)
 4 / Tashkent, Uzbekistan
   \ (s3.uz-2.srvstorage.uz)
 5 / Almaty, Kazakhstan
   \ (s3.kz-1.srvstorage.kz)
endpoint> 1

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: Servercore
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- region: ru-1
- endpoint: s3.ru-1.storage.selcloud.ru
Keep this "servercore" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

Spectra Logic

Spectra Logic is an on-prem S3-compatible object storage gateway that exposes local object storage and policy-tiers data to Spectra tape and public clouds under a single namespace for backup and archiving.

The S3 compatible gateway is configured using rclone config with a type of s3 and with a provider name of SpectraLogic. Here is an example run of the configurator.

No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> spectralogic

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
[snip]
XX / Amazon S3 Compliant Storage Providers including ..., SpectraLogic, ...
   \ (s3)
[snip]
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
[snip]
XX / SpectraLogic BlackPearl
   \ (SpectraLogic)
[snip]
provider> SpectraLogic

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> SECRET_ACCESS_KEY

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> https://bp.example.com

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Configuration complete.
Options:
- type: s3
- provider: SpectraLogic
- access_key_id: ACCESS_KEY
- secret_access_key: SECRET_ACCESS_KEY
- endpoint: https://bp.example.com
Keep this "spectratest" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

And your config should end up looking like this:

[spectratest]
type = s3
provider = SpectraLogic
access_key_id = ACCESS_KEY
secret_access_key = SECRET_ACCESS_KEY
endpoint = https://bp.example.com

Storj

Storj is a decentralized cloud storage which can be used through its native protocol or an S3 compatible gateway.

The S3 compatible gateway is configured using rclone config with a type of s3 and with a provider name of Storj. Here is an example run of the configurator.

Type of storage to configure.
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 boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 1
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> XXXX (as shown when creating the access grant)
Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> XXXX (as shown when creating the access grant)
Option endpoint.
Endpoint of the Shared Gateway.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / EU1 Shared Gateway
   \ (gateway.eu1.storjshare.io)
 2 / US1 Shared Gateway
   \ (gateway.us1.storjshare.io)
 3 / Asia-Pacific Shared Gateway
   \ (gateway.ap1.storjshare.io)
endpoint> 1 (as shown when creating the access grant)
Edit advanced config?
y) Yes
n) No (default)
y/n> n

Note that s3 credentials are generated when you create an access grant.

Backend quirks

--chunk-size is forced to be 64 MiB or greater. This will use more memory than the default of 5 MiB.
Server side copy is disabled as it isn't currently supported in the gateway.
GetTier and SetTier are not supported.

Backend bugs

Due to issue #39 uploading multipart files via the S3 gateway causes them to lose their metadata. For rclone's purpose this means that the modification time is not stored, nor is any MD5SUM (if one is available from the source).

This has the following consequences:

Using rclone rcat will fail as the metadata doesn't match after upload
Uploading files with rclone mount will fail for the same reason
- This can worked around by using --vfs-cache-mode writes or --vfs-cache-mode full or setting --s3-upload-cutoff large
Files uploaded via a multipart upload won't have their modtimes
- This will mean that rclone sync will likely keep trying to upload files bigger than --s3-upload-cutoff
- This can be worked around with --checksum or --size-only or setting --s3-upload-cutoff large
- The maximum value for --s3-upload-cutoff is 5GiB though

One general purpose workaround is to set --s3-upload-cutoff 5G. This means that rclone will upload files smaller than 5GiB as single parts. Note that this can be set in the config file with upload_cutoff = 5G or configured in the advanced settings. If you regularly transfer files larger than 5G then using --checksum or --size-only in rclone sync is the recommended workaround.

Comparison with the native protocol

Use the the native protocol to take advantage of client-side encryption as well as to achieve the best possible download performance. Uploads will be erasure-coded locally, thus a 1gb upload will result in 2.68gb of data being uploaded to storage nodes across the network.

Use this backend and the S3 compatible Hosted Gateway to increase upload performance and reduce the load on your systems and network. Uploads will be encrypted and erasure-coded server-side, thus a 1GB upload will result in only in 1GB of data being uploaded to storage nodes across the network.

For more detailed comparison please check the documentation of the storj backend.

Synology C2 Object Storage

Synology C2 Object Storage provides a secure, S3-compatible, and cost-effective cloud storage solution without API request, download fees, and deletion penalty.

The S3 compatible gateway is configured using rclone config with a type of s3 and with a provider name of Synology. Here is an example run of the configurator.

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

Enter name for new remote.1
name> syno

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 / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "s3"

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
 24 / Synology C2 Object Storage
   \ (Synology)

provider> Synology

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

Region where your data stored.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Europe Region 1
   \ (eu-001)
 2 / Europe Region 2
   \ (eu-002)
 3 / US Region 1
   \ (us-001)
 4 / US Region 2
   \ (us-002)
 5 / Asia (Taiwan)
   \ (tw-001)

region > 1

Option endpoint.
Endpoint for Synology C2 Object Storage API.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / EU Endpoint 1
   \ (eu-001.s3.synologyc2.net)
 2 / US Endpoint 1
   \ (us-001.s3.synologyc2.net)
 3 / TW Endpoint 1
   \ (tw-001.s3.synologyc2.net)

endpoint> 1

Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint>

Edit advanced config? (y/n)
y) Yes
n) No
y/n> y

Option no_check_bucket.
If set, don't attempt to check the bucket exists or create it.
This can be useful when trying to minimise the number of transactions
rclone does if you know the bucket exists already.
It can also be needed if the user you are using does not have bucket
creation permissions. Before v1.52.0 this would have passed silently
due to a bug.
Enter a boolean value (true or false). Press Enter for the default (true).

no_check_bucket> true

Configuration complete.
Options:
- type: s3
- provider: Synology
- region: eu-001
- endpoint: eu-001.s3.synologyc2.net
- no_check_bucket: true
Keep this "syno" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote

y/e/d> y

Tencent COS

Tencent Cloud Object Storage (COS) is a distributed storage service offered by Tencent Cloud for unstructured data. It is secure, stable, massive, convenient, low-delay and low-cost.

To configure access to Tencent COS, follow the steps below:

Run rclone config and select n for a new remote.

rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Give the name of the configuration. For example, name it 'cos'.
```
name> cos
```

Select s3 storage.

Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "s3"
[snip]
Storage> s3

Select TencentCOS provider.

Choose a number from below, or type in your own value
1 / Amazon Web Services (AWS) S3
   \ "AWS"
[snip]
11 / Tencent Cloud Object Storage (COS)
   \ "TencentCOS"
[snip]
provider> TencentCOS

Enter your SecretId and SecretKey of Tencent Cloud.

Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).
Only applies if access_key_id and secret_access_key is blank.
Enter a boolean value (true or false). Press Enter for the default ("false").
Choose a number from below, or type in your own value
 1 / Enter AWS credentials in the next step
   \ "false"
 2 / Get AWS credentials from the environment (env vars or IAM)
   \ "true"
env_auth> 1
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
access_key_id> AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
secret_access_key> xxxxxxxxxxx

Select endpoint for Tencent COS. This is the standard endpoint for different region.

 1 / Beijing Region.
   \ "cos.ap-beijing.myqcloud.com"
 2 / Nanjing Region.
   \ "cos.ap-nanjing.myqcloud.com"
 3 / Shanghai Region.
   \ "cos.ap-shanghai.myqcloud.com"
 4 / Guangzhou Region.
   \ "cos.ap-guangzhou.myqcloud.com"
[snip]
endpoint> 4

Choose acl and storage class.

Note that this ACL is applied when server-side copying objects as S3
doesn't copy the ACL from the source but rather writes a fresh one.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Owner gets Full_CONTROL. No one else has access rights (default).
   \ "default"
[snip]
acl> 1
The storage class to use when storing new objects in Tencent COS.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Default
   \ ""
[snip]
storage_class> 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n
Remote config
--------------------
[cos]
type = s3
provider = TencentCOS
env_auth = false
access_key_id = xxx
secret_access_key = xxx
endpoint = cos.ap-guangzhou.myqcloud.com
acl = default
--------------------
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
Current remotes:

Name                 Type
====                 ====
cos                  s3

Tencent COS Global Acceleration Endpoint

When using the Global Acceleration Endpoint (cos.accelerate.myqcloud.com), rclone automatically sets no_check_bucket = true because this acceleration endpoint does not support the CreateBucket call which is used for ensuring a bucket's existence by rclone. Global Acceleration is a per-bucket feature, so you should first create the bucket in one physical region, then enable it in the Tencent Cloud console.

US3

US3 Object Storage is a service that provides cloud storage for unstructured files for internet applications.

To configure access to US3, follow the steps below:

First run:

rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Give the name of the configuration. For example, name it 'US3'.
```
name> US3
```

Select s3 storage.

Choose a number from below, or type in your own value
[snip]
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ "s3"
[snip]
Storage> s3

Select US3 provider.

 Choose a number from below, or type in your own value.
 XX / Amazon Web Services (AWS) S3
    \ (AWS)
 [snip]
 XX / UCloud Object Storage (US3)
    \ (US3)
 [snip]
 provider> US3

Enter your SecretId and SecretKey of US3.

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 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
Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> AKIDxxxxxxxxxx
AWS Secret Access Key (password)
Leave blank for anonymous access or runtime credentials.
Enter a string value. Press Enter for the default ("").
secret_access_key> xxxxxxxxxxx

Select endpoint.

 Option endpoint.
 Endpoint for S3 API.
 Required when using an S3 clone.
 Choose a number from below, or type in your own value.
 Press Enter to leave empty.
 1 / North China (Beijing 2).
   \ "s3-cn-bj.ufileos.com"
 2 / North China (Ulanqab).
   \ "s3-cn-wlcb.ufileos.com"
 3 / Shanghai.
   \ "s3-cn-sh2.ufileos.com"
 4 / South China (Guangzhou).
   \ "s3-cn-gd.ufileos.com"
[snip]
endpoint> 1

Choose acl and storage class.

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
  / Owner gets FULL_CONTROL.
1 | No one else has access rights (default).
  \ (private)
  / Owner gets FULL_CONTROL.
2 | The AllUsers group gets READ access.
  \ (public-read)
acl> 1

The storage class to use when storing new objects in US3.
Enter a string value. Press Enter for the default ("").
Choose a number from below, or type in your own value
 1 / Default
   \ ""
[snip]
storage_class> 1
Edit advanced config? (y/n)
y) Yes
n) No (default)
y/n> n

 Configuration complete. 
 Options:
 - type: s3
 - provider: US3
 - access_key_id: xx
 - secret_access_key: xx
 - endpoint: s3-cn-bj.ufileos.com
 - acl: private

 Keep this "US3" remote?
 y) Yes this is OK (default)
 e) Edit this remote
 d) Delete this remote
 y/e/d> y
 Current remotes:

 Name                 Type
 ====                 ====
 US3                  s3

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, ChinaMobile, ArvanCloud, Minio, Liara)
   \ "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 =

Zadara Object Storage

Zadara Object Storage is a fully-managed, enterprise-grade, S3-compatible storage solution that provides scalable, multi-tenant object storage with flexible deployment options (on-prem, hybrid, or cloud).

Zadara Object Storage can be configured using rclone config with s3 as the type and Zadara as the provider name. Here is an example run of the configurator.

Authentication and endpoint information, including the region field, should be fetched from Zadara’s Object Storage management interface

To configure access to Zadara Object Storage, first run:

rclone config

This will guide you through an interactive setup process:

No remotes found, make a new one\?
n) New remote
s) Set configuration password
n/s> n

Enter name for new remote.
name> Zadara-Object-Storage

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 
 XX / Amazon S3 Compliant Storage Providers including AWS ...
   \ (s3)

Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 
XX / Zadara Object Storage
   \ (Zadara)

provider> Zadara

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth> 

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> S3_ACCESS_KEY

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> S3_SECRET_KEY

Option region.
Region to connect to.
Leave blank if you are using an S3 clone and you don't have a region.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / The default region.
 1 | Leave location constraint empty.
   \ (us-east-1)
region> 

Option endpoint.
Endpoint for S3 API.
Required when using an S3 clone.
Enter a value. Press Enter to leave empty.
endpoint> https://vsa-00000001-public-zadara-cloud-01.zadarazios.com

Edit advanced config?
y) Yes
n) No (default)
y/n> 

Configuration complete.
Options:
- type: s3
- provider: Zadara
- access_key_id: S3_ACCESS_KEY
- secret_access_key: S3_SECRET_KEY
- endpoint: https://vsa-00000001-public-zadara-cloud-01.zadarazios.com
Keep this "Zadara-Object-Storage" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y

This will leave the config file looking like this.

[Zadara-Object-Storage]
type = s3
provider = Zadara
access_key_id = S3_ACCESS_KEY
secret_access_key = S3_SECRET_KEY
endpoint = https://vsa-00000001-public-zadara-cloud-01.zadarazios.com

Zata Object Storage

Zata Object Storage provides a secure, S3-compatible cloud storage solution designed for scalability and performance, ideal for a variety of data storage needs.

First run:

rclone config

This will guide you through an interactive setup process:

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

Enter name for new remote.
name> my zata storage 

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
 
XX / Amazon S3 Compliant Storage Providers including AWS, ...
   \ (s3)
 
Storage> s3

Option provider.
Choose your S3 provider.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 
XX / Zata (S3 compatible Gateway)
   \ (Zata)

provider> Zata

Option 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.
Choose a number from below, or type in your own boolean value (true or false).
Press Enter for the default (false).
 1 / Enter AWS credentials in the next step.
   \ (false)
 2 / Get AWS credentials from the environment (env vars or IAM).
   \ (true)
env_auth>

Option access_key_id.
AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
access_key_id> "your key"

Option secret_access_key.
AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Enter a value. Press Enter to leave empty.
secret_access_key> "your secret key"

Option region.
Region where you can connect with.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Indore, Madhya Pradesh, India
   \ (us-east-1)
region> 1

Option endpoint.
Endpoint for Zata Object Storage.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / South Asia Endpoint
   \ (idr01.zata.ai)
endpoint> 1

Option location_constraint.
Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Enter a value. Press Enter to leave empty.
location_constraint>

Option 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.
If the acl is an empty string then no X-Amz-Acl: header is added and
the default (private) will be used.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
   / Owner gets FULL_CONTROL.
 1 | No one else has access rights (default).
   \ (private)
   / Owner gets FULL_CONTROL.
 2 | The AllUsers group gets READ access.
   \ (public-read)
   / Owner gets FULL_CONTROL.
 3 | The AllUsers group gets READ and WRITE access.
   | Granting this on a bucket is generally not recommended.
   \ (public-read-write)
   / Owner gets FULL_CONTROL.
 4 | The AuthenticatedUsers group gets READ access.
   \ (authenticated-read)
   / Object owner gets FULL_CONTROL.
 5 | Bucket owner gets READ access.
   | 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>

Edit advanced config?
y) Yes
n) No (default)
y/n>

Configuration complete.
Options:
- type: s3
- provider: Zata
- access_key_id: xxx
- secret_access_key: xxx
- region: us-east-1
- endpoint: idr01.zata.ai
Keep this "my zata storage" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d>

This will leave the config file looking like this.

[my zata storage]
type = s3
provider = Zata
access_key_id = xxx
secret_access_key = xxx
region = us-east-1
endpoint = idr01.zata.ai

Memory usage

The most common cause of rclone using lots of memory is a single directory with millions of files in. Despite s3 not really having the concepts of directories, rclone does the sync on a directory by directory basis to be compatible with normal filing systems.

Rclone loads each directory into memory as rclone objects. Each rclone object takes 0.5k-1k of memory, so approximately 1GB per 1,000,000 files, and the sync for that directory does not begin until it is entirely loaded in memory. So the sync can take a long time to start for large directories.

To sync a directory with 100,000,000 files in you would need approximately 100 GB of memory. At some point the amount of memory becomes difficult to provide so there is a workaround for this which involves a bit of scripting.

At some point rclone will gain a sync mode which is effectively this workaround but built in to rclone.

Limitations

rclone about is not supported by the S3 backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

See List of backends that do not support rclone about and rclone about.

Archive	Extension
Zip	`.zip`
Squashfs	`.sqfs`

Format	Extensions	Cloud Optimized	Explanation
ZIP	`.zip`	Excellent	Zip files have an index (the "central directory") stored at the end of the file. A program can seek to the end, read the index to find a file's location and size, and then seek directly to that file's data to extract it.
SquashFS	`.squashfs`, `.sqfs`, `.sfs`	Excellent	This is a compressed read-only filesystem image, not just an archive. It is specifically designed for random access. It uses metadata and index tables to allow the system to find and decompress individual files or data blocks on demand.
ISO Image	`.iso`	Excellent	Like SquashFS, this is a filesystem image (for optical media). It contains a filesystem (like ISO 9660 or UDF) with a table of contents at a known location, allowing for direct access to any file without reading the whole disk.
RAR	`.rar`	Good	RAR supports "non-solid" and "solid" modes. In the common non-solid mode, files are compressed separately, and an index allows for easy single-file extraction (like ZIP). In "solid" mode, this rating would be "Very Poor."
7z	`.7z`	Poor	By default, 7z uses "solid" archives to maximize compression. This compresses files as one continuous stream. To extract a file from the middle, all preceding files must be decompressed first. (If explicitly created as "non-solid," its rating would be "Excellent").
tar	`.tar`	Poor	"Tape Archive" is a streaming format with no central index. To find a file, you must read the archive from the beginning, checking each file header one by one until you find the one you want. This is slow but doesn't require decompressing data.
Gzipped Tar	`.tar.gz`, `.tgz`	Very Poor	This is a `tar` file (already "Poor") compressed with `gzip` as a single, non-seekable stream. You cannot seek. To get any file, you must decompress the entire archive from the beginning up to that file.
Bzipped/XZ Tar	`.tar.bz2`, `.tar.xz`	Very Poor	This is the same principle as `tar.gz`. The entire archive is one large compressed block, making random access impossible.

Authors

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Authors and contributors

Authors

Nick Craig-Wood nick@craig-wood.com

Contributors

Alex Couper amcouper@gmail.com
Leonid Shalupov leonid@shalupov.com shalupov@diverse.org.ru
Shimon Doodkin helpmepro1@gmail.com
Colin Nicholson colin@colinn.com
Klaus Post klauspost@gmail.com
Sergey Tolmachev tolsi.ru@gmail.com
Adriano Aurélio Meirelles adriano@atinge.com
C. Bess cbess@users.noreply.github.com
Dmitry Burdeev dibu28@gmail.com
Joseph Spurrier github@josephspurrier.com
Björn Harrtell bjorn@wololo.org
Xavier Lucas xavier.lucas@corp.ovh.com
Werner Beroux werner@beroux.com
Brian Stengaard brian@stengaard.eu
Jakub Gedeon jgedeon@sofi.com
Jim Tittsler jwt@onjapan.net
Michal Witkowski michal@improbable.io
Fabian Ruff fabian.ruff@sap.com
Leigh Klotz klotz@quixey.com
Romain Lapray lapray.romain@gmail.com
Justin R. Wilson jrw972@gmail.com
Antonio Messina antonio.s.messina@gmail.com
Stefan G. Weichinger office@oops.co.at
Per Cederberg cederberg@gmail.com
Radek Šenfeld rush@logic.cz
Fredrik Fornwall fredrik@fornwall.net
Asko Tamm asko@deekit.net
xor-zz xor@gstocco.com
Tomasz Mazur tmazur90@gmail.com
Marco Paganini paganini@paganini.net
Felix Bünemann buenemann@louis.info
Durval Menezes jmrclone@durval.com
Luiz Carlos Rumbelsperger Viana maxd13_luiz_carlos@hotmail.com
Stefan Breunig stefan-github@yrden.de
Alishan Ladhani ali-l@users.noreply.github.com
0xJAKE 0xJAKE@users.noreply.github.com
Thibault Molleman thibaultmol@users.noreply.github.com
Scott McGillivray scott.mcgillivray@gmail.com
Bjørn Erik Pedersen bjorn.erik.pedersen@gmail.com
Lukas Loesche lukas@mesosphere.io
emyarod emyarod@users.noreply.github.com
T.C. Ferguson tcf909@gmail.com
Brandur brandur@mutelight.org
Dario Giovannetti dev@dariogiovannetti.net
Károly Oláh okaresz@aol.com
Jon Yergatian jon@macfanatic.ca
Jack Schmidt github@mowsey.org
Dedsec1 Dedsec1@users.noreply.github.com
Hisham Zarka hzarka@gmail.com
Jérôme Vizcaino jerome.vizcaino@gmail.com
Mike Tesch mjt6129@rit.edu
Marvin Watson marvwatson@users.noreply.github.com
Danny Tsai danny8376@gmail.com
Yoni Jah yonjah+git@gmail.com yonjah+github@gmail.com
Stephen Harris github@spuddy.org sweharris@users.noreply.github.com
Ihor Dvoretskyi ihor.dvoretskyi@gmail.com
Jon Craton jncraton@gmail.com
Hraban Luyat hraban@0brg.net
Michael Ledin mledin89@gmail.com
Martin Kristensen me@azgul.com
Too Much IO toomuchio@users.noreply.github.com
Anisse Astier anisse@astier.eu
Zahiar Ahmed zahiar@live.com
Igor Kharin igorkharin@gmail.com
Bill Zissimopoulos billziss@navimatics.com
Bob Potter bobby.potter@gmail.com
Steven Lu tacticalazn@gmail.com
Sjur Fredriksen sjurtf@ifi.uio.no
Ruwbin hubus12345@gmail.com
Fabian Möller fabianm88@gmail.com f.moeller@nynex.de
Edward Q. Bridges github@eqbridges.com
Vasiliy Tolstov v.tolstov@selfip.ru
Harshavardhana harsha@minio.io
sainaen sainaen@gmail.com
gdm85 gdm85@users.noreply.github.com
Yaroslav Halchenko debian@onerussian.com
John Papandriopoulos jpap@users.noreply.github.com
Zhiming Wang zmwangx@gmail.com
Andy Pilate cubox@cubox.me
Oliver Heyme olihey@googlemail.com olihey@users.noreply.github.com de8olihe@lego.com
wuyu wuyu@yunify.com
Andrei Dragomir adragomi@adobe.com
Christian Brüggemann mail@cbruegg.com
Alex McGrath Kraak amkdude@gmail.com
bpicode bjoern.pirnay@googlemail.com
Daniel Jagszent daniel@jagszent.de
Josiah White thegenius2009@gmail.com
Ishuah Kariuki kariuki@ishuah.com ishuah91@gmail.com
Jan Varho jan@varho.org
Girish Ramakrishnan girish@cloudron.io
LingMan LingMan@users.noreply.github.com
Jacob McNamee jacobmcnamee@gmail.com
jersou jertux@gmail.com
thierry thierry@substantiel.fr
Simon Leinen simon.leinen@gmail.com ubuntu@s3-test.novalocal
Dan Dascalescu ddascalescu+github@gmail.com
Jason Rose jason@jro.io
Andrew Starr-Bochicchio a.starr.b@gmail.com
John Leach john@johnleach.co.uk
Corban Raun craun@instructure.com
Pierre Carlson mpcarl@us.ibm.com
Ernest Borowski er.borowski@gmail.com
Remus Bunduc remus.bunduc@gmail.com
Iakov Davydov iakov.davydov@unil.ch dav05.gith@myths.ru
Jakub Tasiemski tasiemski@gmail.com
David Minor dminor@saymedia.com
Tim Cooijmans cooijmans.tim@gmail.com
Laurence liuxy6@gmail.com
Giovanni Pizzi gio.piz@gmail.com
Filip Bartodziej filipbartodziej@gmail.com
Jon Fautley jon@dead.li
lewapm 32110057+lewapm@users.noreply.github.com
Yassine Imounachen yassine256@gmail.com
Chris Redekop chris-redekop@users.noreply.github.com chris.redekop@gmail.com
Jon Fautley jon@adenoid.appstal.co.uk
Will Gunn WillGunn@users.noreply.github.com
Lucas Bremgartner lucas@bremis.ch
Jody Frankowski jody.frankowski@gmail.com
Andreas Roussos arouss1980@gmail.com
nbuchanan nbuchanan@utah.gov
Durval Menezes rclone@durval.com
Victor vb-github@viblo.se
Mateusz pabian.mateusz@gmail.com
Daniel Loader spicypixel@gmail.com
David0rk davidork@gmail.com
Alexander Neumann alexander@bumpern.de
Giri Badanahatti <gbadanahatti@us.ibm.com@Giris-MacBook-Pro.local>
Leo R. Lundgren leo@finalresort.org
wolfv wolfv6@users.noreply.github.com
Dave Pedu dave@davepedu.com
Stefan Lindblom lindblom@spotify.com
seuffert oliver@seuffert.biz
gbadanahatti 37121690+gbadanahatti@users.noreply.github.com
Keith Goldfarb barkofdelight@gmail.com
Steve Kriss steve@heptio.com
Chih-Hsuan Yen yan12125@gmail.com
Alexander Neumann fd0@users.noreply.github.com
Matt Holt mholt@users.noreply.github.com
Eri Bastos bastos.eri@gmail.com
Michael P. Dubner pywebmail@list.ru
Antoine GIRARD sapk@users.noreply.github.com
Mateusz Piotrowski mpp302@gmail.com
Animosity022 animosity22@users.noreply.github.com earl.texter@gmail.com
Peter Baumgartner pete@lincolnloop.com
Craig Rachel craig@craigrachel.com
Michael G. Noll miguno@users.noreply.github.com
hensur me@hensur.de
Oliver Heyme de8olihe@lego.com
Richard Yang richard@yenforyang.com
Piotr Oleszczyk piotr.oleszczyk@gmail.com
Rodrigo rodarima@gmail.com
NoLooseEnds NoLooseEnds@users.noreply.github.com
Jakub Karlicek jakub@karlicek.me
John Clayton john@codemonkeylabs.com
Kasper Byrdal Nielsen byrdal76@gmail.com
Benjamin Joseph Dag bjdag1234@users.noreply.github.com
themylogin themylogin@gmail.com
Onno Zweers onno.zweers@surfsara.nl
Jasper Lievisse Adriaanse jasper@humppa.nl
sandeepkru sandeep.ummadi@gmail.com sandeepkru@users.noreply.github.com
HerrH atomtigerzoo@users.noreply.github.com
Andrew 4030760+sparkyman215@users.noreply.github.com
dan smith XX1011@gmail.com
Oleg Kovalov iamolegkovalov@gmail.com
Ruben Vandamme github-com-00ff86@vandamme.email
Cnly minecnly@gmail.com
Andres Alvarez 1671935+kir4h@users.noreply.github.com
reddi1 xreddi@gmail.com
Matt Tucker matthewtckr@gmail.com
Sebastian Bünger buengese@gmail.com buengese@protonmail.com
Martin Polden mpolden@mpolden.no
Alex Chen Cnly@users.noreply.github.com
Denis deniskovpen@gmail.com
bsteiss 35940619+bsteiss@users.noreply.github.com
Cédric Connes cedric.connes@gmail.com
Dr. Tobias Quathamer toddy15@users.noreply.github.com
dcpu 42736967+dcpu@users.noreply.github.com
Sheldon Rupp me@shel.io
albertony 12441419+albertony@users.noreply.github.com
cron410 cron410@gmail.com
Anagh Kumar Baranwal 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
Antoine GIRARD sapk@sapk.fr
Joanna Marek joanna.marek@u2i.com
frenos frenos@users.noreply.github.com
ssaqua ssaqua@users.noreply.github.com
xnaas me@xnaas.info
Frantisek Fuka fuka@fuxoft.cz
Paul Kohout pauljkohout@yahoo.com
dcpu 43330287+dcpu@users.noreply.github.com
jackyzy823 jackyzy823@gmail.com
David Haguenauer ml@kurokatta.org
teresy hi.teresy@gmail.com
buergi patbuergi@gmx.de
Florian Gamboeck mail@floga.de
Ralf Hemberger 10364191+rhemberger@users.noreply.github.com
Scott Edlund sedlund@users.noreply.github.com
Erik Swanson erik@retailnext.net
Jake Coggiano jake@stripe.com
brused27 brused27@noemailaddress
Peter Kaminski kaminski@istori.com
Henry Ptasinski henry@logout.com
Alexander kharkovalexander@gmail.com
Garry McNulty garrmcnu@gmail.com
Mathieu Carbou mathieu.carbou@gmail.com
Mark Otway mark@otway.com
William Cocker 37018962+WilliamCocker@users.noreply.github.com
François Leurent 131.js@cloudyks.org
Arkadius Stefanski arkste@gmail.com
Jay dev@jaygoel.com
andrea rota a@xelera.eu
nicolov nicolov@users.noreply.github.com
Matt Joiner anacrolix@gmail.com
Dario Guzik dario@guzik.com.ar
qip qip@users.noreply.github.com
yair@unicorn yair@unicorn
Matt Robinson brimstone@the.narro.ws
kayrus kay.diam@gmail.com
Rémy Léone remy.leone@gmail.com
Wojciech Smigielski wojciech.hieronim.smigielski@gmail.com
weetmuts oehrstroem@gmail.com
Jonathan vanillajonathan@users.noreply.github.com
James Carpenter orbsmiv@users.noreply.github.com
Vince vince0villamora@gmail.com
Nestar47 47841759+Nestar47@users.noreply.github.com
Six brbsix@gmail.com
Alexandru Bumbacea alexandru.bumbacea@booking.com
calisro robert.calistri@gmail.com
Dr.Rx david.rey@nventive.com
marcintustin marcintustin@users.noreply.github.com
jaKa Močnik jaka@koofr.net
Fionera fionera@fionera.de
Dan Walters dan@walters.io
Danil Semelenov sgtpep@users.noreply.github.com
xopez 28950736+xopez@users.noreply.github.com
Ben Boeckel mathstuf@gmail.com
Manu manu@snapdragon.cc
Kyle E. Mitchell kyle@kemitchell.com
Gary Kim gary@garykim.dev
Jon jonathn@github.com
Jeff Quinn jeffrey.quinn@bluevoyant.com
Peter Berbec peter@berbec.com
didil 1284255+didil@users.noreply.github.com
id01 gaviniboom@gmail.com
Robert Marko robimarko@gmail.com
Philip Harvey 32467456+pharveybattelle@users.noreply.github.com
JorisE JorisE@users.noreply.github.com
garry415 garry.415@gmail.com
forgems forgems@gmail.com
Florian Apolloner florian@apolloner.eu
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
yparitcher y@paritcher.com
AbelThar abela.tharen@gmail.com
Matti Niemenmaa matti.niemenmaa+git@iki.fi
Russell Davis russelldavis@users.noreply.github.com
Yi FU yi.fu@tink.se
Paul Millar paul.millar@desy.de
justinalin justinalin@qnap.com
EliEron subanimehd@gmail.com
justina777 chiahuei.lin@gmail.com
Chaitanya Bankanhal bchaitanya15@gmail.com
Michał Matczuk michal@scylladb.com
Macavirus macavirus@zoho.com
Abhinav Sharma abhi18av@outlook.com
ginvine 34869051+ginvine@users.noreply.github.com
Patrick Wang mail6543210@yahoo.com.tw
Cenk Alti cenkalti@gmail.com
Andreas Chlupka andy@chlupka.com
Alfonso Montero amontero@tinet.org
Ivan Andreev ivandeex@gmail.com
David Baumgold david@davidbaumgold.com
Lars Lehtonen lars.lehtonen@gmail.com
Matei David matei.david@gmail.com
David david.bramwell@endemolshine.com
Anthony Rusdi 33247310+antrusd@users.noreply.github.com
Richard Patel me@terorie.dev
庄天翼 zty0826@gmail.com
SwitchJS dev@switchjs.com
Raphael PowershellNinja@users.noreply.github.com
Sezal Agrawal sezalagrawal@gmail.com
Tyler TylerNakamura@users.noreply.github.com
Brett Dutro brett.dutro@gmail.com
Vighnesh SK booterror99@gmail.com
Arijit Biswas dibbyo456@gmail.com
Michele Caci michele.caci@gmail.com
AlexandrBoltris ua2fgb@gmail.com
Bryce Larson blarson@saltstack.com
Carlos Ferreyra crypticmind@gmail.com
Saksham Khanna sakshamkhanna@outlook.com
dausruddin 5763466+dausruddin@users.noreply.github.com
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 7876747+ankur0493@users.noreply.github.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
Dave Koston dave.koston@stackpath.com
Durval Menezes DurvalMenezes@users.noreply.github.com
Tim Gallant me@timgallant.us
Frederick Zhang frederick888@tsundere.moe
valery1707 valery1707@gmail.com
Yves G theYinYeti@yalis.fr
Shing Kit Chan chanshingkit@gmail.com
Franklyn Tackitt franklyn@tackitt.net
Robert-André Mauchin zebob.m@gmail.com
evileye 48332831+ibiruai@users.noreply.github.com
Joachim Brandon LeBlanc brandon@leblanc.codes
Patryk Jakuszew patryk.jakuszew@gmail.com
fishbullet shindu666@gmail.com
greatroar <@>
Bernd Schoolmann mail@quexten.com
Elan Ruusamäe glen@pld-linux.org
Max Sum max@lolyculture.com
Mark Spieth mspieth@users.noreply.github.com
harry me@harry.plus
Samantha McVey samantham@posteo.net
Jack Anderson jack.anderson@metaswitch.com
Michael G draget@speciesm.net
Brandon Philips brandon@ifup.org
Daven dooven@users.noreply.github.com
Martin Stone martin@d7415.co.uk
David Bramwell 13053834+dbramwell@users.noreply.github.com
Sunil Patra snl_su@live.com
Adam Stroud adam.stroud@gmail.com
Kush kushsharma@users.noreply.github.com
Matan Rosenberg matan129@gmail.com
gitch1 63495046+gitch1@users.noreply.github.com
ElonH elonhhuang@gmail.com
Fred fred@creativeprojects.tech
Sébastien Gross renard@users.noreply.github.com
Maxime Suret 11944422+msuret@users.noreply.github.com
Caleb Case caleb@storj.io calebcase@gmail.com
Ben Zenker imbenzenker@gmail.com
Martin Michlmayr tbm@cyrius.com
Brandon McNama bmcnama@pagerduty.com
Daniel Slyman github@skylayer.eu
Alex Guerrero guerrero@users.noreply.github.com
Matteo Pietro Dazzi matteopietro.dazzi@gft.com
edwardxml 56691903+edwardxml@users.noreply.github.com
Roman Kredentser shareed2k@gmail.com
Kamil Trzciński ayufan@ayufan.eu
Zac Rubin z-0@users.noreply.github.com
Vincent Feltz
Heiko Bornholdt bornholdt@informatik.uni-hamburg.de
Matteo Pietro Dazzi matteopietro.dazzi@gmail.com
jtagcat gitlab@c7.ee
Petri Salminen petri@salminen.dev
Tim Burke tim.burke@gmail.com
Kai Lüke kai@kinvolk.io
Garrett Squire github@garrettsquire.com
Evan Harris eharris@puremagic.com
Kevin keyam@microsoft.com
Morten Linderud morten@linderud.pw
Dmitry Ustalov dmitry.ustalov@gmail.com
Jack 196648+jdeng@users.noreply.github.com
kcris cristian.tarsoaga@gmail.com
tyhuber1 68970760+tyhuber1@users.noreply.github.com
David Ibarra david.ibarra@realty.com
Tim Gallant tim@lilt.com
Kaloyan Raev kaloyan@storj.io
Jay McEntire jay.mcentire@gmail.com
Leo Luan leoluan@us.ibm.com
aus 549081+aus@users.noreply.github.com
Aaron Gokaslan agokaslan@fb.com
Egor Margineanu egmar@users.noreply.github.com
Lucas Kanashiro lucas.kanashiro@canonical.com
WarpedPixel WarpedPixel@users.noreply.github.com
Sam Edwards sam@samedwards.ca
wjielai gouki0123@gmail.com
Muffin King jinxz_k@live.com
Christopher Stewart 6573710+1f47a@users.noreply.github.com
Russell Cattelan cattelan@digitalelves.com
gyutw 30371241+gyutw@users.noreply.github.com
Hekmon edouardhur@gmail.com
LaSombra lasombra@users.noreply.github.com
Dov Murik dov.murik@gmail.com
Ameer Dawood ameer1234567890@gmail.com
Dan Hipschman dan.hipschman@opendoor.com
Josh Soref jsoref@users.noreply.github.com 2119212+jsoref@users.noreply.github.com
David david@staron.nl
Ingo ingo@hoffmann.cx
Adam Plánský adamplansky@users.noreply.github.com adamplansky@gmail.com
Manish Gupta manishgupta.ait@gmail.com
Deepak Sah sah.sslpu@gmail.com
Marcin Zelent marcin@zelent.net
zhucan zhucan.k8s@gmail.com
James Lim james.lim@samsara.com
Laurens Janssen BD69BM@insim.biz
Bob Bagwill bobbagwill@gmail.com
Nathan Collins colli372@msu.edu
lostheli
kelv kelvin@acks.org
Milly milly.ca@gmail.com
gtorelly gtorelly@gmail.com
Brad Ackerman brad@facefault.org
Mitsuo Heijo mitsuo.heijo@gmail.com
Claudio Bantaloukas rockdreamer@gmail.com
Benjamin Gustin gustin.ben@gmail.com
Ingo Weiss ingo@redhat.com
Kerry Su me@sshockwave.net
Ilyess Bachiri ilyess.bachiri@sonder.com
Yury Stankevich urykhy@gmail.com
kice wslikerqs@gmail.com
Denis Neuling denisneuling@gmail.com
Janne Johansson icepic.dz@gmail.com
Patrik Nordlén patriki@gmail.com
CokeMine aptx4561@gmail.com
Sơn Trần-Nguyễn github@sntran.com
lluuaapp 266615+lluuaapp@users.noreply.github.com
Zach Kipp kipp.zach@gmail.com
Riccardo Iaconelli riccardo@kde.org
Sakuragawa Misty gyc990326@gmail.com
Nicolas Rueff nicolas@rueff.fr
Pau Rodriguez-Estivill prodrigestivill@gmail.com
Bob Pusateri BobPusateri@users.noreply.github.com
Alex JOST 25005220+dimejo@users.noreply.github.com
Alexey Tabakman samosad.ru@gmail.com
David Sze sze.david@gmail.com
cynthia kwok cynthia.m.kwok@gmail.com
Miron Veryanskiy MironVeryanskiy@gmail.com
K265 k.265@qq.com
Vesnyx Vesnyx@users.noreply.github.com
Dmitry Chepurovskiy me@dm3ch.net
Rauno Ots rauno.ots@cgi.com
Georg Neugschwandtner georg.neugschwandtner@gmx.net
pvalls polvallsrue@gmail.com
Robert Thomas 31854736+wolveix@users.noreply.github.com
Romeo Kienzler romeo.kienzler@gmail.com
tYYGH tYYGH@users.noreply.github.com
georne 77802995+georne@users.noreply.github.com
Maxwell Calman mcalman@MacBook-Pro.local
Naveen Honest Raj naveendurai19@gmail.com
Lucas Messenger lmesseng@cisco.com
Manish Kumar krmanish260@gmail.com
x0b x0bdev@gmail.com
CERN through the CS3MESH4EOSC Project
Nick Gaya nicholasgaya+github@gmail.com
Ashok Gelal 401055+ashokgelal@users.noreply.github.com
Dominik Mydlil dominik.mydlil@outlook.com
Nazar Mishturak nazarmx@gmail.com
Ansh Mittal iamAnshMittal@gmail.com
noabody noabody@yahoo.com
OleFrost 82263101+olefrost@users.noreply.github.com
Kenny Parsons kennyparsons93@gmail.com
Jeffrey Tolar tolar.jeffrey@gmail.com
jtagcat git-514635f7@jtag.cat
Tatsuya Noyori 63089076+public-tatsuya-noyori@users.noreply.github.com
lewisxy lewisxy@users.noreply.github.com
Nolan Woods nolan_w@sfu.ca
Gautam Kumar 25435568+gautamajay52@users.noreply.github.com
Chris Macklin chris.macklin@10xgenomics.com
Antoon Prins antoon.prins@surfsara.nl
Alexey Ivanov rbtz@dropbox.com
Serge Pouliquen sp31415@free.fr
acsfer carlos@reendex.com
Tom tom@tom-fitzhenry.me.uk
Tyson Moore tyson@tyson.me
database64128 free122448@hotmail.com
Chris Lu chrislusf@users.noreply.github.com
Reid Buzby reid@rethink.software
darrenrhs darrenrhs@gmail.com
Florian Penzkofer fp@nullptr.de
Xuanchen Wu 117010292@link.cuhk.edu.cn
partev petrosyan@gmail.com
Dmitry Sitnikov fo2@inbox.ru
Haochen Tong i@hexchain.org
Michael Hanselmann public@hansmi.ch
Chuan Zh zhchuan7@gmail.com
Antoine GIRARD antoine.girard@sapk.fr
Justin Winokur (Jwink3101) Jwink3101@users.noreply.github.com
Mariano Absatz (git) scm@baby.com.ar
Greg Sadetsky lepetitg@gmail.com
yedamo logindaveye@gmail.com
hota lindwurm.q@gmail.com
vinibali vinibali1@gmail.com
Ken Enrique Morel ken.morel.santana@gmail.com
Justin Hellings justin.hellings@gmail.com
Parth Shukla pparth@pparth.net
wzl wangzl31@outlook.com
HNGamingUK connor@earnshawhome.co.uk
Jonta 359397+Jonta@users.noreply.github.com
YenForYang YenForYang@users.noreply.github.com
SimJoSt / Joda Stößer git@simjo.st
Logeshwaran waranlogesh@gmail.com
Rajat Goel rajat@dropbox.com
r0kk3rz r0kk3rz@gmail.com
Matthew Sevey mjsevey@gmail.com
Filip Rysavy fil@siasky.net
Ian Levesque ian@ianlevesque.org
Thomas Stachl thomas@stachl.me
Dmitry Bogatov git#v1@kaction.cc
thomae 4493560+thomae@users.noreply.github.com
trevyn trevyn-git@protonmail.com
David Liu david.yx.liu@oracle.com
Chris Nelson stuff@cjnaz.com
Felix Bünemann felix.buenemann@gmail.com
Atílio Antônio atiliodadalto@hotmail.com
Carlo Mion mion00@gmail.com
Chris Lu chris.lu@gmail.com
Vitor Arruda vitor.pimenta.arruda@gmail.com
bbabich bbabich@datamossa.com
David dp.davide.palma@gmail.com
Borna Butkovic borna@favicode.net
Fredric Arklid fredric.arklid@consid.se
Andy Jackson Andrew.Jackson@bl.uk
Sinan Tan i@tinytangent.com
deinferno 14363193+deinferno@users.noreply.github.com
rsapkf rsapkfff@pm.me
Will Holtz wholtz@gmail.com
GGG KILLER gggkiller2@gmail.com
Logeshwaran Murugesan logeshwaran@testpress.in
Lu Wang coolwanglu@gmail.com
Bumsu Hyeon ksitht@gmail.com
Shmz Ozggrn 98463324+ShmzOzggrn@users.noreply.github.com
Kim kim@jotta.no
Niels van de Weem n.van.de.weem@smile.nl
Koopa codingkoopa@gmail.com
Yunhai Luo yunhai-luo@hotmail.com
Charlie Jiang w@chariri.moe
Alain Nussbaumer alain.nussbaumer@alleluia.ch
Vanessasaurus 814322+vsoch@users.noreply.github.com
Isaac Levy isaac.r.levy@gmail.com
Gourav T workflowautomation@protonmail.com
Paulo Martins paulo.pontes.m@gmail.com
viveknathani viveknathani2402@gmail.com
Eng Zer Jun engzerjun@gmail.com
Abhiraj abhiraj.official15@gmail.com
Márton Elek elek@apache.org elek@users.noreply.github.com
Vincent Murphy vdm@vdm.ie
ctrl-q 34975747+ctrl-q@users.noreply.github.com
Nil Alexandrov nalexand@akamai.com
GuoXingbin 101376330+guoxingbin@users.noreply.github.com
Berkan Teber berkan@berkanteber.com
Tobias Klauser tklauser@distanz.ch
KARBOWSKI Piotr piotr.karbowski@gmail.com
GH geeklihui@foxmail.com
rafma0 int.main@gmail.com
Adrien Rey-Jarthon jobs@adrienjarthon.com
Nick Gooding 73336146+nickgooding@users.noreply.github.com
Leroy van Logchem lr.vanlogchem@gmail.com
Zsolt Ero zsolt.ero@gmail.com
Lesmiscore nao20010128@gmail.com
ehsantdy ehsan.tadayon@arvancloud.com ehsantadayon85@gmail.com
SwazRGB 65694696+swazrgb@users.noreply.github.com
Mateusz Puczyński mati6095@gmail.com
Michael C Tiernan - MIT-Research Computing Project mtiernan@mit.edu
Kaspian 34658474+KaspianDev@users.noreply.github.com
Werner EvilOlaf@users.noreply.github.com
Hugal31 hugo.laloge@gmail.com
Christian Galo 36752715+cgalo5758@users.noreply.github.com
Erik van Velzen erik@evanv.nl
Derek Battams derek@battams.ca
Paul devnoname120@gmail.com
SimonLiu simonliu009@users.noreply.github.com
Hugo Laloge hla@lescompanions.com
Mr-Kanister 68117355+Mr-Kanister@users.noreply.github.com
Rob Pickerill r.pickerill@gmail.com
Andrey to.merge@gmail.com
Eric Wolf 19wolf@gmail.com
Nick nick.naumann@mailbox.tu-dresden.de
Jason Zheng jszheng17@gmail.com
Matthew Vernon mvernon@wikimedia.org
Noah Hsu i@nn.ci
m00594701 mengpengbo@huawei.com
Art M. Gallagher artmg50@gmail.com
Sven Gerber 49589423+svengerber@users.noreply.github.com
CrossR r.cross@lancaster.ac.uk
Maciej Radzikowski maciej@radzikowski.com.pl
Scott Grimes scott.grimes@spaciq.com
Phil Shackleton 71221528+philshacks@users.noreply.github.com
eNV25 env252525@gmail.com
Caleb inventor96@users.noreply.github.com
J-P Treen jp@wraptious.com
Martin Czygan 53705+miku@users.noreply.github.com
buda sandrojijavadze@protonmail.com
mirekphd 36706320+mirekphd@users.noreply.github.com
vyloy vyloy@qq.com
Anthrazz 25553648+Anthrazz@users.noreply.github.com
zzr93 34027824+zzr93@users.noreply.github.com
Paul Norman penorman@mac.com
Lorenzo Maiorfi maiorfi@gmail.com
Claudio Maradonna penguyman@stronzi.org
Ovidiu Victor Tatar ovi.tatar@googlemail.com
Evan Spensley epspensley@gmail.com
Yen Hu 61753151+0x59656e@users.noreply.github.com
Steve Kowalik steven@wedontsleep.org
Jordi Gonzalez Muñoz jordigonzm@gmail.com
Joram Schrijver i@joram.io
Mark Trolley marktrolley@gmail.com
João Henrique Franco joaohenrique.franco@gmail.com
anonion aman207@users.noreply.github.com
Ryan Morey 4590343+rmorey@users.noreply.github.com
Simon Bos simonbos9@gmail.com
YFdyh000 yfdyh000@gmail.com
Øyvind Heddeland Instefjord instefjord@outlook.com
Dmitry Deniskin 110819396+ddeniskin@users.noreply.github.com
Alexander Knorr 106825+opexxx@users.noreply.github.com
Richard Bateman richard@batemansr.us
Dimitri Papadopoulos Orfanos 3234522+DimitriPapadopoulos@users.noreply.github.com
Lorenzo Milesi lorenzo.milesi@yetopen.com
Isaac Aymerich isaac.aymerich@gmail.com
YanceyChiew 35898533+YanceyChiew@users.noreply.github.com
Manoj Ghosh msays2000@gmail.com
Bachue Zhou bachue.shu@gmail.com
Manoj Ghosh manoj.ghosh@oracle.com
Tom Mombourquette tom@devnode.com
Robert Newson rnewson@apache.org
Samuel Johnson esamueljohnson@gmail.com
coultonluke luke@luke.org.uk
Anthony Pessy anthony@cogniteev.com
Philip Harvey pharvey@battelleecology.org
dgouju dgouju@users.noreply.github.com
Clément Notin clement.notin@gmail.com
x3-apptech 66947598+x3-apptech@users.noreply.github.com
Arnie97 arnie97@gmail.com
Roel Arents 2691308+roelarents@users.noreply.github.com
Aaron Gokaslan aaronGokaslan@gmail.com
techknowlogick matti@mdranta.net
rkettelerij richard@mindloops.nl
Kamui fin-kamui@pm.me
asdffdsazqqq 90116442+asdffdsazqqq@users.noreply.github.com
Nathaniel Wesley Filardo nfilardo@microsoft.com
ycdtosa ycdtosa@users.noreply.github.com
Erik Agterdenbos agterdenbos@users.noreply.github.com
Kevin Verstaen 48050031+kverstae@users.noreply.github.com
MohammadReza mrvashian@gmail.com
vanplus 60313789+vanplus@users.noreply.github.com
Jack 16779171+jkpe@users.noreply.github.com
Abdullah Saglam abdullah.saglam@stonebranch.com
Marks Polakovs github@markspolakovs.me
piyushgarg piyushgarg80@gmail.com
Kaloyan Raev kaloyan-raev@users.noreply.github.com
IMTheNachoMan imthenachoman@gmail.com
alankrit alankrit@google.com
Bryan Kaplan #@bryankaplan.com
LXY 767763591@qq.com
Simmon Li (he/him) li.simmon@gmail.com
happyxhw 44490504+happyxhw@users.noreply.github.com
Simmon Li (he/him) hello@crespire.dev
Matthias Baur baurmatt@users.noreply.github.com
Hunter Wittenborn hunter@hunterwittenborn.com
logopk peter@kreuser.name
Gerard Bosch 30733556+gerardbosch@users.noreply.github.com
ToBeFree github@tfrei.de
NodudeWasTaken 75137537+NodudeWasTaken@users.noreply.github.com
Peter Brunner peter@lugoues.net
Ninh Pham dongian.rapclubkhtn@gmail.com
Ryan Caezar Itang sitiom@proton.me
Peter Brunner peter@psykhe.com
Leandro Sacchet leandro.sacchet@animati.com.br
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
cycneuramus 56681631+cycneuramus@users.noreply.github.com
Arnavion me@arnavion.dev
Christopher Merry christopher.merry@mlb.com
Thibault Coupin thibault.coupin@gmail.com
Richard Tweed RichardoC@users.noreply.github.com
Zach Kipp Zacho2@users.noreply.github.com
yuudi 26199752+yuudi@users.noreply.github.com
NickIAm NickIAm@users.noreply.github.com
Juang, Yi-Lin frankyjuang@gmail.com
jumbi77 jumbi77@users.noreply.github.com
Aditya Basu ab.aditya.basu@gmail.com
ed s@ocv.me
Drew Parsons dparsons@emerall.com
Joel joelnb@users.noreply.github.com
wiserain mail275@gmail.com
Roel Arents roel.arents@kadaster.nl
Shyim github@shyim.de
Rintze Zelle 78232505+rzelle-lallemand@users.noreply.github.com
Damo damoclark@users.noreply.github.com
WeidiDeng weidi_deng@icloud.com
Brian Starkey stark3y@gmail.com
jladbrook jhladbrook@gmail.com
Loren Gordon lorengordon@users.noreply.github.com
dlitster davidlitster@gmail.com
Tobias Gion tobias@gion.io
Jānis Bebrītis janis.bebritis@wunder.io
Adam K github.com@ak.tidy.email
Andrei Smirnov smirnov.captain@gmail.com
Janne Hellsten jjhellst@gmail.com
cc 12904584+shvc@users.noreply.github.com
Tareq Sharafy tareq.sha@gmail.com
kapitainsky dariuszb@me.com
douchen playgoobug@gmail.com
Sam Lai 70988+slai@users.noreply.github.com
URenko 18209292+URenko@users.noreply.github.com
Stanislav Gromov kullfar@gmail.com
Paulo Schreiner paulo.schreiner@delivion.de
Mariusz Suchodolski mariusz@suchodol.ski
danielkrajnik dan94kra@gmail.com
Peter Fern github@0xc0dedbad.com
zzq i@zhangzqs.cn
mac-15 usman.ilamdin@phpstudios.com
Sawada Tsunayoshi 34431649+TsunayoshiSawada@users.noreply.github.com
Dean Attali daattali@gmail.com
Fjodor42 molgaard@gmail.com
BakaWang wa11579@hotmail.com
Mahad 56235065+Mahad-lab@users.noreply.github.com
Vladislav Vorobev x.miere@gmail.com
darix darix@users.noreply.github.com
Benjamin 36415086+bbenjamin-sys@users.noreply.github.com
Chun-Hung Tseng henrybear327@users.noreply.github.com
Ricardo D'O. Albanus rdalbanus@users.noreply.github.com
gabriel-suela gscsuela@gmail.com
Tiago Boeing contato@tiagoboeing.com
Edwin Mackenzie-Owen edwin.mowen@gmail.com
Niklas Hambüchen mail@nh2.me
yuudi yuudi@users.noreply.github.com
Zach github@prozach.org
nielash 31582349+nielash@users.noreply.github.com
Julian Lepinski lepinsk@users.noreply.github.com
Raymond Berger RayBB@users.noreply.github.com
Nihaal Sangha nihaal.git@gmail.com
Masamune3210 1053504+Masamune3210@users.noreply.github.com
James Braza jamesbraza@gmail.com
antoinetran antoinetran@users.noreply.github.com
alexia me@alexia.lol
nielash nielronash@gmail.com
Vitor Gomes vitor.gomes@delivion.de mail@vitorgomes.com
Jacob Hands jacob@gogit.io
hideo aoyama 100831251+boukendesho@users.noreply.github.com
Roberto Ricci io@r-ricci.it
Bjørn Smith bjornsmith@gmail.com
Alishan Ladhani 8869764+aladh@users.noreply.github.com
zjx20 zhoujianxiong2@gmail.com
Oksana 142890647+oks-maytech@users.noreply.github.com
Volodymyr Kit v.kit@maytech.net
David Pedersen limero@me.com
Drew Stinnett drew@drewlink.com
Pat Patterson pat@backblaze.com
Herby Gillot herby.gillot@gmail.com
Nikita Shoshin shoshin_nikita@fastmail.com
rinsuki 428rinsuki+git@gmail.com
Beyond Meat 51850644+beyondmeat@users.noreply.github.com
Saleh Dindar salh@fb.com
Volodymyr 142890760+vkit-maytech@users.noreply.github.com
Gabriel Espinoza 31670639+gspinoza@users.noreply.github.com
Keigo Imai keigo.imai@gmail.com
Ivan Yanitra iyanitra@tesla-consulting.com
alfish2000 alfish2000@gmail.com
wuxingzhong qq330332812@gmail.com
Adithya Kumar akumar42@protonmail.com
Tayo-pasedaRJ 138471223+Tayo-pasedaRJ@users.noreply.github.com
Peter Kreuser logo@kreuser.name
fotile96 fotile96@users.noreply.github.com
Luc Ritchie luc.ritchie@gmail.com
cynful cynful@users.noreply.github.com
wjielai wjielai@tencent.com
Jack Deng jackdeng@gmail.com
Mikubill 31246794+Mikubill@users.noreply.github.com
Artur Neumann artur@jankaritech.com
Saw-jan saw.jan.grg3e@gmail.com
Oksana Zhykina o.zhykina@maytech.net
karan karan.gupta92@gmail.com
viktor viktor@yakovchuk.net
moongdal moongdal@tutanota.com
Mina Galić freebsd@igalic.co
Alen Šiljak dev@alensiljak.eu.org
你知道未来吗 rkonfj@gmail.com
Abhinav Dhiman 8640877+ahnv@users.noreply.github.com
halms 7513146+halms@users.noreply.github.com
ben-ba benjamin.brauner@gmx.de
Eli Orzitzer e_orz@yahoo.com
Anthony Metzidis anthony.metzidis@gmail.com
keongalvin keongalvin@gmail.com
rarspace01 rarspace01@users.noreply.github.com
Paul Stern paulstern45@gmail.com
Nikhil Ahuja nikhilahuja@live.com
Harshit Budhraja 52413945+harshit-budhraja@users.noreply.github.com
Tera 24725862+teraa@users.noreply.github.com
Kyle Reynolds kylereynoldsdev@gmail.com
Michael Eischer michael.eischer@gmx.de
Thomas Müller 1005065+DeepDiver1975@users.noreply.github.com
DanielEgbers 27849724+DanielEgbers@users.noreply.github.com
Jack Provance 49460795+njprov@users.noreply.github.com
Gabriel Ramos 109390599+gabrielramos02@users.noreply.github.com
Dan McArdle d@nmcardle.com
Joe Cai joe.cai@bigcommerce.com
Anders Swanson anders.swanson@oracle.com
huajin tong 137764712+thirdkeyword@users.noreply.github.com
John-Paul Smith john-paulsmith@users.noreply.github.com
racerole 148756161+racerole@users.noreply.github.com
Gachoud Philippe ph.gachoud@gmail.com
YukiUnHappy saberhana@yandex.com
Kyle Reynolds kyle.reynolds@bridgerphotonics.com
Lewis Hook lewis@hook.im
hoyho luohaihao@gmail.com
Vitaly 9034218+gvitali@users.noreply.github.com
iotmaestro iotmaestro@proton.me
psychopatt 66741203+psychopatt@users.noreply.github.com
Alex Garel alex@garel.org
Warrentheo warrentheo@hotmail.com
Alexandre Lavigne lavigne958@gmail.com
yoelvini 134453420+yoelvini@users.noreply.github.com
Erisa A erisa@cloudflare.com
Pieter van Oostrum pieter@vanoostrum.org
jakzoe 155812065+jakzoe@users.noreply.github.com
guangwu guoguangwu@magic-shield.com
static-moonlight 107991124+static-moonlight@users.noreply.github.com
yudrywet yudeyao@yeah.net
Butanediol git@xnh.app
Dave Nicolson david.nicolson@gmail.com
Katia Esposito katia@linux.com
pawsey-kbuckley 36438302+pawsey-kbuckley@users.noreply.github.com
hidewrong 167099254+hidewrong@users.noreply.github.com
Michael Terry mike@mterry.name
Sunny 25066078+LoSunny@users.noreply.github.com
overallteach cricis@foxmail.com
JT Olio jt@olio.lol
Evan McBeth 64177332+AtomicRobotMan0101@users.noreply.github.com
Dominik Joe Pantůček dominik.pantucek@trustica.cz
yumeiyin 155420652+yumeiyin@users.noreply.github.com
Bruno Fernandes 54373093+folkzb@users.noreply.github.com
Thomas Schneider tspam.github@brainfuck.space
Charles Hamilton 52973156+chamilton-ccn@users.noreply.github.com
Tomasz Melcer tomasz@melcer.pl
Michał Dzienisiewicz michal.piotr.dz@gmail.com
Florian Klink flokli@flokli.de
Bill Fraser bill@wfraser.dev
Thearas thearas850@gmail.com
Filipe Herculano fifo_@live.com
Russ Bubley russ.bubley@googlemail.com
Paul Collins paul.collins@canonical.com
Tomasz Melcer liori@exroot.org
itsHenry 2671230065@qq.com
Ke Wang me@ke.wang
AThePeanut4 49614525+AThePeanut4@users.noreply.github.com
Tobias Markus tobbi.bugs@googlemail.com
Ernie Hershey github@ernie.org
Will Miles wmiles@sgl.com
David Seifert 16636962+SoapGentoo@users.noreply.github.com
Fornax wimbrand96@gmail.com
Sam Harrison sam.harrison@files.com
Péter Bozsó 3806723+peterbozso@users.noreply.github.com
Georg Welzel gwelzel@mailbox.org
John Oxley john.oxley@gmail.com joxley@meta.com
Pawel Palucha pawel.palucha@aetion.com
crystalstall crystalruby@qq.com
nipil nipil@users.noreply.github.com
yuval-cloudinary 46710068+yuval-cloudinary@users.noreply.github.com
Mathieu Moreau mrx23dot@users.noreply.github.com
fsantagostinobietti 6057026+fsantagostinobietti@users.noreply.github.com
Oleg Kunitsyn 114359669+hiddenmarten@users.noreply.github.com
Divyam 47589864+divyam234@users.noreply.github.com
ttionya ttionya@users.noreply.github.com
quiescens quiescens@gmail.com
rishi.sridhar rishi.sridhar@zohocorp.com
Lawrence Murray lawrence@indii.org
Leandro Piccilli leandro.piccilli@thalesgroup.com
Benjamin Legrand benjamin.legrand@seagate.com
Noam Ross noam.ross@gmail.com
lostb1t coding-mosses0z@icloud.com
Matthias Gatto matthias.gatto@outscale.com
André Tran andre.tran@outscale.com
Simon Bos simon@simonbos.be
Alexandre Hamez 199517+ahamez@users.noreply.github.com
Randy Bush randy@psg.com
Diego Monti diegmonti@users.noreply.github.com
tgfisher tgfisher@stanford.edu
Moises Lima mozlima@gmail.com
Dimitar Ivanov mimiteto@gmail.com
shenpengfeng xinhangzhou@icloud.com
Dimitrios Slamaris dim0x69@users.noreply.github.com
vintagefuture 39503528+vintagefuture@users.noreply.github.com
David Seifert soap@gentoo.org
Michael R. Davis mrdvt92@users.noreply.github.com
remygrandin remy.gr@ndin.fr
Ilias Ozgur Can Leonard iscilyas@gmail.com
divinity76 divinity76@gmail.com
Martin Hassack martin@redmaple.tech
Filipe Azevedo pasnox@gmail.com
hayden.pan hayden.pan@outlook.com
Yxxx 45665172+marsjane@users.noreply.github.com
Thomas ten Cate ttencate@gmail.com
Louis Laureys louis@laureys.me
Henry Lee contact@nynxz.com
ToM thomas.faucher@bibliosansfrontieres.org
TAKEI Yuya 853320+takei-yuya@users.noreply.github.com
Francesco Frassinelli fraph24@gmail.com francesco.frassinelli@nina.no
Matt Ickstadt mattico8@gmail.com matt@beckenterprises.com
Spencer McCullough mccullough.spencer@gmail.com
Jonathan Giannuzzi jonathan@giannuzzi.me
Christoph Berger github@christophberger.com
Tim White tim.white@su.org.au
Robin Schneider robin.schneider@stackit.cloud
izouxv izouxv@users.noreply.github.com
Moises Lima mozlima@users.noreply.github.com
Bruno Fernandes bruno.fernandes1996@hotmail.com
Corentin Barreau corentin@archive.org
hiddenmarten hiddenmarten@gmail.com
Trevor Starick trevor.starick@gmail.com
b-wimmer 132347192+b-wimmer@users.noreply.github.com
Jess jess@jessie.cafe
Zachary Vorhies zachvorhies@protonmail.com
Alexander Minbaev minbaev@gmail.com
Joel K Biju joelkbiju18@gmail.com
ll3006 doublel3006@gmail.com
jbagwell-akamai 113531113+jbagwell-akamai@users.noreply.github.com
Michael Kebe michael.kebe@gmail.com
Lorenz Brun lorenz@brun.one
Dave Vasilevsky djvasi@gmail.com dave@vasilevsky.ca
luzpaz luzpaz@users.noreply.github.com
jack 9480542+jackusm@users.noreply.github.com
Jörn Friedrich Dreyer jfd@butonic.de
alingse alingse@foxmail.com
Fernando Fernández ferferga@hotmail.com
eccoisle 167755281+eccoisle@users.noreply.github.com
Klaas Freitag kraft@freisturz.de
Danny Garside dannygarside@outlook.com
Samantha Bowen sam@bbowen.net
simonmcnair 101189766+simonmcnair@users.noreply.github.com
huanghaojun jasen.huang@ugreen.com
Enduriel endur1el@protonmail.com
Markus Gerstel markus.gerstel@osirium.com
simwai 16225108+simwai@users.noreply.github.com
Ben Alex ben.alex@acegi.com.au
Klaas Freitag opensource@freisturz.de klaas.freitag@kiteworks.com
Andrew Kreimer algonell@gmail.com
Ed Craig-Wood 138211970+edc-w@users.noreply.github.com
Christian Richter crichter@owncloud.com 1058116+dragonchaser@users.noreply.github.com
Ralf Haferkamp r.haferkamp@opencloud.eu
Jugal Kishore me@devjugal.com
Tho Neyugn nguyentruongtho@users.noreply.github.com
Ben Boeckel mathstuf@users.noreply.github.com
Clément Wehrung cwehrung@nurves.com
Jeff Geerling geerlingguy@mac.com
Germán Casares german.casares.march+github@gmail.com
fhuber florian.huber@noris.de
wbulot wbulot@hotmail.com
Jeremy Daer jeremydaer@gmail.com
Oleksiy Stashok ostashok@tesla.com
PrathameshLakawade prathameshlakawade@gmail.com
Nathanael Demacon 7271496+quantumsheep@users.noreply.github.com
ahxxm ahxxm@users.noreply.github.com
Flora Thiebaut johann.thiebaut@gmail.com
kingston125 support@filelu.com kingston125@github.com
Ser-Bul 30335009+Ser-Bul@users.noreply.github.com
jinjingroad jinjingroad@sina.com
necaran 55765083+necaran@users.noreply.github.com
Marvin Rösch marvinroesch99@gmail.com
curlwget curlwget@icloud.com
$@M@RTH_ 165886349+Samarth1015@users.noreply.github.com
Ali Zein Yousuf azy5030@gmail.com
Davide Bizzarri davide.bizzarri@willhaben.at
Ross Smith II ross@smithii.com
Vikas Bhansali 64532198+vibhansa-msft@users.noreply.github.com
Sudipto Baral sudiptobaral.me@gmail.com
Sam Pegg samrpegg@gmail.com 70067376+S-Pegg1@users.noreply.github.com
liubingrun liubr1@chinatelecom.cn
Albin Parou fumesover@gmail.com
n4n5 56606507+Its-Just-Nans@users.noreply.github.com
Florent Vennetier florent.vennetier@ovhcloud.com
houance 45840516+houance@users.noreply.github.com
Yu Xin 3188+is@users.noreply.github.com
Antonin Goude antonin.goude@ovhcloud.com
Timothy Jacobs timothy@ironbounddesigns.com
praveen-solanki-oracle praveen.solanki@oracle.com
huangnauh huanglibo2010@gmail.com
Lucas Bremgartner breml@users.noreply.github.com
Binbin Qian qianbinbin@hotmail.com
cui 523516579@qq.com
Tilman Vogel tilman.vogel@web.de
skbeh 60107333+skbeh@users.noreply.github.com
Claudius Ellsel claudius.ellsel@live.de
Motte 37443982+dmotte@users.noreply.github.com
dougal dougal.craigwood@gmail.com 147946567+roucc@users.noreply.github.com
anon-pradip pradipsubedi360@gmail.com
Robin Rolf imer@imer.cc
Jean-Christophe Cura jcaspes@gmail.com
russcoss russcoss@outlook.com
Matt LaPaglia mlapaglia@gmail.com
Youfu Zhang 1315097+zhangyoufu@users.noreply.github.com
juejinyuxitu juejinyuxitu@outlook.com
iTrooz hey@itrooz.fr
Microscotch github.com@microscotch.net
Andrew Ruthven andrew@etc.gen.nz
spiffytech git@spiffy.tech
Dulani Woods Dulani@gmail.com
Marco Ferretti mferretti93@gmail.com
hunshcn hunsh.cn@gmail.com
vastonus vastonus@outlook.com
Oleksandr Redko oleksandr.red+github@gmail.com
reddaisyy reddaisy@outlook.jp
viocha viocha@qq.com
Aneesh Agrawal aneesh@anthropic.com
divinity76 hans@loltek.net
Andrew Gunnerson accounts+github@chiller3.com
Lakshmi-Surekha Lakshmi.Kovvuri@ibm.com
dulanting dulanting@outlook.jp
Adam Dinwoodie me-and@users.noreply.github.com
Lukas Krejci metlos@users.noreply.github.com
Riaz Arbi riazarbi@users.noreply.github.com
Fawzib Rojas fawzib.rojas@gmail.com
fries1234 fries1234@protonmail.com
Joseph Brownlee 39440458+JellyJoe198@users.noreply.github.com
Ted Robertson 10043369+tredondo@users.noreply.github.com
SublimePeace 184005903+SublimePeace@users.noreply.github.com
Copilot 198982749+Copilot@users.noreply.github.com
Alex 64072843+A1ex3@users.noreply.github.com
n4n5 its.just.n4n5@gmail.com
aliaj1 ali19961@gmail.com
Sean Turner 30396892+seanturner026@users.noreply.github.com
jijamik 30904953+jijamik@users.noreply.github.com
Dominik Sander git@dsander.de
Nikolay Kiryanov nikolay@kiryanov.ru
Diana 5275194+DianaNites@users.noreply.github.com
Duncan Smart duncan.smart@gmail.com
vicerace vicerace@sohu.com
Cliff Frey cliff@openai.com
Vladislav Tropnikov vtr.name@gmail.com
Leo i@hardrain980.com
Johannes Rothe mail@johannes-rothe.de
Tingsong Xu tingsong.xu@rightcapital.com
Jonas Tingeborn 134889+jojje@users.noreply.github.com
jhasse-shade jacob@shade.inc
vyv03354 VYV03354@nifty.ne.jp
masrlinu masrlinu@users.noreply.github.com 5259918+masrlinu@users.noreply.github.com
vupn0712 126212736+vupn0712@users.noreply.github.com
darkdragon-001 darkdragon-001@users.noreply.github.com
sys6101 csvmen@gmail.com
Nicolas Dessart nds@outsight.tech
Qingwei Li 332664203@qq.com
yy yhymmt37@gmail.com
Marc-Philip marc-philip.werner@sap.com
Mikel Olasagasti Uranga mikel@olasagasti.info
Nick Owens mischief@offblast.org
hyusap paulayush@gmail.com
jzunigax2 125698953+jzunigax2@users.noreply.github.com
lullius lullius@users.noreply.github.com
StarHack StarHack@users.noreply.github.com
Leon Brocard acme@astray.com
Cohinem 143964778+Cohinem@users.noreply.github.com
Jack Kelly jack@OpenClimateFix.org
Prakhar Chhalotre chhalotreprakhar00@gmail.com
Varun Chawla 34209028+veeceey@users.noreply.github.com
Jan-Philipp Reßler 75355263+TabError@users.noreply.github.com
Shlomi Avihou shlomi@zadarastorage.com
Chris 238498929+chris081519-crypto@users.noreply.github.com
Jan-Philipp Reßler xodarap@xodarap.de
Dark Dragon darkdragon-001@web.de
Leon Brocard lbrocard@fastly.com
a1pcm a1pcm@users.noreply.github.com
FTCHD 144691102+FTCHD@users.noreply.github.com
Bjoern Franke bjo+git@schafweide.org
hxnd callmehxnd@outlook.de
Adam Kasztenny adamkasztenny@gmail.com
Romāns Potašovs justgook@gmail.com
Brian Bockelman bbockelman@morgridge.org
Bjoern Franke bjo@schafweide.org
razorloves razorloves@gmail.com
Duncan F 131309315+duncanaf@users.noreply.github.com
Billy Hughes w.g.h.hughes@gmail.com
Bhagyashreek8 57988406+Bhagyashreek8@users.noreply.github.com
Andriy Senyshyn 135705861+sam-mt@users.noreply.github.com
Andrew Furman 7343697+furmandev@users.noreply.github.com
ZRHan 56144550+ZRHann@users.noreply.github.com
Jason jasonbabo@gmail.com
Patrick Farrell pfarrell@whamcloud.com
BizaNator 17164422+BizaNator@users.noreply.github.com
lif 1835304752@qq.com
jinkeyuu 44105232+jinkeyuu@users.noreply.github.com
jinyu.han jinyu.han@ucloud.cn
Claude Opus 4.6 noreply@anthropic.com
Andriy Senyshyn andriy.senyshyn@kiteworks.com
Mike GIllan mike.gillan@gmail.com
Xiangzhe xiangzhedev@gmail.com
Suyun suyun@aosc.io
TheBabu ariq.haqq@gmail.com
Brais Couce braiscouce@gmail.com
Mozi 29089388+pzhlkj6612@users.noreply.github.com
SyoBoN syobon@syobon.net
Jan Heylen heyleke@gmail.com
tdawe 90407556+tdawe1@users.noreply.github.com
Anton Bordwine 54022438+antonchuvashow@users.noreply.github.com
mathieulongtin 617359+mathieulongtin@users.noreply.github.com
Luke Cyca me@lukecyca.com
dlaumen 262192488+dlaumen@users.noreply.github.com
Yakov Till 37628546+Lyapsus@users.noreply.github.com
Chris Coughlan chris@coughlan.io
John Volk volkjohn@users.noreply.github.com

B2

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Backblaze B2

B2 is Backblaze's cloud storage system.

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

Configuration

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

rclone config

This will guide you through an interactive setup process. To authenticate you will either need your Account ID (a short hex number) and Master Application Key (a long hex number) OR an Application Key, which is the recommended method. See below for further details on generating and using an Application Key.

No remotes found, make a new one\?
n) New remote
q) Quit config
n/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Backblaze B2
   \ "b2"
[snip]
Storage> b2
Account ID or Application Key ID
account> 123456789abc
Application Key
key> 0123456789abcdef0123456789abcdef0123456789
Endpoint for the service - leave blank normally.
endpoint>
Remote config
Configuration complete.
Options:
- type: b2
- account: 123456789abc
- key: 0123456789abcdef0123456789abcdef0123456789
- endpoint:
Keep this "remote" remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y

This remote is called remote and can now be used like this

See all buckets

rclone lsd remote:

Create a new bucket

rclone mkdir remote:bucket

List the contents of a bucket

rclone ls remote:bucket

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

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

Application Keys

B2 supports multiple Application Keys for different access permission to B2 Buckets.

You can use these with rclone too; you will need to use rclone version 1.43 or later.

Follow Backblaze's docs to create an Application Key with the required permission and add the applicationKeyId as the account and the Application Key itself as the key.

Note that you must put the applicationKeyId as the account – you can't use the master Account ID. If you try then B2 will return 401 errors.

--fast-list

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

Modification times

The modification time is stored as metadata on the object as X-Bz-Info-src_last_modified_millis as milliseconds since 1970-01-01 in the Backblaze standard. Other tools should be able to use this as a modified time.

Modified times are used in syncing and are fully supported. Note that if a modification time needs to be updated on an object then it will create a new version of the object.

Restricted filename characters

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

Character	Value	Replacement
\	0x5C	＼

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

Note that in 2020-05 Backblaze started allowing \ characters in file names. Rclone hasn't changed its encoding as this could cause syncs to re-transfer files. If you want rclone not to replace \ then see the --b2-encoding flag below and remove the BackSlash from the string. This can be set in the config.

SHA1 checksums

The SHA1 checksums of the files are checked on upload and download and will be used in the syncing process.

Large files (bigger than the limit in --b2-upload-cutoff) which are uploaded in chunks will store their SHA1 on the object as X-Bz-Info-large_file_sha1 as recommended by Backblaze.

For a large file to be uploaded with an SHA1 checksum, the source needs to support SHA1 checksums. The local disk supports SHA1 checksums so large file transfers from local disk will have an SHA1. See the overview for exactly which remotes support SHA1.

Sources which don't support SHA1, in particular crypt will upload large files without SHA1 checksums. This may be fixed in the future (see #1767).

Files sizes below --b2-upload-cutoff will always have an SHA1 regardless of the source.

Transfers

Backblaze recommends that you do lots of transfers simultaneously for maximum speed. In tests from my SSD equipped laptop the optimum setting is about --transfers 32 though higher numbers may be used for a slight speed improvement. The optimum number for you may vary depending on your hardware, how big the files are, how much you want to load your computer, etc. The default of --transfers 4 is definitely too low for Backblaze B2 though.

Note that uploading big files (bigger than 200 MiB by default) will use a 96 MiB 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

The default setting of B2 is to keep old versions of files. This means 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.

Whether B2 keeps old versions of files or not can be adjusted on a per bucket basis using the "Lifecycle settings" on the B2 control panel or when creating the bucket using the --b2-lifecycle flag or after creation using the rclone backend lifecycle command.

You may opt in to a "hard delete" of files with the --b2-hard-delete flag which permanently removes files on deletion instead of hiding them.

Old versions of files, where available, are visible using the --b2-versions flag. These can be deleted as required with delete.

It is also possible to view a bucket as it was at a certain point in time, using the --b2-version-at flag. This will show the file versions as they were at that time, showing files that have been deleted afterwards, and hiding files that were created since.

If you wish to remove all the old versions, and unfinished large file uploads, then you can use the rclone cleanup remote:bucket command which will delete all the old versions of files, leaving the current ones intact. You can also supply a path and only old versions under that path will be deleted, e.g. rclone cleanup remote:bucket/path/to/stuff.

Note that cleanup will remove partially uploaded files from the bucket if they are more than a day old. If you want more control over the expiry date then run rclone backend cleanup b2:bucket -o max-age=1h to remove all unfinished large file uploads older than one hour, leaving old versions intact.

If you wish to remove all the old versions, leaving current files and unfinished large files intact, then you can use the rclone backend cleanup-hidden remote:bucket command. You can also supply a path and only old versions under that path will be deleted, e.g. rclone backend cleanup-hidden remote:bucket/path/to/stuff.

When you purge a bucket, the current and the old versions will be deleted then the bucket will be deleted.

However delete will cause the current versions of the files to become hidden old versions.

Here is a session showing the listing and retrieval of an old version followed by a cleanup of the old versions.

Show current version and all the versions with --b2-versions flag.

$ rclone -q ls b2:cleanup-test
        9 one.txt

$ rclone -q --b2-versions ls b2:cleanup-test
        9 one.txt
        8 one-v2016-07-04-141032-000.txt
       16 one-v2016-07-04-141003-000.txt
       15 one-v2016-07-02-155621-000.txt

Retrieve an old version

$ rclone -q --b2-versions copy b2:cleanup-test/one-v2016-07-04-141003-000.txt /tmp

$ ls -l /tmp/one-v2016-07-04-141003-000.txt
-rw-rw-r-- 1 ncw ncw 16 Jul  2 17:46 /tmp/one-v2016-07-04-141003-000.txt

Clean up all the old versions and show that they've gone.

$ rclone -q cleanup b2:cleanup-test

$ rclone -q ls b2:cleanup-test
        9 one.txt

$ rclone -q --b2-versions ls b2:cleanup-test
        9 one.txt

Versions naming caveat

When using --b2-versions flag rclone is relying on the file name to work out whether the objects are versions or not. Versions' names are created by inserting timestamp between file name and its extension.

        9 file.txt
        8 file-v2023-07-17-161032-000.txt
       16 file-v2023-06-15-141003-000.txt

If there are real files present with the same names as versions, then behaviour of --b2-versions can be unpredictable.

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/v4/b2_authorize_account
/b2api/v1/b2_create_bucket
/b2api/v1/b2_list_buckets
/b2api/v1/b2_list_file_names

The b2_list_file_names request will be sent once for every 1k files in the remote path, providing the checksum and modification time of the listed files. As of version 1.33 issue #818 causes extra requests to be sent when using B2 with Crypt. When a copy operation does not require any files to be uploaded, no more requests will be sent.

Uploading files that do not require chunking, will send 2 requests per file upload:

/b2api/v1/b2_get_upload_url
/b2api/v1/b2_upload_file/

Uploading files requiring chunking, will send 2 requests (one each to start and finish the upload) and another 2 requests for each chunk:

/b2api/v1/b2_start_large_file
/b2api/v1/b2_get_upload_part_url
/b2api/v1/b2_upload_part/
/b2api/v1/b2_finish_large_file

Viewing versions with --b2-versions

Versions can be viewed with the --b2-versions flag. When it is set rclone will show and act on older versions of files. For example

Listing without --b2-versions

$ rclone -q ls b2:cleanup-test
        9 one.txt

And with

$ rclone -q --b2-versions ls b2:cleanup-test
        9 one.txt
        8 one-v2016-07-04-141032-000.txt
       16 one-v2016-07-04-141003-000.txt
       15 one-v2016-07-02-155621-000.txt

Showing that the current version is unchanged but older versions can be seen. These have the UTC date that they were uploaded to the server to the nearest millisecond appended to them.

Note that when using --b2-versions no file write operations are permitted, so you can't upload files or delete them.

B2 and rclone link

Rclone supports generating file share links for private B2 buckets. They can either be for a file for example:

./rclone link B2:bucket/path/to/file.txt
https://f002.backblazeb2.com/file/bucket/path/to/file.txt?Authorization=xxxxxxxx

or if run on a directory you will get:

./rclone link B2:bucket/path
https://f002.backblazeb2.com/file/bucket/path?Authorization=xxxxxxxx

you can then use the authorization token (the part of the url from the ?Authorization= on) on any file path under that directory. For example:

https://f002.backblazeb2.com/file/bucket/path/to/file1?Authorization=xxxxxxxx
https://f002.backblazeb2.com/file/bucket/path/file2?Authorization=xxxxxxxx
https://f002.backblazeb2.com/file/bucket/path/folder/file3?Authorization=xxxxxxxx

Standard options

Here are the Standard options specific to b2 (Backblaze B2).

--b2-account

Account ID or Application Key ID.

Properties:

Config: account
Env Var: RCLONE_B2_ACCOUNT
Type: string
Required: true

--b2-key

Application Key.

Properties:

Config: key
Env Var: RCLONE_B2_KEY
Type: string
Required: true

--b2-hard-delete

Permanently delete files on remote removal, otherwise hide files.

Properties:

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.

Properties:

Config: endpoint
Env Var: RCLONE_B2_ENDPOINT
Type: string
Required: false

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

Properties:

Config: test_mode
Env Var: RCLONE_B2_TEST_MODE
Type: string
Required: false

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

Properties:

Config: versions
Env Var: RCLONE_B2_VERSIONS
Type: bool
Default: false

--b2-version-at

Show file versions as they were at the specified time.

Note that when using this no file write operations are permitted, so you can't upload files or delete them.

Properties:

Config: version_at
Env Var: RCLONE_B2_VERSION_AT
Type: Time
Default: off

--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.657 GiB (== 5 GB).

Properties:

Config: upload_cutoff
Env Var: RCLONE_B2_UPLOAD_CUTOFF
Type: SizeSuffix
Default: 200Mi

--b2-copy-cutoff

Cutoff for switching to multipart copy.

Any files larger than this that need to be server-side copied will be copied in chunks of this size.

The minimum is 0 and the maximum is 4.6 GiB.

Properties:

Config: copy_cutoff
Env Var: RCLONE_B2_COPY_CUTOFF
Type: SizeSuffix
Default: 4Gi

--b2-chunk-size

Upload chunk size.

When uploading large files, chunk the file into this size.

Must fit in memory. 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.

Properties:

Config: chunk_size
Env Var: RCLONE_B2_CHUNK_SIZE
Type: SizeSuffix
Default: 96Mi

--b2-upload-concurrency

Concurrency for multipart uploads.

This is the number of chunks of the same file that are uploaded concurrently.

Note that chunks are stored in memory and there may be up to "--transfers" * "--b2-upload-concurrency" chunks stored at once in memory.

Properties:

Config: upload_concurrency
Env Var: RCLONE_B2_UPLOAD_CONCURRENCY
Type: int
Default: 4

--b2-disable-checksum

Disable checksums for large (> upload cutoff) files.

Normally rclone will calculate the SHA1 checksum of the input before uploading it so it can add it to metadata on the object. This is great for data integrity checking but can cause long delays for large files to start uploading.

Properties:

Config: disable_checksum
Env Var: RCLONE_B2_DISABLE_CHECKSUM
Type: bool
Default: false

--b2-download-url

Custom endpoint for downloads.

This is usually set to a Cloudflare CDN URL as Backblaze offers free egress for data downloaded through the Cloudflare network. Rclone works with private buckets by sending an "Authorization" header. If the custom endpoint rewrites the requests for authentication, e.g., in Cloudflare Workers, this header needs to be handled properly. Leave blank if you want to use the endpoint provided by Backblaze.

The URL provided here SHOULD have the protocol and SHOULD NOT have a trailing slash or specify the /file/bucket subpath as rclone will request files with "{download_url}/file/{bucket_name}/{path}".

Example:

https://mysubdomain.mydomain.tld (No trailing "/", "file" or "bucket")

Properties:

Config: download_url
Env Var: RCLONE_B2_DOWNLOAD_URL
Type: string
Required: false

--b2-download-auth-duration

Time before the public link authorization token will expire in s or suffix ms|s|m|h|d.

This is used in combination with "rclone link" for making files accessible to the public and sets the duration before the download authorization token will expire.

The minimum value is 1 second. The maximum value is one week.

Properties:

Config: download_auth_duration
Env Var: RCLONE_B2_DOWNLOAD_AUTH_DURATION
Type: Duration
Default: 1w

--b2-memory-pool-flush-time

How often internal memory buffer pools will be flushed. (no longer used)

Properties:

Config: memory_pool_flush_time
Env Var: RCLONE_B2_MEMORY_POOL_FLUSH_TIME
Type: Duration
Default: 1m0s

--b2-memory-pool-use-mmap

Whether to use mmap buffers in internal memory pool. (no longer used)

Properties:

Config: memory_pool_use_mmap
Env Var: RCLONE_B2_MEMORY_POOL_USE_MMAP
Type: bool
Default: false

--b2-lifecycle

Set the number of days deleted files should be kept when creating a bucket.

On bucket creation, this parameter is used to create a lifecycle rule for the entire bucket.

If lifecycle is 0 (the default) it does not create a lifecycle rule so the default B2 behaviour applies. This is to create versions of files on delete and overwrite and to keep them indefinitely.

If lifecycle is >0 then it creates a single rule setting the number of days before a file that is deleted or overwritten is deleted permanently. This is known as daysFromHidingToDeleting in the b2 docs.

The minimum value for this parameter is 1 day.

You can also enable hard_delete in the config also which will mean deletions won't cause versions but overwrites will still cause versions to be made.

See: rclone backend lifecycle for setting lifecycles after bucket creation.

Properties:

Config: lifecycle
Env Var: RCLONE_B2_LIFECYCLE
Type: int
Default: 0

--b2-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

Config: encoding
Env Var: RCLONE_B2_ENCODING
Type: Encoding
Default: Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot

--b2-sse-customer-algorithm

If using SSE-C, the server-side encryption algorithm used when storing this object in B2.

Properties:

Config: sse_customer_algorithm
Env Var: RCLONE_B2_SSE_CUSTOMER_ALGORITHM
Type: string
Required: false
Examples:
- ""
  - None
- "AES256"
  - Advanced Encryption Standard (256 bits key length)

--b2-sse-customer-key

To use SSE-C, you may provide the secret encryption key encoded in a UTF-8 compatible string to encrypt/decrypt your data

Alternatively you can provide --sse-customer-key-base64.

Properties:

Config: sse_customer_key
Env Var: RCLONE_B2_SSE_CUSTOMER_KEY
Type: string
Required: false
Examples:
- ""
  - None

--b2-sse-customer-key-base64

To use SSE-C, you may provide the secret encryption key encoded in Base64 format to encrypt/decrypt your data

Alternatively you can provide --sse-customer-key.

Properties:

Config: sse_customer_key_base64
Env Var: RCLONE_B2_SSE_CUSTOMER_KEY_BASE64
Type: string
Required: false
Examples:
- ""
  - None

--b2-sse-customer-key-md5

If using SSE-C you may provide the secret encryption key MD5 checksum (optional).

If you leave it blank, this is calculated automatically from the sse_customer_key provided.

Properties:

Config: sse_customer_key_md5
Env Var: RCLONE_B2_SSE_CUSTOMER_KEY_MD5
Type: string
Required: false
Examples:
- ""
  - None

--b2-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_B2_DESCRIPTION
Type: string
Required: false

Backend commands

Here are the commands specific to the b2 backend.

Run them with:

rclone backend COMMAND remote:

The help below will explain what arguments each command takes.

See the backend command for more info on how to pass options and arguments.

These can be run on a running backend using the rc command backend/command.

lifecycle

Read or set the lifecycle for a bucket.

rclone backend lifecycle remote: [options] [<arguments>+]

This command can be used to read or set the lifecycle for a bucket.

To show the current lifecycle rules:

rclone backend lifecycle b2:bucket

This will dump something like this showing the lifecycle rules.

[
    {
        "daysFromHidingToDeleting": 1,
        "daysFromUploadingToHiding": null,
        "daysFromStartingToCancelingUnfinishedLargeFiles": null,
        "fileNamePrefix": ""
    }
]

If there are no lifecycle rules (the default) then it will just return [].

To reset the current lifecycle rules:

rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30
rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1

This will run and then print the new lifecycle rules as above.

Rclone only lets you set lifecycles for the whole bucket with the fileNamePrefix = "".

You can't disable versioning with B2. The best you can do is to set the daysFromHidingToDeleting to 1 day. You can enable hard_delete in the config also which will mean deletions won't cause versions but overwrites will still cause versions to be made.

rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1

See: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules

Options:

"daysFromHidingToDeleting": After a file has been hidden for this many days it is deleted. 0 is off.
"daysFromStartingToCancelingUnfinishedLargeFiles": Cancels any unfinished large file versions after this many days.
"daysFromUploadingToHiding": This many days after uploading a file is hidden.

cleanup

Remove unfinished large file uploads.

rclone backend cleanup remote: [options] [<arguments>+]

This command removes unfinished large file uploads of age greater than max-age, which defaults to 24 hours.

Note that you can use --interactive/-i or --dry-run with this command to see what it would do.

rclone backend cleanup b2:bucket/path/to/object
rclone backend cleanup -o max-age=7w b2:bucket/path/to/object

Durations are parsed as per the rest of rclone, 2h, 7d, 7w etc.

Options:

"max-age": Max age of upload to delete.

cleanup-hidden

Remove old versions of files.

rclone backend cleanup-hidden remote: [options] [<arguments>+]

This command removes any old hidden versions of files.

Note that you can use --interactive/-i or --dry-run with this command to see what it would do.

rclone backend cleanup-hidden b2:bucket/path/to/dir

Limitations

rclone about is not supported by the B2 backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

See List of backends that do not support rclone about and rclone about.

Backend Support Tiers

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Tiers

Rclone backends are divided into tiers to give users an idea of the stability of each backend.

Tier	Label	Intended meaning
Tier 1	Core	Production-grade, first-class
Tier 2	Stable	Well-supported, minor gaps
Tier 3	Supported	Works for many uses; known caveats
Tier 4	Experimental	Use with care; expect gaps/changes
Tier 5	Deprecated	No longer maintained or supported

Overview

Here is a summary of all backends:

Backend	Tier	Maintainers	Features	Tests	Integrity	Perf	Adoption	Docs	Security
Alias	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Archive	Tier 3	Core	3	✔ Passing	Hash	High	Some use	Full	High
Azure Blob	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Azure Files	Tier 2	Core	6	✔ Passing	Hash	High	Widely used	Full	High
B2	Tier 1	Core	6	✔ Passing	Hash	High	Widely used	Full	High
Box	Tier 1	Core	6	✔ Passing	Hash	High	Widely used	Full	High
Cache	Tier 5	None	7	✔ Passing	Hash	High	Some use	Full	High
Chunker	Tier 4	None	7	✔ Passing	Hash	High	Some use	Full	High
Cloudinary	Tier 3	Core	3	✖ Failing	Hash	High	Often used	Full	High
Combine	Tier 1	Core	7	✔ Passing	Hash	High	Often used	Full	High
Compress	Tier 4	Core	5	✖ Failing	Hash	Medium	Some use	Full	High
Crypt	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Doi	Tier 2	External	0	✖ N/A	Other	High	Some use	Full	High
Drime	Tier 1	Core	4	✔ Passing	High	High	Some use	Full	High
Drive	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Dropbox	Tier 1	Core	6	✔ Passing	Hash	High	Widely used	Full	High
Fichier	Tier 3	Core	2	✔ Passing	Hash	Medium	Some use	Full	High
Filefabric	Tier 4	Core	3	✖ Failing	Modtime	Medium	Some use	Full	High
Filelu	Tier 1	Core	1	✔ Passing	Hash	High	Widely used	Full	High
Filen	Tier 1	External	6	✔ Passing	Hash	High	Some use	Full	High
Filescom	Tier 1	Core	5	✔ Passing	Hash	High	Widely used	Full	High
FTP	Tier 1	Core	4	✔ Passing	Modtime	High	Widely used	Full	Varies
Gofile	Tier 1	Core	5	✔ Passing	Hash	High	Often used	Full	High
Google Cloud Storage	Tier 1	Core	6	✔ Passing	Hash	High	Widely used	Full	High
Google Photos	Tier 5	None	0	✖ Failing	Other	Low	Some use	Full	High
Hasher	Tier 4	Core	7	✔ Passing	Hash	High	Some use	Full	High
HDFS	Tier 2	Core	4	✔ Passing	Modtime	Medium	Some use	Full	High
Hidrive	Tier 1	Core	5	✔ Passing	Hash	Medium	Often used	Full	High
HTTP	Tier 3	Core	0	✖ N/A	Other	High	Widely used	Full	Varies
Huaweidrive	Tier 3	External	4	✔ Passing	Hash	High	Some use	Full	High
Iclouddrive	Tier 4	External	3	✖ Flaky	Modtime	Low	Some use	Full	High
Imagekit	Tier 1	External	0	✔ Passing	Other	High	Some use	Full	High
Internet Archive	Tier 3	Core	5	✖ Failing	Hash	Medium	Widely used	Full	High
Internxt	Tier 2	External	0	✔ Passing	Other	High	Some use	Full	High
Jottacloud	Tier 2	Core	6	✖ Flaky	Hash	High	Widely used	Full	High
Koofr	Tier 2	Core	5	✔ Passing	Hash	High	Widely used	Full	High
Linkbox	Tier 5	Core	2	✖ Failing	Modtime	High	Often used	Basic	High
Local	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Mailru	Tier 1	External	6	✔ Passing	Hash	Medium	Often used	Full	High
Mega	Tier 2	Core	3	✖ Flaky	Other	High	Widely used	Full	High
Memory	Tier 1	Core	4	✔ Passing	Hash	High	Widely used	Full	High
Netstorage	Tier 1	Core	3	✔ Passing	Hash	High	Some use	Full	High
Onedrive	Tier 1	Core	6	✖ Flaky	Hash	High	Widely used	Full	High
Opendrive	Tier 1	Core	5	✔ Passing	Hash	High	Often used	Full	High
Oracle Object Storage	Tier 1	Core	6	✔ Passing	Hash	High	Widely used	Full	High
Pcloud	Tier 1	Core	5	✔ Passing	Hash	High	Often used	Full	High
Pikpak	Tier 1	External	5	✔ Passing	Hash	High	Often used	Full	High
Pixeldrain	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Premiumizeme	Tier 3	Core	2	✔ Passing	Other	High	Some use	Full	High
Proton Drive	Tier 4	Community	4	✔ Passing	Hash	High	Often used	Full	High
Putio	Tier 2	Core	5	✖ Flaky	Hash	Low	Often used	Full	High
Qingstor	Tier 3	Core	3	✖ Disabled	Hash	High	Often used	Full	High
Quatrix	Tier 3	Core	3	✔ Passing	Hash	High	Often used	Full	High
S3	Tier 1	Core	7	✔ Passing	Hash	High	Widely used	Full	High
Seafile	Tier 3	Core	3	✖ Failing	Other	Medium	Some use	Basic	High
SFTP	Tier 1	Core	5	✔ Passing	Hash	High	Widely used	Full	High
Shade	Tier 1	External	0	✔ Passing	Other	High	Some use	Full	High
Sharefile	Tier 5	Core	4	✖ Disabled	Modtime	Medium	Some use	Full	High
Sia	Tier 4	Core	1	✖ Failing	Other	Medium	Some use	Full	High
SMB	Tier 2	External	5	✔ Passing	Modtime	Medium	Some use	Full	High
Storj	Tier 1	Core	4	✔ Passing	Modtime	High	Widely used	Full	High
Sugarsync	Tier 3	Core	3	✔ Passing	Other	Medium	Some use	Full	High
Swift	Tier 1	Core	4	✔ Passing	Hash	High	Widely used	Full	High
Ulozto	Tier 3	Core	3	✖ Failing	Hash	Medium	Often used	Full	High
Union	Tier 1	Core	7	✔ Passing	Hash	High	Often used	Full	High
WebDAV	Tier 1	Core	5	✔ Passing	Hash	Low	Widely used	Full	High
Yandex	Tier 1	External	5	✔ Passing	Hash	High	Often used	Full	High
Zoho	Tier 3	External	2	✖ Failing	Other	Medium	Often used	Full	High

Scoring

Here is how the backends are scored.

Features

These are useful optional features a backend should have in rough order of importance. Each one of these scores a point for the Features column.

F1: Hash(es)
F2: Modtime
F3: Stream upload
F4: Copy/Move
F5: DirMove
F6: Metadata
F7: MultipartUpload

Tier

The tier is decided after determining these attributes. Some discretion is allowed in tiering as some of these attributes are more important than others.

Attr	T1: Core	T2: Stable	T3: Supported	T4: Experimental	T5: Incubator
Maintainers	>=2	>=1	>=1	>=0	>=0
API source	Official	Official	Either	Either	Either
Features (F1-F7)	>=5/7	>=4/7	>=3/7	>=2/7	N/A
Integration tests	All Green	All green	Nearly all green	Some Flaky	N/A
Error handling	Pacer	Pacer	Retries	Retries	N/A
Data integrity	Hashes, alt, modtime	Hashes or alt	Hash OR modtime	Best-effort	N/A
Perf baseline	Bench within 2x S3	Bench doc	Anecdotal OK	Optional	N/A
Adoption	widely used	often used	some use	N/A	N/A
Docs completeness	Full	Full	Basic	Minimal	Minimal
Security	Principle-of-least-privilege	Reasonable scopes	Basic auth	Works	Works

Backends

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Bisync

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Bisync

bisync is considered an advanced command, so use with care. Make sure you have read and understood the entire manual (especially the Limitations section) before using, or data loss can result. Questions can be asked in the Rclone Forum.

Getting started

Install rclone and setup your remotes.
Bisync will create its working directory at ~/.cache/rclone/bisync on Linux, /Users/yourusername/Library/Caches/rclone/bisync on Mac, or C:\Users\MyLogin\AppData\Local\rclone\bisync on Windows. Make sure that this location is writable.
Run bisync with the --resync flag, specifying the paths to the local and remote sync directory roots.
For successive sync runs, leave off the --resync flag. (Important!)
Consider using a filters file for excluding unnecessary files and directories from the sync.
Consider setting up the --check-access feature for safety.
On Linux or Mac, consider setting up a crontab entry. bisync can safely run in concurrent cron jobs thanks to lock files it maintains.

For example, your first command might look like this:

rclone bisync remote1:path1 remote2:path2 --create-empty-src-dirs --compare size,modtime,checksum --slow-hash-sync-only --resilient -MvP --drive-skip-gdocs --fix-case --resync --dry-run

If all looks good, run it again without --dry-run. After that, remove --resync as well.

Here is a typical run log (with timestamps removed for clarity):

rclone bisync /testdir/path1/ /testdir/path2/ --verbose
INFO  : Synching Path1 "/testdir/path1/" with Path2 "/testdir/path2/"
INFO  : Path1 checking for diffs
INFO  : - Path1    File is new                         - file11.txt
INFO  : - Path1    File is newer                       - file2.txt
INFO  : - Path1    File is newer                       - file5.txt
INFO  : - Path1    File is newer                       - file7.txt
INFO  : - Path1    File was deleted                    - file4.txt
INFO  : - Path1    File was deleted                    - file6.txt
INFO  : - Path1    File was deleted                    - file8.txt
INFO  : Path1:    7 changes:    1 new,    3 newer,    0 older,    3 deleted
INFO  : Path2 checking for diffs
INFO  : - Path2    File is new                         - file10.txt
INFO  : - Path2    File is newer                       - file1.txt
INFO  : - Path2    File is newer                       - file5.txt
INFO  : - Path2    File is newer                       - file6.txt
INFO  : - Path2    File was deleted                    - file3.txt
INFO  : - Path2    File was deleted                    - file7.txt
INFO  : - Path2    File was deleted                    - file8.txt
INFO  : Path2:    7 changes:    1 new,    3 newer,    0 older,    3 deleted
INFO  : Applying changes
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file11.txt
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file2.txt
INFO  : - Path2    Queue delete                        - /testdir/path2/file4.txt
NOTICE: - WARNING  New or changed in both paths        - file5.txt
NOTICE: - Path1    Renaming Path1 copy                 - /testdir/path1/file5.txt..path1
NOTICE: - Path1    Queue copy to Path2                 - /testdir/path2/file5.txt..path1
NOTICE: - Path2    Renaming Path2 copy                 - /testdir/path2/file5.txt..path2
NOTICE: - Path2    Queue copy to Path1                 - /testdir/path1/file5.txt..path2
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file6.txt
INFO  : - Path1    Queue copy to Path2                 - /testdir/path2/file7.txt
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file1.txt
INFO  : - Path2    Queue copy to Path1                 - /testdir/path1/file10.txt
INFO  : - Path1    Queue delete                        - /testdir/path1/file3.txt
INFO  : - Path2    Do queued copies to                 - Path1
INFO  : - Path1    Do queued copies to                 - Path2
INFO  : -          Do queued deletes on                - Path1
INFO  : -          Do queued deletes on                - Path2
INFO  : Updating listings
INFO  : Validating listings for Path1 "/testdir/path1/" vs Path2 "/testdir/path2/"
INFO  : Bisync successful

Command line syntax

$ rclone bisync --help
Usage:
  rclone bisync remote1:path1 remote2:path2 [flags]

Positional arguments:
  Path1, Path2  Local path, or remote storage with ':' plus optional path.
                Type 'rclone listremotes' for list of configured remotes.

Optional Flags:
      --backup-dir1 string                   --backup-dir for Path1. Must be a non-overlapping path on the same remote.
      --backup-dir2 string                   --backup-dir for Path2. Must be a non-overlapping path on the same remote.
      --check-access                         Ensure expected RCLONE_TEST files are found on both Path1 and Path2 filesystems, else abort.
      --check-filename string                Filename for --check-access (default: RCLONE_TEST)
      --check-sync string                    Controls comparison of final listings: true|false|only (default: true) (default "true")
      --compare string                       Comma-separated list of bisync-specific compare options ex. 'size,modtime,checksum' (default: 'size,modtime')
      --conflict-loser ConflictLoserAction   Action to take on the loser of a sync conflict (when there is a winner) or on both files (when there is no winner): , num, pathname, delete (default: num)
      --conflict-resolve string              Automatically resolve conflicts by preferring the version that is: none, path1, path2, newer, older, larger, smaller (default: none) (default "none")
      --conflict-suffix string               Suffix to use when renaming a --conflict-loser. Can be either one string or two comma-separated strings to assign different suffixes to Path1/Path2. (default: 'conflict')
      --create-empty-src-dirs                Sync creation and deletion of empty directories. (Not compatible with --remove-empty-dirs)
      --download-hash                        Compute hash by downloading when otherwise unavailable. (warning: may be slow and use lots of data!)
      --filters-file string                  Read filtering patterns from a file
      --force                                Bypass --max-delete safety check and run the sync. Consider using with --verbose
  -h, --help                                 help for bisync
      --ignore-listing-checksum              Do not use checksums for listings (add --ignore-checksum to additionally skip post-copy checksum checks)
      --max-lock Duration                    Consider lock files older than this to be expired (default: 0 (never expire)) (minimum: 2m) (default 0s)
      --no-cleanup                           Retain working files (useful for troubleshooting and testing).
      --no-slow-hash                         Ignore listing checksums only on backends where they are slow
      --recover                              Automatically recover from interruptions without requiring --resync.
      --remove-empty-dirs                    Remove ALL empty directories at the final cleanup step.
      --resilient                            Allow future runs to retry after certain less-serious errors, instead of requiring --resync.
  -1, --resync                               Performs the resync run. Equivalent to --resync-mode path1. Consider using --verbose or --dry-run first.
      --resync-mode string                   During resync, prefer the version that is: path1, path2, newer, older, larger, smaller (default: path1 if --resync, otherwise none for no resync.) (default "none")
      --retries int                          Retry operations this many times if they fail (requires --resilient). (default 3)
      --retries-sleep Duration               Interval between retrying operations if they fail, e.g. 500ms, 60s, 5m (0 to disable) (default 0s)
      --slow-hash-sync-only                  Ignore slow checksums for listings and deltas, but still consider them during sync calls.
      --workdir string                       Use custom working dir - useful for testing. (default: {WORKDIR})
      --max-delete PERCENT                   Safety check on maximum percentage of deleted files allowed. If exceeded, the bisync run will abort. (default: 50%)
  -n, --dry-run                              Go through the motions - No files are copied/deleted.
  -v, --verbose                              Increases logging verbosity. May be specified more than once for more details.

Arbitrary rclone flags may be specified on the bisync command line, for example rclone bisync ./testdir/path1/ gdrive:testdir/path2/ --drive-skip-gdocs -v -v --timeout 10s Note that interactions of various rclone flags with bisync process flow has not been fully tested yet.

Paths

Path1 and Path2 arguments may be references to any mix of local directory paths (absolute or relative), UNC paths (//server/share/path), Windows drive paths (with a drive letter and :) or configured remotes with optional subdirectory paths. Cloud references are distinguished by having a : in the argument (see Windows support below).

Path1 and Path2 are treated equally, in that neither has priority for file changes (except during --resync), and access efficiency does not change whether a remote is on Path1 or Path2.

The listings in bisync working directory (default: ~/.cache/rclone/bisync) are named based on the Path1 and Path2 arguments so that separate syncs to individual directories within the tree may be set up, e.g.: path_to_local_tree..dropbox_subdir.lst.

Any empty directories after the sync on both the Path1 and Path2 filesystems are not deleted by default, unless --create-empty-src-dirs is specified. If the --remove-empty-dirs flag is specified, then both paths will have ALL empty directories purged as the last step in the process.

Command-line flags

--resync

This will effectively make both Path1 and Path2 filesystems contain a matching superset of all files. By default, Path2 files that do not exist in Path1 will be copied to Path1, and the process will then copy the Path1 tree to Path2.

The --resync sequence is roughly equivalent to the following (but see --resync-mode for other options):

rclone copy Path2 Path1 --ignore-existing [--create-empty-src-dirs]
rclone copy Path1 Path2 [--create-empty-src-dirs]

The base directories on both Path1 and Path2 filesystems must exist or bisync will fail. This is required for safety - that bisync can verify that both paths are valid.

When using --resync, a newer version of a file on the Path2 filesystem will (by default) be overwritten by the Path1 filesystem version. (Note that this is NOT entirely symmetrical, and more symmetrical options can be specified with the --resync-mode flag.) Carefully evaluate deltas using --dry-run.

For a resync run, one of the paths may be empty (no files in the path tree). The resync run should result in files on both paths, else a normal non-resync run will fail.

For a non-resync run, either path being empty (no files in the tree) fails with Empty current PathN listing. Cannot sync to an empty directory: X.pathN.lst This is a safety check that an unexpected empty path does not result in deleting everything in the other path.

Note that --resync implies --resync-mode path1 unless a different --resync-mode is explicitly specified. It is not necessary to use both the --resync and --resync-mode flags -- either one is sufficient without the other.

Note: --resync (including --resync-mode) should only be used under three specific (rare) circumstances:

It is your first bisync run (between these two paths)
You've just made changes to your bisync settings (such as editing the contents of your --filters-file)
There was an error on the prior run, and as a result, bisync now requires --resync to recover

The rest of the time, you should omit --resync. The reason is because --resync will only copy (not sync) each side to the other. Therefore, if you included --resync for every bisync run, it would never be possible to delete a file -- the deleted file would always keep reappearing at the end of every run (because it's being copied from the other side where it still exists). Similarly, renaming a file would always result in a duplicate copy (both old and new name) on both sides.

If you find that frequent interruptions from #3 are an issue, rather than automatically running --resync, the recommended alternative is to use the --resilient, --recover, and --conflict-resolve flags, (along with Graceful Shutdown mode, when needed) for a very robust "set-it-and-forget-it" bisync setup that can automatically bounce back from almost any interruption it might encounter. Consider adding something like the following:

--resilient --recover --max-lock 2m --conflict-resolve newer

--resync-mode CHOICE

In the event that a file differs on both sides during a --resync, --resync-mode controls which version will overwrite the other. The supported options are similar to --conflict-resolve. For all of the following options, the version that is kept is referred to as the "winner", and the version that is overwritten (deleted) is referred to as the "loser". The options are named after the "winner":

path1 - (the default) - the version from Path1 is unconditionally considered the winner (regardless of modtime and size, if any). This can be useful if one side is more trusted or up-to-date than the other, at the time of the --resync.
path2 - same as path1, except the path2 version is considered the winner.
newer - the newer file (by modtime) is considered the winner, regardless of which side it came from. This may result in having a mix of some winners from Path1, and some winners from Path2. (The implementation is analogous to running rclone copy --update in both directions.)
older - same as newer, except the older file is considered the winner, and the newer file is considered the loser.
larger - the larger file (by size) is considered the winner (regardless of modtime, if any). This can be a useful option for remotes without modtime support, or with the kinds of files (such as logs) that tend to grow but not shrink, over time.
smaller - the smaller file (by size) is considered the winner (regardless of modtime, if any).

For all of the above options, note the following:

If either of the underlying remotes lacks support for the chosen method, it will be ignored and will fall back to the default of path1. (For example, if --resync-mode newer is set, but one of the paths uses a remote that doesn't support modtime.)
If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored, and bisync will instead try to determine whether the files differ by looking at the other --compare methods in effect. (For example, if --resync-mode newer is set, but the Path1 and Path2 modtimes are identical, bisync will compare the sizes.) If bisync concludes that they differ, preference is given to whichever is the "source" at that moment. (In practice, this gives a slight advantage to Path2, as the 2to1 copy comes before the 1to2 copy.) If the files do not differ, nothing is copied (as both sides are already correct).
These options apply only to files that exist on both sides (with the same name and relative path). Files that exist only on one side and not the other are always copied to the other, during --resync (this is one of the main differences between resync and non-resync runs.).
--conflict-resolve, --conflict-loser, and --conflict-suffix do not apply during --resync, and unlike these flags, nothing is renamed during --resync. When a file differs on both sides during --resync, one version always overwrites the other (much like in rclone copy.) (Consider using --backup-dir to retain a backup of the losing version.)
Unlike for --conflict-resolve, --resync-mode none is not a valid option (or rather, it will be interpreted as "no resync", unless --resync has also been specified, in which case it will be ignored.)
Winners and losers are decided at the individual file-level only (there is not currently an option to pick an entire winning directory atomically, although the path1 and path2 options typically produce a similar result.)
To maintain backward-compatibility, the --resync flag implies --resync-mode path1 unless a different --resync-mode is explicitly specified. Similarly, all --resync-mode options (except none) imply --resync, so it is not necessary to use both the --resync and --resync-mode flags simultaneously -- either one is sufficient without the other.

--check-access

Access check files are an additional safety measure against data loss. bisync will ensure it can find matching RCLONE_TEST files in the same places in the Path1 and Path2 filesystems. RCLONE_TEST files are not generated automatically. For --check-access to succeed, you must first either: A) Place one or more RCLONE_TEST files in both systems, or B) Set --check-filename to a filename already in use in various locations throughout your sync'd fileset. Recommended methods for A) include:

rclone touch Path1/RCLONE_TEST (create a new file)
rclone copyto Path1/RCLONE_TEST Path2/RCLONE_TEST (copy an existing file)
rclone copy Path1/RCLONE_TEST Path2/RCLONE_TEST --include "RCLONE_TEST" (copy multiple files at once, recursively)
create the files manually (outside of rclone)
run bisync once without --check-access to set matching files on both filesystems will also work, but is not preferred, due to potential for user error (you are temporarily disabling the safety feature).

Note that --check-access is still enforced on --resync, so bisync --resync --check-access will not work as a method of initially setting the files (this is to ensure that bisync can't inadvertently circumvent its own safety switch.)

Time stamps and file contents for RCLONE_TEST files are not important, just the names and locations. If you have symbolic links in your sync tree it is recommended to place RCLONE_TEST files in the linked-to directory tree to protect against bisync assuming a bunch of deleted files if the linked-to tree should not be accessible. See also the --check-filename flag.

--check-filename

Name of the file(s) used in access health validation. The default --check-filename is RCLONE_TEST. One or more files having this filename must exist, synchronized between your source and destination filesets, in order for --check-access to succeed. See --check-access for additional details.

--compare

As of v1.66, bisync fully supports comparing based on any combination of size, modtime, and checksum (lifting the prior restriction on backends without modtime support.)

By default (without the --compare flag), bisync inherits the same comparison options as sync (that is: size and modtime by default, unless modified with flags such as --checksum or --size-only.)

If the --compare flag is set, it will override these defaults. This can be useful if you wish to compare based on combinations not currently supported in sync, such as comparing all three of size AND modtime AND checksum simultaneously (or just modtime AND checksum).

--compare takes a comma-separated list, with the currently supported values being size, modtime, and checksum. For example, if you want to compare size and checksum, but not modtime, you would do:

--compare size,checksum

Or if you want to compare all three:

--compare size,modtime,checksum

--compare overrides any conflicting flags. For example, if you set the conflicting flags --compare checksum --size-only, --size-only will be ignored, and bisync will compare checksum and not size. To avoid confusion, it is recommended to use either --compare or the normal sync flags, but not both.

If --compare includes checksum and both remotes support checksums but have no hash types in common with each other, checksums will be considered only for comparisons within the same side (to determine what has changed since the prior sync), but not for comparisons against the opposite side. If one side supports checksums and the other does not, checksums will only be considered on the side that supports them.

When comparing with checksum and/or size without modtime, bisync cannot determine whether a file is newer or older -- only whether it is changed or unchanged. (If it is changed on both sides, bisync still does the standard equality-check to avoid declaring a sync conflict unless it absolutely has to.)

It is recommended to do a --resync when changing --compare settings, as otherwise your prior listing files may not contain the attributes you wish to compare (for example, they will not have stored checksums if you were not previously comparing checksums.)

--ignore-listing-checksum

When --checksum or --compare checksum is set, bisync will retrieve (or generate) checksums (for backends that support them) when creating the listings for both paths, and store the checksums in the listing files. --ignore-listing-checksum will disable this behavior, which may speed things up considerably, especially on backends (such as local) where hashes must be computed on the fly instead of retrieved. Please note the following:

As of v1.66, --ignore-listing-checksum is now automatically set when neither --checksum nor --compare checksum are in use (as the checksums would not be used for anything.)
--ignore-listing-checksum is NOT the same as --ignore-checksum, and you may wish to use one or the other, or both. In a nutshell: --ignore-listing-checksum controls whether checksums are considered when scanning for diffs, while --ignore-checksum controls whether checksums are considered during the copy/sync operations that follow, if there ARE diffs.
Unless --ignore-listing-checksum is passed, bisync currently computes hashes for one path even when there's no common hash with the other path (for example, a crypt remote.) This can still be beneficial, as the hashes will still be used to detect changes within the same side (if --checksum or --compare checksum is set), even if they can't be used to compare against the opposite side.
If you wish to ignore listing checksums only on remotes where they are slow to compute, consider using --no-slow-hash (or --slow-hash-sync-only) instead of --ignore-listing-checksum.
If --ignore-listing-checksum is used simultaneously with --compare checksum (or --checksum), checksums will be ignored for bisync deltas, but still considered during the sync operations that follow (if deltas are detected based on modtime and/or size.)

--no-slow-hash

On some remotes (notably local), checksums can dramatically slow down a bisync run, because hashes cannot be stored and need to be computed in real-time when they are requested. On other remotes (such as drive), they add practically no time at all. The --no-slow-hash flag will automatically skip checksums on remotes where they are slow, while still comparing them on others (assuming --compare includes checksum.) This can be useful when one of your bisync paths is slow but you still want to check checksums on the other, for a more robust sync.

--slow-hash-sync-only

Same as --no-slow-hash, except slow hashes are still considered during sync calls. They are still NOT considered for determining deltas, nor or they included in listings. They are also skipped during --resync. The main use case for this flag is when you have a large number of files, but relatively few of them change from run to run -- so you don't want to check your entire tree every time (it would take too long), but you still want to consider checksums for the smaller group of files for which a modtime or size change was detected. Keep in mind that this speed savings comes with a safety trade-off: if a file's content were to change without a change to its modtime or size, bisync would not detect it, and it would not be synced.

--slow-hash-sync-only is only useful if both remotes share a common hash type (if they don't, bisync will automatically fall back to --no-slow-hash.) Both --no-slow-hash and --slow-hash-sync-only have no effect without --compare checksum (or --checksum).

--download-hash

If --download-hash is set, bisync will use best efforts to obtain an MD5 checksum by downloading and computing on-the-fly, when checksums are not otherwise available (for example, a remote that doesn't support them.) Note that since rclone has to download the entire file, this may dramatically slow down your bisync runs, and is also likely to use a lot of data, so it is probably not practical for bisync paths with a large total file size. However, it can be a good option for syncing small-but-important files with maximum accuracy (for example, a source code repo on a crypt remote.) An additional advantage over methods like cryptcheck is that the original file is not required for comparison (for example, --download-hash can be used to bisync two different crypt remotes with different passwords.)

When --download-hash is set, bisync still looks for more efficient checksums first, and falls back to downloading only when none are found. It takes priority over conflicting flags such as --no-slow-hash. --download-hash is not suitable for Google Docs and other files of unknown size, as their checksums would change from run to run (due to small variances in the internals of the generated export file.) Therefore, bisync automatically skips --download-hash for files with a size less than 0.

See also: Hasher backend, cryptcheck command, rclone check --download option, md5sum command

--max-delete

As a safety check, if greater than the --max-delete percent of files were deleted on either the Path1 or Path2 filesystem, then bisync will abort with a warning message, without making any changes. The default --max-delete is 50%. One way to trigger this limit is to rename a directory that contains more than half of your files. This will appear to bisync as a bunch of deleted files and a bunch of new files. This safety check is intended to block bisync from deleting all of the files on both filesystems due to a temporary network access issue, or if the user had inadvertently deleted the files on one side or the other. To force the sync, either set a different delete percentage limit, e.g. --max-delete 75 (allows up to 75% deletion), or use --force to bypass the check.

Also see the all files changed check.

--filters-file

By using rclone filter features you can exclude file types or directory sub-trees from the sync. See the bisync filters section and generic --filter-from documentation. An example filters file contains filters for non-allowed files for syncing with Dropbox.

If you make changes to your filters file then bisync requires a run with --resync. This is a safety feature, which prevents existing files on the Path1 and/or Path2 side from seeming to disappear from view (since they are excluded in the new listings), which would fool bisync into seeing them as deleted (as compared to the prior run listings), and then bisync would proceed to delete them for real.

To block this from happening, bisync calculates an MD5 hash of the filters file and stores the hash in a .md5 file in the same place as your filters file. On the next run with --filters-file set, bisync re-calculates the MD5 hash of the current filters file and compares it to the hash stored in the .md5 file. If they don't match, the run aborts with a critical error and thus forces you to do a --resync, likely avoiding a disaster.

--conflict-resolve CHOICE

In bisync, a "conflict" is a file that is new or changed on both sides (relative to the prior run) AND is not currently identical on both sides. --conflict-resolve controls how bisync handles such a scenario. The currently supported options are:

none - (the default) - do not attempt to pick a winner, keep and rename both files according to --conflict-loser and --conflict-suffix settings. For example, with the default settings, file.txt on Path1 is renamed file.txt.conflict1 and file.txt on Path2 is renamed file.txt.conflict2. Both are copied to the opposite path during the run, so both sides end up with a copy of both files. (As none is the default, it is not necessary to specify --conflict-resolve none -- you can just omit the flag.)
newer - the newer file (by modtime) is considered the winner and is copied without renaming. The older file (the "loser") is handled according to --conflict-loser and --conflict-suffix settings (either renamed or deleted.) For example, if file.txt on Path1 is newer than file.txt on Path2, the result on both sides (with other default settings) will be file.txt (winner from Path1) and file.txt.conflict1 (loser from Path2).
older - same as newer, except the older file is considered the winner, and the newer file is considered the loser.
larger - the larger file (by size) is considered the winner (regardless of modtime, if any).
smaller - the smaller file (by size) is considered the winner (regardless of modtime, if any).
path1 - the version from Path1 is unconditionally considered the winner (regardless of modtime and size, if any). This can be useful if one side is usually more trusted or up-to-date than the other.
path2 - same as path1, except the path2 version is considered the winner.

For all of the above options, note the following:

If either of the underlying remotes lacks support for the chosen method, it will be ignored and fall back to none. (For example, if --conflict-resolve newer is set, but one of the paths uses a remote that doesn't support modtime.)
If a winner can't be determined because the chosen method's attribute is missing or equal, it will be ignored and fall back to none. (For example, if --conflict-resolve newer is set, but the Path1 and Path2 modtimes are identical, even if the sizes may differ.)
If the file's content is currently identical on both sides, it is not considered a "conflict", even if new or changed on both sides since the prior sync. (For example, if you made a change on one side and then synced it to the other side by other means.) Therefore, none of the conflict resolution flags apply in this scenario.
The conflict resolution flags do not apply during a --resync, as there is no "prior run" to speak of (but see --resync-mode for similar options.)

--conflict-loser CHOICE

--conflict-loser determines what happens to the "loser" of a sync conflict (when --conflict-resolve determines a winner) or to both files (when there is no winner.) The currently supported options are:

num - (the default) - auto-number the conflicts by automatically appending the next available number to the --conflict-suffix, in chronological order. For example, with the default settings, the first conflict for file.txt will be renamed file.txt.conflict1. If file.txt.conflict1 already exists, file.txt.conflict2 will be used instead (etc., up to a maximum of 9223372036854775807 conflicts.)
pathname - rename the conflicts according to which side they came from, which was the default behavior prior to v1.66. For example, with --conflict-suffix path, file.txt from Path1 will be renamed file.txt.path1, and file.txt from Path2 will be renamed file.txt.path2. If two non-identical suffixes are provided (ex. --conflict-suffix cloud,local), the trailing digit is omitted. Importantly, note that with pathname, there is no auto-numbering beyond 2, so if file.txt.path2 somehow already exists, it will be overwritten. Using a dynamic date variable in your --conflict-suffix (see below) is one possible way to avoid this. Note also that conflicts-of-conflicts are possible, if the original conflict is not manually resolved -- for example, if for some reason you edited file.txt.path1 on both sides, and those edits were different, the result would be file.txt.path1.path1 and file.txt.path1.path2 (in addition to file.txt.path2.)
delete - keep the winner only and delete the loser, instead of renaming it. If a winner cannot be determined (see --conflict-resolve for details on how this could happen), delete is ignored and the default num is used instead (i.e. both versions are kept and renamed, and neither is deleted.) delete is inherently the most destructive option, so use it only with care.

For all of the above options, note that if a winner cannot be determined (see --conflict-resolve for details on how this could happen), or if --conflict-resolve is not in use, both files will be renamed.

--conflict-suffix STRING[,STRING]

--conflict-suffix controls the suffix that is appended when bisync renames a --conflict-loser (default: conflict). --conflict-suffix will accept either one string or two comma-separated strings to assign different suffixes to Path1 vs. Path2. This may be helpful later in identifying the source of the conflict. (For example, --conflict-suffix dropboxconflict,laptopconflict)

With --conflict-loser num, a number is always appended to the suffix. With --conflict-loser pathname, a number is appended only when one suffix is specified (or when two identical suffixes are specified.) i.e. with --conflict-loser pathname, all of the following would produce exactly the same result:

--conflict-suffix path
--conflict-suffix path,path
--conflict-suffix path1,path2

Suffixes may be as short as 1 character. By default, the suffix is appended after any other extensions (ex. file.jpg.conflict1), however, this can be changed with the --suffix-keep-extension flag (i.e. to instead result in file.conflict1.jpg).

--conflict-suffix supports several dynamic date variables when enclosed in curly braces as globs. This can be helpful to track the date and/or time that each conflict was handled by bisync. For example:

--conflict-suffix {DateOnly}-conflict
// result: myfile.txt.2006-01-02-conflict1

All of the formats described here (go Time.Layout constants) and here (go Time.Format examples) are supported, but take care to ensure that your chosen format does not use any characters that are illegal on your remotes (for example, macOS does not allow colons in filenames, and slashes are also best avoided as they are often interpreted as directory separators.) To address this particular issue, an additional {MacFriendlyTime} (or just {mac}) option is supported, which results in 2006-01-02 0304PM.

Note that --conflict-suffix is entirely separate from rclone's main --sufix flag. This is intentional, as users may wish to use both flags simultaneously, if also using --backup-dir.

Finally, note that the default in bisync prior to v1.66 was to rename conflicts with ..path1 and ..path2 (with two periods, and path instead of conflict.) Bisync now defaults to a single dot instead of a double dot, but additional dots can be added by including them in the specified suffix string. For example, for behavior equivalent to the previous default, use:

[--conflict-resolve none] --conflict-loser pathname --conflict-suffix .path

--check-sync

Enabled by default, the check-sync function checks that all of the same files exist in both the Path1 and Path2 history listings. This check-sync integrity check is performed at the end of the sync run by default. Any untrapped failing copy/deletes between the two paths might result in differences between the two listings and in the untracked file content differences between the two paths. A resync run would correct the error.

Note that the default-enabled integrity check locally executes a load of both the final Path1 and Path2 listings, and thus adds to the run time of a sync. Using --check-sync=false will disable it and may significantly reduce the sync run times for very large numbers of files.

The check may be run manually with --check-sync=only. It runs only the integrity check and terminates without actually syncing.

Note that currently, --check-sync only checks listing snapshots and NOT the actual files on the remotes. Note also that the listing snapshots will not know about any changes that happened during or after the latest bisync run, as those will be discovered on the next run. Therefore, while listings should always match each other at the end of a bisync run, it is expected that they will not match the underlying remotes, nor will the remotes match each other, if there were changes during or after the run. This is normal, and any differences will be detected and synced on the next run.

For a robust integrity check of the current state of the remotes (as opposed to just their listing snapshots), consider using check (or cryptcheck, if at least one path is a crypt remote) instead of --check-sync, keeping in mind that differences are expected if files changed during or after your last bisync run.

For example, a possible sequence could look like this:

Normally scheduled bisync run:

rclone bisync Path1 Path2 -MPc --check-access --max-delete 10 --filters-file /path/to/filters.txt -v --no-cleanup --ignore-listing-checksum --disable ListR --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient

Periodic independent integrity check (perhaps scheduled nightly or weekly):
```
rclone check -MvPc Path1 Path2 --filter-from /path/to/filters.txt
```
If diffs are found, you have some choices to correct them. If one side is more up-to-date and you want to make the other side match it, you could run:
```
rclone sync Path1 Path2 --filter-from /path/to/filters.txt --create-empty-src-dirs -MPc -v
```

(or switch Path1 and Path2 to make Path2 the source-of-truth)

Or, if neither side is totally up-to-date, you could run a --resync to bring them back into agreement (but remember that this could cause deleted files to re-appear.)

*Note also that rclone check does not currently include empty directories, so if you want to know if any empty directories are out of sync, consider alternatively running the above rclone sync command with --dry-run added.

--resilient

By default, most errors or interruptions will cause bisync to abort and require --resync to recover. This is a safety feature, to prevent bisync from running again until a user checks things out. However, in some cases, bisync can go too far and enforce a lockout when one isn't actually necessary, like for certain less-serious errors that might resolve themselves on the next run. When --resilient is specified, bisync tries its best to recover and self-correct, and only requires --resync as a last resort when a human's involvement is absolutely necessary. The intended use case is for running bisync as a background process (such as via scheduled cron).

When using --resilient mode, bisync will still report the error and abort, however it will not lock out future runs -- allowing the possibility of retrying at the next normally scheduled time, without requiring a --resync first. Examples of such retryable errors include access test failures, missing listing files, and filter change detections. These safety features will still prevent the current run from proceeding -- the difference is that if conditions have improved by the time of the next run, that next run will be allowed to proceed. Certain more serious errors will still enforce a --resync lockout, even in --resilient mode, to prevent data loss.

Behavior of --resilient may change in a future version. (See also: --recover, --max-lock, Graceful Shutdown)

--recover

If --recover is set, in the event of a sudden interruption or other un-graceful shutdown, bisync will attempt to automatically recover on the next run, instead of requiring --resync. Bisync is able to recover robustly by keeping one "backup" listing at all times, representing the state of both paths after the last known successful sync. Bisync can then compare the current state with this snapshot to determine which changes it needs to retry. Changes that were synced after this snapshot (during the run that was later interrupted) will appear to bisync as if they are "new or changed on both sides", but in most cases this is not a problem, as bisync will simply do its usual "equality check" and learn that no action needs to be taken on these files, since they are already identical on both sides.

In the rare event that a file is synced successfully during a run that later aborts, and then that same file changes AGAIN before the next run, bisync will think it is a sync conflict, and handle it accordingly. (From bisync's perspective, the file has changed on both sides since the last trusted sync, and the files on either side are not currently identical.) Therefore, --recover carries with it a slightly increased chance of having conflicts -- though in practice this is pretty rare, as the conditions required to cause it are quite specific. This risk can be reduced by using bisync's "Graceful Shutdown" mode (triggered by sending SIGINT or Ctrl+C), when you have the choice, instead of forcing a sudden termination.

--recover and --resilient are similar, but distinct -- the main difference is that --resilient is about retrying, while --recover is about recovering. Most users will probably want both. --resilient allows retrying when bisync has chosen to abort itself due to safety features such as failing --check-access or detecting a filter change. --resilient does not cover external interruptions such as a user shutting down their computer in the middle of a sync -- that is what --recover is for.

--max-lock

Bisync uses lock files as a safety feature to prevent interference from other bisync runs while it is running. Bisync normally removes these lock files at the end of a run, but if bisync is abruptly interrupted, these files will be left behind. By default, they will lock out all future runs, until the user has a chance to manually check things out and remove the lock. As an alternative, --max-lock can be used to make them automatically expire after a certain period of time, so that future runs are not locked out forever, and auto-recovery is possible. --max-lock can be any duration 2m or greater (or 0 to disable). If set, lock files older than this will be considered "expired", and future runs will be allowed to disregard them and proceed. (Note that the --max-lock duration must be set by the process that left the lock file -- not the later one interpreting it.)

If set, bisync will also "renew" these lock files every --max-lock minus one minute throughout a run, for extra safety. (For example, with --max-lock 5m, bisync would renew the lock file (for another 5 minutes) every 4 minutes until the run has completed.) In other words, it should not be possible for a lock file to pass its expiration time while the process that created it is still running -- and you can therefore be reasonably sure that any expired lock file you may find was left there by an interrupted run, not one that is still running and just taking awhile.

If a lock file exists but its contents are unreadable (for example, due to an incomplete write or disk error), it is treated as expired when --max-lock is set to a value greater than 0. If --max-lock is 0 or not set, an unreadable lock file will produce an error and block future runs until removed manually.

If --max-lock is 0 or not set, the default is that lock files will never expire, and will block future runs (of these same two bisync paths) indefinitely.

For maximum resilience from disruptions, consider setting a relatively short duration like --max-lock 2m along with --resilient and --recover, and a relatively frequent cron schedule. The result will be a very robust "set-it-and-forget-it" bisync run that can automatically bounce back from almost any interruption it might encounter, without requiring the user to get involved and run a --resync. (See also: Graceful Shutdown mode)

--backup-dir1 and --backup-dir2

As of v1.66, --backup-dir is supported in bisync. Because --backup-dir must be a non-overlapping path on the same remote, Bisync has introduced new --backup-dir1 and --backup-dir2 flags to support separate backup-dirs for Path1 and Path2 (bisyncing between different remotes with --backup-dir would not otherwise be possible.) --backup-dir1 and --backup-dir2 can use different remotes from each other, but --backup-dir1 must use the same remote as Path1, and --backup-dir2 must use the same remote as Path2. Each backup directory must not overlap its respective bisync Path without being excluded by a filter rule.

The standard --backup-dir will also work, if both paths use the same remote (but note that deleted files from both paths would be mixed together in the same dir). If either --backup-dir1 and --backup-dir2 are set, they will override --backup-dir.

Example:

rclone bisync /Users/someuser/some/local/path/Bisync gdrive:Bisync --backup-dir1 /Users/someuser/some/local/path/BackupDir --backup-dir2 gdrive:BackupDir --suffix -2023-08-26 --suffix-keep-extension --check-access --max-delete 10 --filters-file /Users/someuser/some/local/path/bisync_filters.txt --no-cleanup --ignore-listing-checksum --checkers=16 --drive-pacer-min-sleep=10ms --create-empty-src-dirs --resilient -MvP --drive-skip-gdocs --fix-case

In this example, if the user deletes a file in /Users/someuser/some/local/path/Bisync, bisync will propagate the delete to the other side by moving the corresponding file from gdrive:Bisync to gdrive:BackupDir. If the user deletes a file from gdrive:Bisync, bisync moves it from /Users/someuser/some/local/path/Bisync to /Users/someuser/some/local/path/BackupDir.

In the event of a rename due to a sync conflict, the rename is not considered a delete, unless a previous conflict with the same name already exists and would get overwritten.

Operation

Runtime flow details

bisync retains the listings of the Path1 and Path2 filesystems from the prior run. On each successive run it will:

list files on path1 and path2, and check for changes on each side. Changes include New, Newer, Older, and Deleted files.
Propagate changes on path1 to path2, and vice-versa.

Safety measures

Lock file prevents multiple simultaneous runs when taking a while. This can be particularly useful if bisync is run by cron scheduler.
Handle change conflicts non-destructively by creating .conflict1, .conflict2, etc. file versions, according to --conflict-resolve, --conflict-loser, and --conflict-suffix settings.
File system access health check using RCLONE_TEST files (see the --check-access flag).
Abort on excessive deletes - protects against a failed listing being interpreted as all the files were deleted. See the --max-delete and --force flags.
If something evil happens, bisync goes into a safe state to block damage by later runs. (See Error Handling)

Normal sync checks

Type	Description	Result	Implementation
Path2 new	File is new on Path2, does not exist on Path1	Path2 version survives	`rclone copy` Path2 to Path1
Path2 newer	File is newer on Path2, unchanged on Path1	Path2 version survives	`rclone copy` Path2 to Path1
Path2 deleted	File is deleted on Path2, unchanged on Path1	File is deleted	`rclone delete` Path1
Path1 new	File is new on Path1, does not exist on Path2	Path1 version survives	`rclone copy` Path1 to Path2
Path1 newer	File is newer on Path1, unchanged on Path2	Path1 version survives	`rclone copy` Path1 to Path2
Path1 older	File is older on Path1, unchanged on Path2	Path1 version survives	`rclone copy` Path1 to Path2
Path2 older	File is older on Path2, unchanged on Path1	Path2 version survives	`rclone copy` Path2 to Path1
Path1 deleted	File no longer exists on Path1	File is deleted	`rclone delete` Path2

Unusual sync checks

Type	Description	Result	Implementation
Path1 new/changed AND Path2 new/changed AND Path1 == Path2	File is new/changed on Path1 AND new/changed on Path2 AND Path1 version is currently identical to Path2	No change	None
Path1 new AND Path2 new	File is new on Path1 AND new on Path2 (and Path1 version is NOT identical to Path2)	Conflicts handled according to `--conflict-resolve` & `--conflict-loser` settings	default: `rclone copy` renamed `Path2.conflict2` file to Path1, `rclone copy` renamed `Path1.conflict1` file to Path2
Path2 newer AND Path1 changed	File is newer on Path2 AND also changed (newer/older/size) on Path1 (and Path1 version is NOT identical to Path2)	Conflicts handled according to `--conflict-resolve` & `--conflict-loser` settings	default: `rclone copy` renamed `Path2.conflict2` file to Path1, `rclone copy` renamed `Path1.conflict1` file to Path2
Path2 newer AND Path1 deleted	File is newer on Path2 AND also deleted on Path1	Path2 version survives	`rclone copy` Path2 to Path1
Path2 deleted AND Path1 changed	File is deleted on Path2 AND changed (newer/older/size) on Path1	Path1 version survives	`rclone copy` Path1 to Path2
Path1 deleted AND Path2 changed	File is deleted on Path1 AND changed (newer/older/size) on Path2	Path2 version survives	`rclone copy` Path2 to Path1

As of rclone v1.64, bisync is now better at detecting false positive sync conflicts, which would previously have resulted in unnecessary renames and duplicates. Now, when bisync comes to a file that it wants to rename (because it is new/changed on both sides), it first checks whether the Path1 and Path2 versions are currently identical (using the same underlying function as check.) If bisync concludes that the files are identical, it will skip them and move on. Otherwise, it will create renamed duplicates, as before. This behavior also improves the experience of renaming directories, as a --resync is no longer required, so long as the same change has been made on both sides.

All files changed check

If all prior existing files on either of the filesystems have changed (e.g. timestamps have changed due to changing the system's timezone) then bisync will abort without making any changes. Any new files are not considered for this check. You could use --force to force the sync (whichever side has the changed timestamp files wins). Alternately, a --resync may be used (Path1 versions will be pushed to Path2). Consider the situation carefully and perhaps use --dry-run before you commit to the changes.

Modification times

By default, bisync compares files by modification time and size. If you or your application should change the content of a file without changing the modification time and size, then bisync will not notice the change, and thus will not copy it to the other side. As an alternative, consider comparing by checksum (if your remotes support it). See --compare for details.

Error handling

Certain bisync critical errors, such as file copy/move failing, will result in a bisync lockout of following runs. The lockout is asserted because the sync status and history of the Path1 and Path2 filesystems cannot be trusted, so it is safer to block any further changes until someone checks things out. The recovery is to do a --resync again.

It is recommended to use --resync --dry-run --verbose initially and carefully review what changes will be made before running the --resync without --dry-run.

Most of these events come up due to an error status from an internal call. On such a critical error the {...}.path1.lst and {...}.path2.lst listing files are renamed to extension .lst-err, which blocks any future bisync runs (since the normal .lst files are not found). Bisync keeps them under bisync subdirectory of the rclone cache directory, typically at ${HOME}/.cache/rclone/bisync/ on Linux.

Some errors are considered temporary and re-running the bisync is not blocked. The critical return blocks further bisync runs.

Lock file

When bisync is running, a lock file is created in the bisync working directory, typically at ~/.cache/rclone/bisync/PATH1..PATH2.lck on Linux. If bisync should crash or hang, the lock file will remain in place and block any further runs of bisync for the same paths. Delete the lock file as part of debugging the situation. The lock file effectively blocks follow-on (e.g., scheduled by cron) runs when the prior invocation is taking a long time. The lock file contains PID of the blocking process, which may help in debug. Lock files can be set to automatically expire after a certain amount of time, using the --max-lock flag.

Note that while concurrent bisync runs are allowed, be very cautious that there is no overlap in the trees being synched between concurrent runs, lest there be replicated files, deleted files and general mayhem.

Exit codes

rclone bisync returns the following codes to calling program:

0 on a successful run,
1 for a non-critical failing run (a rerun may be successful),
2 on syntax or usage error,
7 for a critically aborted run (requires a --resync to recover).

See also the section about exit codes in main docs.

Graceful Shutdown

Bisync has a "Graceful Shutdown" mode which is activated by sending SIGINT or pressing Ctrl+C during a run. Once triggered, bisync will use best efforts to exit cleanly before the timer runs out. If bisync is in the middle of transferring files, it will attempt to cleanly empty its queue by finishing what it has started but not taking more. If it cannot do so within 30 seconds, it will cancel the in-progress transfers at that point and then give itself a maximum of 60 seconds to wrap up, save its state for next time, and exit. With the -vP flags you will see constant status updates and a final confirmation of whether or not the graceful shutdown was successful.

At any point during the "Graceful Shutdown" sequence, a second SIGINT or Ctrl+C will trigger an immediate, un-graceful exit, which will leave things in a messier state. Usually a robust recovery will still be possible if using --recover mode, otherwise you will need to do a --resync.

If you plan to use Graceful Shutdown mode, it is recommended to use --resilient and --recover, and it is important to NOT use --inplace, otherwise you risk leaving partially-written files on one side, which may be confused for real files on the next run. Note also that in the event of an abrupt interruption, a lock file will be left behind to block concurrent runs. You will need to delete it before you can proceed with the next run (or wait for it to expire on its own, if using --max-lock.)

Limitations

Supported backends

Bisync is integration-tested against all rclone backends to verify compatibility. Most backends (including all backends not listed below) are deemed fully supported with no known issues. Occasionally, however, these tests reveal issues with particular backends, usually related to a provider-specific limitation beyond rclone's control (for example, disallowed special characters and filename encodings.)

The following backends have known issues that need more investigation:

TestFilen (filen)
- TestBisyncRemoteRemote/resync_modes
- TestBisyncRemoteRemote/rmdirs
TestHuaweiDrive (huaweidrive)
TestSeafile (seafile)
- TestBisyncLocalRemote/rmdirs
Updated: 2026-06-05-010010

The following backends either have not been tested recently or have known issues that are deemed unfixable for the time being:

TestArchive (archive)
TestCache (cache)
TestDrime (drime)
TestFileLu (filelu)
TestFilesCom (filescom)
TestImageKit (imagekit)
TestJottacloud (jottacloud)
TestLinkbox (linkbox)
TestMailru (mailru)
TestMega (mega)
TestOpenDrive (opendrive)
TestOracleObjectStorage (oracleobjectstorage)
TestPikPak (pikpak)
TestPixeldrain (pixeldrain)
TestProtonDrive (protondrive)
TestPutio (putio)
TestQuatrix (quatrix)
TestS3GCS (s3)
- TestBisyncRemoteRemote/extended_filenames
TestS3Rclone (s3)
TestSFTPRsyncNet (sftp)
TestStorj (storj)
TestWebdavInfiniteScale (webdav)
TestWebdavNextcloud (webdav)
TestWebdavOwncloud (webdav)
TestnStorage (netstorage)

(more info)

The above lists are updated for each stable release of rclone. For test results updated nightly based on the latest beta, visit rclone's integration test status page.

Early beta versions of rclone bisync required both underlying backends to support modification times, and refused to run otherwise. This limitation has been lifted as of v1.66, as bisync now supports comparing checksum and/or size instead of (or in addition to) modtime. See --compare for details.

Concurrent modifications

When using Local, FTP or SFTP remotes with --inplace, rclone does not create temporary files at the destination when copying, and thus if the connection is lost the created file may be corrupt, which will likely propagate back to the original path on the next sync, resulting in data loss. It is therefore recommended to omit --inplace.

Files that change during a bisync run may result in data loss. Prior to rclone v1.66, this was commonly seen in highly dynamic environments, where the filesystem was getting hammered by running processes during the sync. As of rclone v1.66, bisync was redesigned to use a "snapshot" model, greatly reducing the risks from changes during a sync. Changes that are not detected during the current sync will now be detected during the following sync, and will no longer cause the entire run to throw a critical error. There is additionally a mechanism to mark files as needing to be internally rechecked next time, for added safety. It should therefore no longer be necessary to sync only at quiet times -- however, note that an error can still occur if a file happens to change at the exact moment it's being read/written by bisync (same as would happen in rclone sync.) (See also: --ignore-checksum, --local-no-check-updated)

Empty directories

By default, new/deleted empty directories on one path are not propagated to the other side. This is because bisync (and rclone) natively works on files, not directories. However, this can be changed with the --create-empty-src-dirs flag, which works in much the same way as in sync and copy. When used, empty directories created or deleted on one side will also be created or deleted on the other side. The following should be noted:

--create-empty-src-dirs is not compatible with --remove-empty-dirs. Use only one or the other (or neither).
It is not recommended to switch back and forth between --create-empty-src-dirs and the default (no --create-empty-src-dirs) without running -- resync. This is because it may appear as though all directories (not just the empty ones) were created/deleted, when actually you've just toggled between making them visible/invisible to bisync. It looks scarier than it is, but it's still probably best to stick to one or the other, and use --resync when you need to switch.

Renamed directories

By default, renaming a folder on the Path1 side results in deleting all files on the Path2 side and then copying all files again from Path1 to Path2. Bisync sees this as all files in the old directory name as deleted and all files in the new directory name as new.

A recommended solution is to use --track-renames, which is now supported in bisync as of rclone v1.66. Note that --track-renames is not available during --resync, as --resync does not delete anything (--track-renames only supports sync, not copy.)

Otherwise, the most effective and efficient method of renaming a directory is to rename it to the same name on both sides. (As of rclone v1.64, a --resync is no longer required after doing so, as bisync will automatically detect that Path1 and Path2 are in agreement.)

`--fast-list` used by default

Unlike most other rclone commands, bisync uses --fast-list by default, for backends that support it. In many cases this is desirable, however, there are some scenarios in which bisync could be faster without --fast-list, and there is also a known issue concerning Google Drive users with many empty directories. For now, the recommended way to avoid using --fast-list is to add --disable ListR to all bisync commands. The default behavior may change in a future version.

Case (and unicode) sensitivity

As of v1.66, case and unicode form differences no longer cause critical errors, and normalization (when comparing between filesystems) is handled according to the same flags and defaults as rclone sync. See the following options (all of which are supported by bisync) to control this behavior more granularly:

--fix-case
--ignore-case-sync
--no-unicode-normalization
--local-unicode-normalization and --local-case-sensitive (caution: these are normally not what you want.)

Note that in the (probably rare) event that --fix-case is used AND a file is new/changed on both sides AND the checksums match AND the filename case does not match, the Path1 filename is considered the winner, for the purposes of --fix-case (Path2 will be renamed to match it).

Windows support

Bisync has been tested on Windows 8.1, Windows 10 Pro 64-bit and on Windows GitHub runners.

Drive letters are allowed, including drive letters mapped to network drives (rclone bisync J:\localsync GDrive:). If a drive letter is omitted, the shell current drive is the default. Drive letters are a single character follows by :, so cloud names must be more than one character long.

Absolute paths (with or without a drive letter), and relative paths (with or without a drive letter) are supported.

Working directory is created at C:\Users\MyLogin\AppData\Local\rclone\bisync.

Note that bisync output may show a mix of forward / and back \ slashes.

Be careful of case independent directory and file naming on Windows vs. case dependent Linux

Filtering

See filtering documentation for how filter rules are written and interpreted.

Bisync's --filters-file flag slightly extends the rclone's --filter-from filtering mechanism. For a given bisync run you may provide only one --filters-file. The --include*, --exclude*, and --filter flags are also supported.

How to filter directories

Filtering portions of the directory tree is a critical feature for syncing.

Examples of directory trees (always beneath the Path1/Path2 root level) you may want to exclude from your sync:

Directory trees containing only software build intermediate files.
Directory trees containing application temporary files and data such as the Windows C:\Users\MyLogin\AppData\ tree.
Directory trees containing files that are large, less important, or are getting thrashed continuously by ongoing processes.

On the other hand, there may be only select directories that you actually want to sync, and exclude all others. See the Example include-style filters for Windows user directories below.

Filters file writing guidelines

Begin with excluding directory trees:
- e.g. - /AppData/
- ** on the end is not necessary. Once a given directory level is excluded then everything beneath it won't be looked at by rclone.
- Exclude such directories that are unneeded, are big, dynamically thrashed, or where there may be access permission issues.
- Excluding such dirs first will make rclone operations (much) faster.
- Specific files may also be excluded, as with the Dropbox exclusions example below.
Decide if it's easier (or cleaner) to:
- Include select directories and therefore exclude everything else -- or --
- Exclude select directories and therefore include everything else
Include select directories:
- Add lines like: + /Documents/PersonalFiles/** to select which directories to include in the sync.
- ** on the end specifies to include the full depth of the specified tree.
- With Include-style filters, files at the Path1/Path2 root are not included. They may be included with + /*.
- Place RCLONE_TEST files within these included directory trees. They will only be looked for in these directory trees.
- Finish by excluding everything else by adding - ** at the end of the filters file.
- Disregard step 4.
Exclude select directories:
- Add more lines like in step 1. For example: -/Desktop/tempfiles/, or - /testdir/. Again, a ** on the end is not necessary.
- Do not add a - ** in the file. Without this line, everything will be included that has not been explicitly excluded.
- Disregard step 3.

A few rules for the syntax of a filter file expanding on filtering documentation:

Lines may start with spaces and tabs - rclone strips leading whitespace.
If the first non-whitespace character is a # then the line is a comment and will be ignored.
Blank lines are ignored.
The first non-whitespace character on a filter line must be a + or -.
Exactly 1 space is allowed between the +/- and the path term.
Only forward slashes (/) are used in path terms, even on Windows.
The rest of the line is taken as the path term. Trailing whitespace is taken literally, and probably is an error.

Example include-style filters for Windows user directories

This Windows include-style example is based on the sync root (Path1) set to C:\Users\MyLogin. The strategy is to select specific directories to be synched with a network drive (Path2).

- /AppData/ excludes an entire tree of Windows stored stuff that need not be synched. In my case, AppData has >11 GB of stuff I don't care about, and there are some subdirectories beneath AppData that are not accessible to my user login, resulting in bisync critical aborts.
Windows creates cache files starting with both upper and lowercase NTUSER at C:\Users\MyLogin. These files may be dynamic, locked, and are generally don't care.
There are just a few directories with my data that I do want synched, in the form of + /<path>. By selecting only the directory trees I want to avoid the dozen plus directories that various apps make at C:\Users\MyLogin\Documents.
Include files in the root of the sync point, C:\Users\MyLogin, by adding the + /* line.
This is an Include-style filters file, therefore it ends with - ** which excludes everything not explicitly included.

- /AppData/
- NTUSER*
- ntuser*
+ /Documents/Family/**
+ /Documents/Sketchup/**
+ /Documents/Microcapture_Photo/**
+ /Documents/Microcapture_Video/**
+ /Desktop/**
+ /Pictures/**
+ /*
- **

Note also that Windows implements several "library" links such as C:\Users\MyLogin\My Documents\My Music pointing to C:\Users\MyLogin\Music. rclone sees these as links, so you must add --links to the bisync command line if you which to follow these links. I find that I get permission errors in trying to follow the links, so I don't include the rclone --links flag, but then you get lots of Can't follow symlink… noise from rclone about not following the links. This noise can be quashed by adding --quiet to the bisync command line.

Example exclude-style filters files for use with Dropbox

Dropbox disallows syncing the listed temporary and configuration/data files. The - <filename> filters exclude these files where ever they may occur in the sync tree. Consider adding similar exclusions for file types you don't need to sync, such as core dump and software build files.
bisync testing creates /testdir/ at the top level of the sync tree, and usually deletes the tree after the test. If a normal sync should run while the /testdir/ tree exists the --check-access phase may fail due to unbalanced RCLONE_TEST files. The - /testdir/ filter blocks this tree from being synched. You don't need this exclusion if you are not doing bisync development testing.
Everything else beneath the Path1/Path2 root will be synched.
RCLONE_TEST files may be placed anywhere within the tree, including the root.

Example filters file for Dropbox

# Filter file for use with bisync
# See https://rclone.org/filtering/ for filtering rules
# NOTICE: If you make changes to this file you MUST do a --resync run.
#         Run with --dry-run to see what changes will be made.

# Dropbox won't sync some files so filter them away here.
# See https://help.dropbox.com/installs-integrations/sync-uploads/files-not-syncing
- .dropbox.attr
- ~*.tmp
- ~$*
- .~*
- desktop.ini
- .dropbox

# Used for bisync testing, so excluded from normal runs
- /testdir/

# Other example filters
#- /TiBU/
#- /Photos/

How --check-access handles filters

At the start of a bisync run, listings are gathered for Path1 and Path2 while using the user's --filters-file. During the check access phase, bisync scans these listings for RCLONE_TEST files. Any RCLONE_TEST files hidden by the --filters-file are not in the listings and thus not checked during the check access phase.

Troubleshooting

Reading bisync logs

Here are two normal runs. The first one has a newer file on the remote. The second has no deltas between local and remote.

2021/05/16 00:24:38 INFO  : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/"
2021/05/16 00:24:38 INFO  : Path1 checking for diffs
2021/05/16 00:24:38 INFO  : - Path1    File is new                         - file.txt
2021/05/16 00:24:38 INFO  : Path1:    1 changes:    1 new,    0 newer,    0 older,    0 deleted
2021/05/16 00:24:38 INFO  : Path2 checking for diffs
2021/05/16 00:24:38 INFO  : Applying changes
2021/05/16 00:24:38 INFO  : - Path1    Queue copy to Path2                 - dropbox:/file.txt
2021/05/16 00:24:38 INFO  : - Path1    Do queued copies to                 - Path2
2021/05/16 00:24:38 INFO  : Updating listings
2021/05/16 00:24:38 INFO  : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/"
2021/05/16 00:24:38 INFO  : Bisync successful

2021/05/16 00:36:52 INFO  : Synching Path1 "/path/to/local/tree/" with Path2 "dropbox:/"
2021/05/16 00:36:52 INFO  : Path1 checking for diffs
2021/05/16 00:36:52 INFO  : Path2 checking for diffs
2021/05/16 00:36:52 INFO  : No changes found
2021/05/16 00:36:52 INFO  : Updating listings
2021/05/16 00:36:52 INFO  : Validating listings for Path1 "/path/to/local/tree/" vs Path2 "dropbox:/"
2021/05/16 00:36:52 INFO  : Bisync successful

Dry run oddity

The --dry-run messages may indicate that it would try to delete some files. For example, if a file is new on Path2 and does not exist on Path1 then it would normally be copied to Path1, but with --dry-run enabled those copies don't happen, which leads to the attempted delete on Path2, blocked again by --dry-run: ... Not deleting as --dry-run.

This whole confusing situation is an artifact of the --dry-run flag. Scrutinize the proposed deletes carefully, and if the files would have been copied to Path1 then the threatened deletes on Path2 may be disregarded.

Retries

Rclone has built-in retries. If you run with --verbose you'll see error and retry messages such as shown below. This is usually not a bug. If at the end of the run, you see Bisync successful and not Bisync critical error or Bisync aborted then the run was successful, and you can ignore the error messages.

The following run shows an intermittent fail. Lines 5 and 6 are low-level messages. Line 6 is a bubbled-up warning message, conveying the error. Rclone normally retries failing commands, so there may be numerous such messages in the log.

Since there are no final error/warning messages on line 7, rclone has recovered from failure after a retry, and the overall sync was successful.

1: 2021/05/14 00:44:12 INFO  : Synching Path1 "/path/to/local/tree" with Path2 "dropbox:"
2: 2021/05/14 00:44:12 INFO  : Path1 checking for diffs
3: 2021/05/14 00:44:12 INFO  : Path2 checking for diffs
4: 2021/05/14 00:44:12 INFO  : Path2:  113 changes:   22 new,    0 newer,    0 older,   91 deleted
5: 2021/05/14 00:44:12 ERROR : /path/to/local/tree/objects/af: error listing: unexpected end of JSON input
6: 2021/05/14 00:44:12 NOTICE: WARNING  listing try 1 failed.                 - dropbox:
7: 2021/05/14 00:44:12 INFO  : Bisync successful

This log shows a Critical failure which requires a --resync to recover from. See the Runtime Error Handling section.

2021/05/12 00:49:40 INFO  : Google drive root '': Waiting for checks to finish
2021/05/12 00:49:40 INFO  : Google drive root '': Waiting for transfers to finish
2021/05/12 00:49:40 INFO  : Google drive root '': not deleting files as there were IO errors
2021/05/12 00:49:40 ERROR : Attempt 3/3 failed with 3 errors and: not deleting files as there were IO errors
2021/05/12 00:49:40 ERROR : Failed to sync: not deleting files as there were IO errors
2021/05/12 00:49:40 NOTICE: WARNING  rclone sync try 3 failed.           - /path/to/local/tree/
2021/05/12 00:49:40 ERROR : Bisync aborted. Must run --resync to recover.

Denied downloads of "infected" or "abusive" files

Google Drive has a filter for certain file types (.exe, .apk, et cetera) that by default cannot be copied from Google Drive to the local filesystem. If you are having problems, run with --verbose to see specifically which files are generating complaints. If the error is This file has been identified as malware or spam and cannot be downloaded, consider using the flag --drive-acknowledge-abuse.

Google Docs (and other files of unknown size)

As of v1.66, Google Docs (including Google Sheets, Slides, etc.) are now supported in bisync, subject to the same options, defaults, and limitations as in rclone sync. When bisyncing drive with non-drive backends, the drive -> non-drive direction is controlled by --drive-export-formats (default "docx,xlsx,pptx,svg") and the non-drive -> drive direction is controlled by --drive-import-formats (default none.)

For example, with the default export/import formats, a Google Sheet on the drive side will be synced to an .xlsx file on the non-drive side. In the reverse direction, .xlsx files with filenames that match an existing Google Sheet will be synced to that Google Sheet, while .xlsx files that do NOT match an existing Google Sheet will be copied to drive as normal .xlsx files (without conversion to Sheets, although the Google Drive web browser UI may still give you the option to open it as one.)

If --drive-import-formats is set (it's not, by default), then all of the specified formats will be converted to Google Docs, if there is no existing Google Doc with a matching name. Caution: such conversion can be quite lossy, and in most cases it's probably not what you want!

To bisync Google Docs as URL shortcut links (in a manner similar to "Drive for Desktop"), use: --drive-export-formats url (or alternatives.)

Note that these link files cannot be edited on the non-drive side -- you will get errors if you try to sync an edited link file back to drive. They CAN be deleted (it will result in deleting the corresponding Google Doc.) If you create a .url file on the non-drive side that does not match an existing Google Doc, bisyncing it will just result in copying the literal .url file over to drive (no Google Doc will be created.) So, as a general rule of thumb, think of them as read-only placeholders on the non-drive side, and make all your changes on the drive side.

Likewise, even with other export-formats, it is best to only move/rename Google Docs on the drive side. This is because otherwise, bisync will interpret this as a file deleted and another created, and accordingly, it will delete the Google Doc and create a new file at the new path. (Whether or not that new file is a Google Doc depends on --drive-import-formats.)

Lastly, take note that all Google Docs on the drive side have a size of -1 and no checksum. Therefore, they cannot be reliably synced with the --checksum or --size-only flags. (To be exact: they will still get created/deleted, and bisync's delta engine will notice changes and queue them for syncing, but the underlying sync function will consider them identical and skip them.) To work around this, use the default (modtime and size) instead of --checksum or --size-only.

To ignore Google Docs entirely, use --drive-skip-gdocs.

Usage examples

Cron

Rclone does not yet have a built-in capability to monitor the local file system for changes and must be blindly run periodically. On Windows this can be done using a Task Scheduler, on Linux you can use Cron which is described below.

The 1st example runs a sync every 5 minutes between a local directory and an OwnCloud server, with output logged to a runlog file:

# Minute (0-59)
#      Hour (0-23)
#           Day of Month (1-31)
#                Month (1-12 or Jan-Dec)
#                     Day of Week (0-6 or Sun-Sat)
#                         Command
  */5  *    *    *    *   /path/to/rclone bisync /local/files MyCloud: --check-access --filters-file /path/to/bysync-filters.txt --log-file /path/to//bisync.log

See crontab syntax for the details of crontab time interval expressions.

If you run rclone bisync as a cron job, redirect stdout/stderr to a file. The 2nd example runs a sync to Dropbox every hour and logs all stdout (via the >>) and stderr (via 2>&1) to a log file.

0 * * * * /path/to/rclone bisync /path/to/local/dropbox Dropbox: --check-access --filters-file /home/user/filters.txt >> /path/to/logs/dropbox-run.log 2>&1

bisync can keep a local folder in sync with a cloud service, but what if you have some highly sensitive files to be synched?

Usage of a cloud service is for exchanging both routine and sensitive personal files between one's home network, one's personal notebook when on the road, and with one's work computer. The routine data is not sensitive. For the sensitive data, configure an rclone crypt remote to point to a subdirectory within the local disk tree that is bisync'd to Dropbox, and then set up an bisync for this local crypt directory to a directory outside of the main sync tree.

Linux server setup

/path/to/DBoxroot is the root of my local sync tree. There are numerous subdirectories.
/path/to/DBoxroot/crypt is the root subdirectory for files that are encrypted. This local directory target is setup as an rclone crypt remote named Dropcrypt:. See rclone.conf snippet below.
/path/to/my/unencrypted/files is the root of my sensitive files - not encrypted, not within the tree synched to Dropbox.
To sync my local unencrypted files with the encrypted Dropbox versions I manually run bisync /path/to/my/unencrypted/files DropCrypt:. This step could be bundled into a script to run before and after the full Dropbox tree sync in the last step, thus actively keeping the sensitive files in sync.
bisync /path/to/DBoxroot Dropbox: runs periodically via cron, keeping my full local sync tree in sync with Dropbox.

Windows notebook setup

The Dropbox client runs keeping the local tree C:\Users\MyLogin\Dropbox always in sync with Dropbox. I could have used rclone bisync instead.
A separate directory tree at C:\Users\MyLogin\Documents\DropLocal hosts the tree of unencrypted files/folders.
To sync my local unencrypted files with the encrypted Dropbox versions I manually run the following command: rclone bisync C:\Users\MyLogin\Documents\DropLocal Dropcrypt:.
The Dropbox client then syncs the changes with Dropbox.

rclone.conf snippet

[Dropbox]
type = dropbox
...

[Dropcrypt]
type = crypt
remote = /path/to/DBoxroot/crypt          # on the Linux server
remote = C:\Users\MyLogin\Dropbox\crypt   # on the Windows notebook
filename_encryption = standard
directory_name_encryption = true
password = ...
...

Testing

You should read this section only if you are developing for rclone. You need to have rclone source code locally to work with bisync tests.

Bisync has a dedicated test framework implemented in the bisync_test.go file located in the rclone source tree. The test suite is based on the go test command. Series of tests are stored in subdirectories below the cmd/bisync/testdata directory. Individual tests can be invoked by their directory name, e.g. go test . -case basic -remote local -remote2 gdrive: -v

Tests will make a temporary folder on remote and purge it afterwards. If during test run there are intermittent errors and rclone retries, these errors will be captured and flagged as invalid MISCOMPAREs. Rerunning the test will let it pass. Consider such failures as noise.

Test command syntax

usage: go test ./cmd/bisync [options...]

Options:
  -case NAME        Name(s) of the test case(s) to run. Multiple names should
                    be separated by commas. You can remove the `test_` prefix
                    and replace `_` by `-` in test name for convenience.
                    If not `all`, the name(s) should map to a directory under
                    `./cmd/bisync/testdata`.
                    Use `all` to run all tests (default: all)
  -remote PATH1     `local` or name of cloud service with `:` (default: local)
  -remote2 PATH2    `local` or name of cloud service with `:` (default: local)
  -no-compare       Disable comparing test results with the golden directory
                    (default: compare)
  -no-cleanup       Disable cleanup of Path1 and Path2 testdirs.
                    Useful for troubleshooting. (default: cleanup)
  -golden           Store results in the golden directory (default: false)
                    This flag can be used with multiple tests.
  -debug            Print debug messages
  -stop-at NUM      Stop test after given step number. (default: run to the end)
                    Implies `-no-compare` and `-no-cleanup`, if the test really
                    ends prematurely. Only meaningful for a single test case.
  -refresh-times    Force refreshing the target modtime, useful for Dropbox
                    (default: false)
  -verbose          Run tests verbosely

Note: unlike rclone flags which must be prefixed by double dash (--), the test command flags can be equally prefixed by a single - or double dash.

Running tests

go test . -case basic -remote local -remote2 local runs the test_basic test case using only the local filesystem, syncing one local directory with another local directory. Test script output is to the console, while commands within scenario.txt have their output sent to the .../workdir/test.log file, which is finally compared to the golden copy.
The first argument after go test should be a relative name of the directory containing bisync source code. If you run tests right from there, the argument will be . (current directory) as in most examples below. If you run bisync tests from the rclone source directory, the command should be go test ./cmd/bisync ....
The test engine will mangle rclone output to ensure comparability with golden listings and logs.
Test scenarios are located in ./cmd/bisync/testdata. The test -case argument should match the full name of a subdirectory under that directory. Every test subdirectory name on disk must start with test_, this prefix can be omitted on command line for brevity. Also, underscores in the name can be replaced by dashes for convenience.
go test . -remote local -remote2 local -case all runs all tests.
Path1 and Path2 may either be the keyword local or may be names of configured cloud services. go test . -remote gdrive: -remote2 dropbox: -case basic will run the test between these two services, without transferring any files to the local filesystem.
Test run stdout and stderr console output may be directed to a file, e.g. go test . -remote gdrive: -remote2 local -case all > runlog.txt 2>&1

Test execution flow

The base setup in the initial directory of the testcase is applied on the Path1 and Path2 filesystems (via rclone copy the initial directory to Path1, then rclone sync Path1 to Path2).
The commands in the scenario.txt file are applied, with output directed to the test.log file in the test working directory. Typically, the first actual command in the scenario.txt file is to do a --resync, which establishes the baseline {...}.path1.lst and {...}.path2.lst files in the test working directory (.../workdir/ relative to the temporary test directory). Various commands and listing snapshots are done within the test.
Finally, the contents of the test working directory are compared to the contents of the testcase's golden directory.

Notes about testing

Test cases are in individual directories beneath ./cmd/bisync/testdata. A command line reference to a test is understood to reference a directory beneath testdata. For example, go test ./cmd/bisync -case dry-run -remote gdrive: -remote2 local refers to the test case in ./cmd/bisync/testdata/test_dry_run.
The test working directory is located at .../workdir relative to a temporary test directory, usually under /tmp on Linux.
The local test sync tree is created at a temporary directory named like bisync.XXX under system temporary directory.
The remote test sync tree is located at a temporary directory under <remote:>/bisync.XXX/.
path1 and/or path2 subdirectories are created in a temporary directory under the respective local or cloud test remote.
By default, the Path1 and Path2 test dirs and workdir will be deleted after each test run. The -no-cleanup flag disables purging these directories when validating and debugging a given test. These directories will be flushed before running another test, independent of the -no-cleanup usage.
You will likely want to add - /testdir/ to your normal bisync --filters-file so that normal syncs do not attempt to sync the test temporary directories, which may have RCLONE_TEST miscompares in some testcases which would otherwise trip the --check-access system. The --check-access mechanism is hard-coded to ignore RCLONE_TEST files beneath bisync/testdata, so the test cases may reside on the synched tree even if there are check file mismatches in the test tree.
Some Dropbox tests can fail, notably printing the following message: src and dst identical but can't set mod time without deleting and re-uploading This is expected and happens due to the way Dropbox handles modification times. You should use the -refresh-times test flag to make up for this.
If Dropbox tests hit request limit for you and print error message too_many_requests/...: Too many requests or write operations. then follow the Dropbox App ID instructions.

Updating golden results

Sometimes even a slight change in the bisync source can cause little changes spread around many log files. Updating them manually would be a nightmare.

The -golden flag will store the test.log and *.lst listings from each test case into respective golden directories. Golden results will automatically contain generic strings instead of local or cloud paths which means that they should match when run with a different cloud service.

Your normal workflow might be as follows:

Git-clone the rclone sources locally
Modify bisync source and check that it builds
Run the whole test suite go test ./cmd/bisync -remote local
If some tests show log difference, recheck them individually, e.g.: go test ./cmd/bisync -remote local -case basic
If you are convinced with the difference, goldenize all tests at once: go test ./cmd/bisync -remote local -golden
Use word diff: git diff --word-diff ./cmd/bisync/testdata/. Please note that normal line-level diff is generally useless here.
Check the difference carefully!
Commit the change (git commit) only if you are sure. If unsure, save your code changes then wipe the log diffs from git: git reset [--hard].

Structure of test scenarios

<testname>/initial/ contains a tree of files that will be set as the initial condition on both Path1 and Path2 testdirs.
<testname>/modfiles/ contains files that will be used to modify the Path1 and/or Path2 filesystems.
<testname>/golden/ contains the expected content of the test working directory (workdir) at the completion of the testcase.
<testname>/scenario.txt contains the body of the test, in the form of various commands to modify files, run bisync, and snapshot listings. Output from these commands is captured to .../workdir/test.log for comparison to the golden files.

Supported test commands

test <some message> Print the line to the console and to the test.log: test sync is working correctly with options x, y, z
copy-listings <prefix> Save a copy of all .lst listings in the test working directory with the specified prefix: save-listings exclude-pass-run
move-listings <prefix> Similar to copy-listings but removes the source
purge-children <dir> This will delete all child files and purge all child subdirs under given directory but keep the parent intact. This behavior is important for tests with Google Drive because removing and re-creating the parent would change its ID.
delete-file <file> Delete a single file.
delete-glob <dir> <pattern> Delete a group of files located one level deep in the given directory with names matching a given glob pattern.
touch-glob YYYY-MM-DD <dir> <pattern> Change modification time on a group of files.
touch-copy YYYY-MM-DD <source-file> <dest-dir> Change file modification time then copy it to destination.
copy-file <source-file> <dest-dir> Copy a single file to given directory.
copy-as <source-file> <dest-file> Similar to above but destination must include both directory and the new file name at destination.
copy-dir <src> <dst> and sync-dir <src> <dst> Copy/sync a directory. Equivalent of rclone copy and rclone sync.
list-dirs <dir> Equivalent to rclone lsf -R --dirs-only <dir>
bisync [options] Runs bisync against -remote and -remote2.

Supported substitution terms

{testdir/} - the root dir of the testcase
{datadir/} - the modfiles dir under the testcase root
{workdir/} - the temporary test working directory
{path1/} - the root of the Path1 test directory tree
{path2/} - the root of the Path2 test directory tree
{session} - base name of the test listings
{/} - OS-specific path separator
{spc}, {tab}, {eol} - whitespace
{chr:HH} - raw byte with given hexadecimal code

Substitution results of the terms named like {dir/} will end with / (or backslash on Windows), so it is not necessary to include slash in the usage, for example delete-file {path1/}file1.txt.

Benchmarks

This section is work in progress.

Here are a few data points for scale, execution times, and memory usage.

The first set of data was taken between a local disk to Dropbox. The speedtest.net download speed was ~170 Mbps, and upload speed was ~10 Mbps. 500 files (~9.5 MB each) had been already synched. 50 files were added in a new directory, each ~9.5 MB, ~475 MB total.

Change	Operations and times	Overall run time
500 files synched (nothing to move)	1x listings for Path1 & Path2	1.5 sec
500 files synched with --check-access	1x listings for Path1 & Path2	1.5 sec
50 new files on remote	Queued 50 copies down: 27 sec	29 sec
Moved local dir	Queued 50 copies up: 410 sec, 50 deletes up: 9 sec	421 sec
Moved remote dir	Queued 50 copies down: 31 sec, 50 deletes down: <1 sec	33 sec
Delete local dir	Queued 50 deletes up: 9 sec	13 sec

This next data is from a user's application. They had ~400GB of data over 1.96 million files being sync'ed between a Windows local disk and some remote cloud. The file full path length was on average 35 characters (which factors into load time and RAM required).

Loading the prior listing into memory (1.96 million files, listing file size 140 MB) took ~30 sec and occupied about 1 GB of RAM.
Getting a fresh listing of the local file system (producing the 140 MB output file) took about XXX sec.
Getting a fresh listing of the remote file system (producing the 140 MB output file) took about XXX sec. The network download speed was measured at XXX Mb/s.
Once the prior and current Path1 and Path2 listings were loaded (a total of four to be loaded, two at a time), determining the deltas was pretty quick (a few seconds for this test case), and the transfer time for any files to be copied was dominated by the network bandwidth.

References

rclone's bisync implementation was derived from the rclonesync-V2 project, including documentation and test mechanisms, with @cjnaz's full support and encouragement.

rclone bisync is similar in nature to a range of other projects:

Bisync adopts the differential synchronization technique, which is based on keeping history of changes performed by both synchronizing sides. See the Dual Shadow Method section in Neil Fraser's article.

Also note a number of academic publications by Benjamin Pierce about Unison and synchronization in general.

Changelog

`v1.74.2`

Fixed an issue causing --conflict-loser pathname to produce unexpected behavior if using a non-default --conflict-resolve value.

`v1.74`

Added several missing rc parameters.
Optional rc parameters are now truly optional.
rc output now provides more structured information.

`v1.71`

bisync is now officially released from beta.
Fixed an issue causing hash type to be set incorrectly if path2 had slow hashes and --no-slow-hash or --slow-hash-sync-only was in use.
Fixed an issue causing errors when running concurrent bisync runs through the rc.

`v1.69.1`

Fixed an issue causing listings to not capture concurrent modifications under certain conditions

`v1.68`

Fixed an issue affecting backends that round modtimes to a lower precision.

`v1.67`

Added integration tests against all backends.

`v1.66`

Copies and deletes are now handled in one operation instead of two
--track-renames and --backup-dir are now supported
Partial uploads known issue on local/ftp/sftp has been resolved (unless using --inplace)
Final listings are now generated from sync results, to avoid needing to re-list
Bisync is now much more resilient to changes that happen during a bisync run, and far less prone to critical errors / undetected changes
Bisync is now capable of rolling a file listing back in cases of uncertainty, essentially marking the file as needing to be rechecked next time.
A few basic terminal colors are now supported, controllable with --color (AUTO|NEVER|ALWAYS)
Initial listing snapshots of Path1 and Path2 are now generated concurrently, using the same "march" infrastructure as check and sync, for performance improvements and less risk of error.
Fixed handling of unicode normalization and case insensitivity, support for --fix-case, --ignore-case-sync, --no-unicode-normalization
--resync is now much more efficient (especially for users of --create-empty-src-dirs)
Google Docs (and other files of unknown size) are now supported (with the same options as in sync)
Equality checks before a sync conflict rename now fall back to cryptcheck (when possible) or --download, instead of of --size-only, when check is not available.
Bisync no longer fails to find the correct listing file when configs are overridden with backend-specific flags.
Bisync now fully supports comparing based on any combination of size, modtime, and checksum, lifting the prior restriction on backends without modtime support.
Bisync now supports a "Graceful Shutdown" mode to cleanly cancel a run early without requiring --resync.
New --recover flag allows robust recovery in the event of interruptions, without requiring --resync.
A new --max-lock setting allows lock files to automatically renew and expire, for better automatic recovery when a run is interrupted.
Bisync now supports auto-resolving sync conflicts and customizing rename behavior with new --conflict-resolve, --conflict-loser, and --conflict-suffix flags.
A new --resync-mode flag allows more control over which version of a file gets kept during a --resync.
Bisync now supports --retries and --retries-sleep (when --resilient is set.)

`v1.64`

Fixed an issue causing dry runs to inadvertently commit filter changes
Fixed an issue causing --resync to erroneously delete empty folders and duplicate files unique to Path2
--check-access is now enforced during --resync, preventing data loss in certain user error scenarios
Fixed an issue causing bisync to consider more files than necessary due to overbroad filters during delete operations
Improved detection of false positive change conflicts (identical files are now left alone instead of renamed)
Added support for --create-empty-src-dirs
Added experimental --resilient mode to allow recovery from self-correctable errors
Added new --ignore-listing-checksum flag to distinguish from --ignore-checksum
Performance improvements for large remotes
Documentation and testing improvements

Box

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Box

Paths are specified as remote:path

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

The initial setup for Box involves getting a token from Box which you can do either in your browser, or with a config.json downloaded from Box to use JWT authentication. rclone config walks you through it.

Configuration

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

rclone config

This will guide you through an interactive setup process:

No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n
name> remote
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Box
   \ "box"
[snip]
Storage> box
Box App Client Id - leave blank normally.
client_id> 
Box App Client Secret - leave blank normally.
client_secret>
Box App config.json location
Leave blank normally.
Enter a string value. Press Enter for the default ("").
box_config_file>
Box App Primary Access Token
Leave blank normally.
Enter a string value. Press Enter for the default ("").
access_token>

Enter a string value. Press Enter for the default ("user").
Choose a number from below, or type in your own value
 1 / Rclone should act on behalf of a user
   \ "user"
 2 / Rclone should act on behalf of a service account
   \ "enterprise"
box_sub_type>
Remote config
Use web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.
y) Yes
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=XXXXXXXXXXXXXXXXXXXXXX
Log in and authorize rclone for access
Waiting for code...
Got code
Configuration complete.
Options:
- type: box
- client_id:
- client_secret:
- token: {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"XXX"}
Keep this "remote" remote?
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 without an internet-connected web browser available.

Note that rclone runs a webserver on your local machine to collect the token as returned from Box. This only runs from the moment it opens your browser to the moment you get back the verification code. This is on http://127.0.0.1:53682/ and this may require you to unblock it temporarily if you are running a host firewall.

Once configured you can then use rclone like this (replace remote with the name you gave your remote):

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
Configuration complete.
Options:
- type: box
- token: {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2017-07-08T23:40:08.059167677+01:00"}
Keep this "remote" remote?
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 web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.
y) Yes
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
Configuration complete.
Options:
- type: box
- token: {"access_token":"YYY","token_type":"bearer","refresh_token":"YYY","expiry":"2017-07-23T12:22:29.259137901+01:00"}
Keep this "remote" remote?
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y

Modification times and hashes

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

Box supports SHA1 type hashes, so you can use the --checksum flag.

Restricted filename characters

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

Character	Value	Replacement
\	0x5C	＼

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

Character	Value	Replacement
SP	0x20	␠

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

Transfers

For files above 50 MiB 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 8 MiB so increasing --transfers will increase memory use.

Deleting files

Depending on the enterprise settings for your user, the item will either be actually deleted from Box or moved to the trash.

Emptying the trash is supported via the rclone however cleanup command however this deletes every trashed file and folder individually so it may take a very long time. Emptying the trash via the WebUI does not have this limitation so it is advised to empty the trash via the WebUI.

Root folder ID

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

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

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

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

So if the folder you want rclone to use has a URL which looks like https://app.box.com/folder/11xxxxxxxxx8 in the browser, then you use 11xxxxxxxxx8 as the root_folder_id in the config.

Standard options

Here are the Standard options specific to box (Box).

--box-client-id

OAuth Client Id.

Leave blank normally.

Properties:

Config: client_id
Env Var: RCLONE_BOX_CLIENT_ID
Type: string
Required: false

--box-client-secret

OAuth Client Secret.

Leave blank normally.

Properties:

Config: client_secret
Env Var: RCLONE_BOX_CLIENT_SECRET
Type: string
Required: false

--box-box-config-file

Box App config.json location

Leave blank normally.

Leading ~ will be expanded in the file name as will environment variables such as ${RCLONE_CONFIG_DIR}.

Properties:

Config: box_config_file
Env Var: RCLONE_BOX_BOX_CONFIG_FILE
Type: string
Required: false

--box-config-credentials

Box App config.json contents.

Leave blank normally.

Properties:

Config: config_credentials
Env Var: RCLONE_BOX_CONFIG_CREDENTIALS
Type: string
Required: false

--box-access-token

Box App Primary Access Token

Leave blank normally.

Properties:

Config: access_token
Env Var: RCLONE_BOX_ACCESS_TOKEN
Type: string
Required: false

--box-box-sub-type

Properties:

Config: box_sub_type
Env Var: RCLONE_BOX_BOX_SUB_TYPE
Type: string
Default: "user"
Examples:
- "user"
  - Rclone should act on behalf of a user.
- "enterprise"
  - Rclone should act on behalf of a service account.

Advanced options

Here are the Advanced options specific to box (Box).

--box-token

OAuth Access Token as a JSON blob.

Properties:

Config: token
Env Var: RCLONE_BOX_TOKEN
Type: string
Required: false

--box-auth-url

Auth server URL.

Leave blank to use the provider defaults.

Properties:

Config: auth_url
Env Var: RCLONE_BOX_AUTH_URL
Type: string
Required: false

--box-token-url

Token server url.

Leave blank to use the provider defaults.

Properties:

Config: token_url
Env Var: RCLONE_BOX_TOKEN_URL
Type: string
Required: false

--box-client-credentials

Use client credentials OAuth flow.

This will use the OAUTH2 client Credentials Flow as described in RFC 6749.

Note that this option is NOT supported by all backends.

Properties:

Config: client_credentials
Env Var: RCLONE_BOX_CLIENT_CREDENTIALS
Type: bool
Default: false

--box-root-folder-id

Fill in for rclone to use a non root folder as its starting point.

Properties:

Config: root_folder_id
Env Var: RCLONE_BOX_ROOT_FOLDER_ID
Type: string
Default: "0"

--box-upload-cutoff

Cutoff for switching to multipart upload (>= 50 MiB).

Properties:

Config: upload_cutoff
Env Var: RCLONE_BOX_UPLOAD_CUTOFF
Type: SizeSuffix
Default: 50Mi

--box-commit-retries

Max number of times to try committing a multipart file.

Properties:

Config: commit_retries
Env Var: RCLONE_BOX_COMMIT_RETRIES
Type: int
Default: 100

--box-list-chunk

Size of listing chunk 1-1000.

Properties:

Config: list_chunk
Env Var: RCLONE_BOX_LIST_CHUNK
Type: int
Default: 1000

--box-owned-by

Only show items owned by the login (email address) passed in.

Properties:

Config: owned_by
Env Var: RCLONE_BOX_OWNED_BY
Type: string
Required: false

--box-impersonate

Impersonate this user ID when using a service account.

Setting this flag allows rclone, when using a JWT service account, to act on behalf of another user by setting the as-user header.

The user ID is the Box identifier for a user. User IDs can found for any user via the GET /users endpoint, which is only available to admins, or by calling the GET /users/me endpoint with an authenticated user session.

See: https://developer.box.com/guides/authentication/jwt/as-user/

Properties:

Config: impersonate
Env Var: RCLONE_BOX_IMPERSONATE
Type: string
Required: false

--box-encoding

The encoding for the backend.

See the encoding section in the overview for more info.

Properties:

Config: encoding
Env Var: RCLONE_BOX_ENCODING
Type: Encoding
Default: Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot

--box-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_BOX_DESCRIPTION
Type: string
Required: false

Limitations

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

Box file names can't have the \ character in. rclone maps this to and from an identical looking unicode equivalent ＼ (U+FF3C Fullwidth Reverse Solidus).

Box only supports filenames up to 255 characters in length.

Box has API rate limits that sometimes reduce the speed of rclone.

rclone about is not supported by the Box backend. Backends without this capability cannot determine free space for an rclone mount or use policy mfs (most free space) as a member of an rclone union remote.

See List of backends that do not support rclone about and rclone about.

Get your own Box App ID

Here is how to create your own Box App ID for rclone:

Go to the Box Developer Console and login, then click My Apps on the sidebar. Click Create New App and select Custom App.
In the first screen on the box that pops up, you can pretty much enter whatever you want. The App Name can be whatever. For Purpose choose automation to avoid having to fill out anything else. Click Next.
In the second screen of the creation screen, select User Authentication (OAuth 2.0). Then click Create App.
You should now be on the Configuration tab of your new app. If not, click on it at the top of the webpage. Copy down Client ID and Client Secret, you'll need those for rclone.
Under "OAuth 2.0 Redirect URI", add http://127.0.0.1:53682/
For Application Scopes, select Read all files and folders stored in Box and Write all files and folders stored in box (assuming you want to do both). Leave others unchecked. Click Save Changes at the top right.

Bugs

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Bugs and Limitations

Limitations

Directory timestamps aren't preserved on some backends

As of v1.66, rclone supports syncing directory modtimes, if the backend supports it. Some backends do not support it -- see overview for a complete list. Additionally, note that empty directories are not synced by default (this can be enabled with --create-empty-src-dirs.)

Rclone struggles with millions of files in a directory/bucket

Currently rclone loads each directory/bucket entirely into memory before using it. Since each rclone object takes 0.5k-1k of memory this can take a very long time and use a large amount of memory.

Millions of files in a directory tends to occur on bucket-based remotes (e.g. S3 buckets) since those remotes do not segregate subdirectories within the bucket.

Bucket-based remotes and folders

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

Some software creates empty keys ending in / as directory markers. Rclone doesn't do this as it potentially creates more objects and costs more. This ability may be added in the future (probably via a flag/option).

Bugs

Bugs are stored in rclone's GitHub project:

Cache

Nick Craig-Wood — Mon, 01 Jan 0001 00:00:00 UTC

Cache

The cache remote wraps another existing remote and stores file structure and its data for long running tasks like rclone mount.

It is deprecated so not recommended for use with new installations and may be removed at some point.

Status

The cache backend code is working but it currently doesn't have a maintainer so there are outstanding bugs which aren't getting fixed.

The cache backend is due to be phased out in favour of the VFS caching layer eventually which is more tightly integrated into rclone.

Until this happens we recommend only using the cache backend if you find you can't work without it. There are many docs online describing the use of the cache backend to minimize API hits and by-and-large these are out of date and the cache backend isn't needed in those scenarios any more.

Configuration

To get started you just need to have an existing remote which can be configured with cache.

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

rclone config

This will guide you through an interactive setup process:

No remotes found, make a new one?
n) New remote
r) Rename remote
c) Copy remote
s) Set configuration password
q) Quit config
n/r/c/s/q> n
name> test-cache
Type of storage to configure.
Choose a number from below, or type in your own value
[snip]
XX / Cache a remote
   \ "cache"
[snip]
Storage> cache
Remote to cache.
Normally should contain a ':' and a path, e.g. "myremote:path/to/dir",
"myremote:bucket" or maybe "myremote:" (not recommended).
remote> local:/test
Optional: The URL of the Plex server
plex_url> http://127.0.0.1:32400
Optional: The username of the Plex user
plex_username> dummyusername
Optional: The password of the Plex user
y) Yes type in my own password
g) Generate random password
n) No leave this optional password blank
y/g/n> y
Enter the password:
password:
Confirm the password:
password:
The size of a chunk. Lower value good for slow connections but can affect seamless reading.
Default: 5M
Choose a number from below, or type in your own value
 1 / 1 MiB
   \ "1M"
 2 / 5 MiB
   \ "5M"
 3 / 10 MiB
   \ "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 MiB
   \ "500M"
 2 / 1 GiB
   \ "1G"
 3 / 10 GiB
   \ "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:

An upload is started (usually by copying a file on the cache remote)
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)
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
Reading the file still works during the upload but most modifications on it will be prohibited
Once the move is complete the file is unlocked for modifications as it becomes as any other regular file
If the file is being read through cache when it's actually deleted from the temporary path then cache will simply swap the source to the cloud provider without interrupting the reading (small blip can happen though)

Files are uploaded in sequence and only one file is uploaded at a time. Uploads will be stored in a queue and be processed based on the order they were added. The queue and the temporary storage is persistent across restarts but can be cleared on startup with the --cache-db-purge flag.

Write Support

Writes are supported through cache. One caveat is that a mounted cache remote does not add any retry or fallback mechanism to the upload operation. This will depend on the implementation of the wrapped remote. Consider using Offline uploading for reliable writes.

One special case is covered with cache-writes which will cache the file data at the same time as the upload when it is enabled making it available from the cache store immediately once the upload is finished.

Read Features

Multiple connections

To counter the high latency between a local PC where rclone is running and cloud providers, the cache remote can split multiple requests to the cloud provider for smaller file chunks and combines them together locally where they can be available almost immediately before the reader usually needs them.

This is similar to buffering when media files are played online. Rclone will stay around the current marker but always try its best to stay ahead and prepare the data before.

Plex Integration

There is a direct integration with Plex which allows cache to detect during reading if the file is in playback or not. This helps cache to adapt how it queries the cloud provider depending on what is needed for.

Scans will have a minimum amount of workers (1) while in a confirmed playback cache will deploy the configured number of workers.

This integration opens the doorway to additional performance improvements which will be explored in the near future.

Note: If Plex options are not configured, cache will function with its configured options without adapting any of its settings.

How to enable? Run rclone config and add all the Plex options (endpoint, username and password) in your remote and it will be automatically enabled.

Affected settings:

cache-workers: Configured value during confirmed playback or 1 all the other times

Certificate Validation

When the Plex server is configured to only accept secure connections, it is possible to use .plex.direct URLs to ensure certificate validation succeeds. These URLs are used by Plex internally to connect to the Plex server securely.

The format for these URLs is the following:

https://ip-with-dots-replaced.server-hash.plex.direct:32400/

The ip-with-dots-replaced part can be any IPv4 address, where the dots have been replaced with dashes, e.g. 127.0.0.1 becomes 127-0-0-1.

To get the server-hash part, the easiest way is to visit

https://plex.tv/api/resources?includeHttps=1&X-Plex-Token=your-plex-token

This page will list all the available Plex servers for your account with at least one .plex.direct link for each. Copy one URL and replace the IP address with the desired address. This can be used as the plex_url value.

Known issues

Mount and --dir-cache-time

--dir-cache-time controls the first layer of directory caching which works at the mount layer. Being an independent caching mechanism from the cache backend, it will manage its own entries based on the configured time.

To avoid getting in a scenario where dir cache has obsolete data and cache would have the correct one, try to set --dir-cache-time to a lower time than --cache-info-age. Default values are already configured in this way.

Windows support - Experimental

There are a couple of issues with Windows mount functionality that still require some investigations. It should be considered as experimental thus far as fixes come in for this OS.

Most of the issues seem to be related to the difference between filesystems on Linux flavors and Windows as cache is heavily dependent on them.

Any reports or feedback on how cache behaves on this OS is greatly appreciated.

Risk of throttling

Future iterations of the cache backend will make use of the pooling functionality of the cloud provider to synchronize and at the same time make writing through it more tolerant to failures.

There are a couple of enhancements in track to add these but in the meantime there is a valid concern that the expiring cache listings can lead to cloud provider throttles or bans due to repeated queries on it for very large mounts.

Some recommendations:

don't use a very small interval for entry information (--cache-info-age)
while writes aren't yet optimised, you can still write through cache which gives you the advantage of adding the file in the cache at the same time if configured to do so.

Future enhancements:

cache and crypt

One common scenario is to keep your data encrypted in the cloud provider using the crypt remote. crypt uses a similar technique to wrap around an existing remote and handles this translation in a seamless way.

There is an issue with wrapping the remotes in this order: **cloud remote** -> **crypt** -> **cache**

During testing, I experienced a lot of bans with the remotes in this order. I suspect it might be related to how crypt opens files on the cloud provider which makes it think we're downloading the full file instead of small chunks. Organizing the remotes in this order yields better results: **cloud remote** -> **cache** -> **crypt**

absolute remote paths

cache can not differentiate between relative and absolute paths for the wrapped remote. Any path given in the remote config setting and on the command line will be passed to the wrapped remote as is, but for storing the chunks on disk the path will be made relative by removing any leading / character.

This behavior is irrelevant for most backend types, but there are backends where a leading / changes the effective directory, e.g. in the sftp backend paths starting with a / are relative to the root of the SSH server and paths without are relative to the user home directory. As a result sftp:bin and sftp:/bin will share the same cache folder, even if they represent a different directory on the SSH server.

Cache and Remote Control (--rc)

Cache supports the new --rc mode in rclone and can be remote controlled through the following end points: By default, the listener is disabled if you do not add the flag.

rc cache/expire

Purge a remote from the cache backend. Supports either a directory or a file. It supports both encrypted and unencrypted file names if cache is wrapped by crypt.

Params:

remote = path to remote (required)
withData = true/false to delete cached data (chunks) as well (optional, false by default)

Standard options

Here are the Standard options specific to cache (Cache a remote).

--cache-remote

Remote to cache.

Normally should contain a ':' and a path, e.g. "myremote:path/to/dir", "myremote:bucket" or maybe "myremote:" (not recommended).

Properties:

Config: remote
Env Var: RCLONE_CACHE_REMOTE
Type: string
Required: true

--cache-plex-url

The URL of the Plex server.

Properties:

Config: plex_url
Env Var: RCLONE_CACHE_PLEX_URL
Type: string
Required: false

--cache-plex-username

The username of the Plex user.

Properties:

Config: plex_username
Env Var: RCLONE_CACHE_PLEX_USERNAME
Type: string
Required: false

--cache-plex-password

The password of the Plex user.

NB Input to this must be obscured - see rclone obscure.

Properties:

Config: plex_password
Env Var: RCLONE_CACHE_PLEX_PASSWORD
Type: string
Required: false

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

Properties:

Config: chunk_size
Env Var: RCLONE_CACHE_CHUNK_SIZE
Type: SizeSuffix
Default: 5Mi
Examples:
- "1M"
  - 1 MiB
- "5M"
  - 5 MiB
- "10M"
  - 10 MiB

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

Properties:

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.

Properties:

Config: chunk_total_size
Env Var: RCLONE_CACHE_CHUNK_TOTAL_SIZE
Type: SizeSuffix
Default: 10Gi
Examples:
- "500M"
  - 500 MiB
- "1G"
  - 1 GiB
- "10G"
  - 10 GiB

Advanced options

Here are the Advanced options specific to cache (Cache a remote).

--cache-plex-token

The plex token for authentication - auto set normally.

Properties:

Config: plex_token
Env Var: RCLONE_CACHE_PLEX_TOKEN
Type: string
Required: false

--cache-plex-insecure

Skip all certificate verification when connecting to the Plex server.

Properties:

Config: plex_insecure
Env Var: RCLONE_CACHE_PLEX_INSECURE
Type: string
Required: false

--cache-db-path

Directory to store file structure metadata DB.

The remote name is used as the DB file name.

Properties:

Config: db_path
Env Var: RCLONE_CACHE_DB_PATH
Type: string
Default: "$HOME/.cache/rclone/cache-backend"

--cache-chunk-path

Directory to cache chunk files.

Path to where partial file data (chunks) are stored locally. The remote name is appended to the final path.

This config follows the "--cache-db-path". If you specify a custom location for "--cache-db-path" and don't specify one for "--cache-chunk-path" then "--cache-chunk-path" will use the same path as "--cache-db-path".

Properties:

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.

Properties:

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.

Properties:

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.

Properties:

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.

Properties:

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.

Properties:

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.

Properties:

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.

Properties:

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

Properties:

Config: tmp_upload_path
Env Var: RCLONE_CACHE_TMP_UPLOAD_PATH
Type: string
Required: false

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

Properties:

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.

Properties:

Config: db_wait_time
Env Var: RCLONE_CACHE_DB_WAIT_TIME
Type: Duration
Default: 1s

--cache-description

Description of the remote.

Properties:

Config: description
Env Var: RCLONE_CACHE_DESCRIPTION
Type: string
Required: false

Backend commands

Here are the commands specific to the cache backend.

Run them with:

rclone backend COMMAND remote:

The help below will explain what arguments each command takes.

See the backend command for more info on how to pass options and arguments.

These can be run on a running backend using the rc command backend/command.

stats

Print stats on the cache backend in JSON format.

rclone backend stats remote: [options] [<arguments>+]

Rclone on rclone - rsync for cloud storage

Sia

Sia

Introduction

Configuration

Standard options

--sia-api-url

--sia-api-password

Advanced options

--sia-user-agent

--sia-encoding

--sia-description

Limitations

1Fichier

1Fichier

Configuration

Modification times and hashes

Duplicated files

Restricted filename characters

Standard options

--fichier-api-key

Advanced options

--fichier-shared-folder

--fichier-file-password

--fichier-folder-password

--fichier-cdn

--fichier-encoding

--fichier-description

Limitations

Akamai Netstorage

Akamai NetStorage

Configuration

Example operations

See contents of a directory in your project

Sync the contents local with remote

Upload local content to remote

Delete content on remote

Move or copy content between CP codes

Features

Symlink Support

Implicit vs. Explicit Directories

--fast-list / ListR support

Purge

Standard options

--netstorage-host

--netstorage-account

--netstorage-secret

Advanced options

--netstorage-protocol

--netstorage-description

Backend commands

du

symlink

Alias

Alias

Configuration

Standard options

--alias-remote

Advanced options

--alias-description

Amazon Drive

Amazon Drive

Amazon S3

Amazon S3 Storage Providers

Configuration

Modification times and hashes

Modification times

Hashes

Reducing costs

Avoiding HEAD requests to read the modification time

Avoiding GET requests to read directory listings

Avoiding HEAD requests after PUT

Increasing performance

Using server-side copy

Increasing the rate of API requests

Data integrity

Single part uploads

Multipart uploads

Downloads

Further checking

`--fast-list` / ListR support

Important note about double slashes (`//`)