Amazon S3 Storage Providers
In CloudMount
Section titled “In CloudMount”- Choose your provider first in the wizard (AWS, Cloudflare R2, Wasabi, MinIO and many more). It sets the provider’s defaults and hides options that don’t apply.
- Folders are simulated: a folder exists while it holds files, and an empty one disappears.
- Renames copy and delete: S3 has no rename, so renaming a file copies it on the server and deletes the original, and renaming a folder does that for every file inside.
- Requests can cost money: browsing, thumbnails and searches all make requests that your provider may bill.
- Trash on Android works on drives rooted inside a bucket, not on ones that list buckets.
- Public links are pre-signed URLs, which expire after at most seven days.
- Version history: on a bucket with versioning turned on, CloudMount lists a file’s old versions and puts one back, over the file or as a copy beside it. A restore copies the old version over the file on the server, so the current content becomes a version itself and nothing is deleted. Providers that don’t keep versions list none. See Version history.
At a glance
Section titled “At a glance”| Capability | Support |
|---|---|
| rclone support tier | Tier 1: Core |
| Checksums | MD5 |
| Modification times | Kept, to 1 ns |
| Case-insensitive names | No |
| Duplicate names allowed | No |
| Server-side copy | Yes |
| Server-side move and rename | No |
| Folder move and rename | No: each file is moved in turn |
| Free space reporting | No |
| Empty folders | No: folders exist only while they hold files |
| Change notifications | No |
| Uploads of unknown size | Yes |
| Public links | Yes |
The S3 backend can be used with a number of different providers:
- AWS S3
- Alibaba Cloud (Aliyun) Object Storage System (OSS)
- Ceph
- China Mobile Ecloud Elastic Object Storage (EOS)
- Cloudflare R2
- Arvan Cloud Object Storage (AOS)
- Bizfly Cloud Simple Storage
- Cubbit DS3
- DigitalOcean Spaces
- Dreamhost
- Exaba
- Fastly Object Storage
- FileLu S5 (S3-Compatible Object Storage)
- GCS
- Hetzner
- Hitachi Content Platform (HCP)
- Huawei OBS
- IBM COS S3
- IDrive e2
- Impossible Cloud
- Intercolo Object Storage
- IONOS Cloud
- Leviia Object Storage
- Liara Object Storage
- Linode Object Storage
- Magalu Object Storage
- MEGA S4 Object Storage
- Minio
- Outscale
- OVHcloud
- Petabox
- Pure Storage FlashBlade
- Qiniu Cloud Object Storage (Kodo)
- Rabata Cloud Storage
- RackCorp Object Storage
- Rclone Serve S3
- Scaleway
- Scality (RING / ARTESCA)
- Seagate Lyve Cloud
- SeaweedFS
- Selectel
- Servercore Object Storage
- Spectra Logic
- Storj
- Synology C2 Object Storage
- Tencent Cloud Object Storage (COS)
- US3
- Wasabi
- Zadara Object Storage
- Zata
- Zero Services (ZERO-Z3)
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:bucketList the contents of a bucket
rclone ls remote:bucketSync /home/local/directory to the remote bucket, deleting any excess
files in the bucket.
rclone sync --interactive /home/local/directory remote:bucketSetup notes
Section titled “Setup notes”In CloudMount you add this drive from the Add drive screen, and the wizard asks for the options listed under Options. The notes below come from rclone’s setup guide.
Modification times and hashes
Section titled “Modification times and hashes”Modification times
Section titled “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
Section titled “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 | hexdumpor 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
Section titled “Reducing costs”Avoiding HEAD requests to read the modification time
Section titled “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
--updatealong 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
Section titled “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:bucketYou’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
Section titled “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
Section titled “Increasing performance”Using server-side copy
Section titled “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-bucketWhen 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
Section titled “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-bucketYou will need to experiment with these values to find the optimal settings for your setup.
Data integrity
Section titled “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
Section titled “Single part uploads”-
Rclone uploads single part uploads with a
Content-Md5using 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 theETagback 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
Section titled “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-Sha256and aContent-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
Section titled “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
Section titled “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
Section titled “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.txtRetrieve 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.txtClean 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.txtVersions naming caveat
Section titled “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.txtIf there are real files present with the same names as versions, then
behaviour of --s3-versions can be unpredictable.
Cleanup
Section titled “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
Section titled “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 (//)
Section titled “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
Section titled “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
Section titled “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
Section titled “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 = falsein the config file):access_key_idandsecret_access_keyare required.session_tokencan be optionally set when using AWS STS.
- Runtime configuration (
env_auth = truein the config file):- Export the following environment variables before running
rclone:- Access Key ID:
AWS_ACCESS_KEY_IDorAWS_ACCESS_KEY - Secret Access Key:
AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEY - Session Token:
AWS_SESSION_TOKEN(optional)
- Access Key ID:
- 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/credentialson unix based systems) file and the “default” profile, to change set these environment variables or config keys:AWS_SHARED_CREDENTIALS_FILEto control which file or theshared_credentials_fileconfig key.AWS_PROFILEto control which profile to use or theprofileconfig key.
- Or, run
rclonein an ECS task with an IAM role (AWS only). - Or, run
rcloneon an EC2 instance with an IAM role (AWS only). - Or, run
rclonein 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.
- Export the following environment variables before running
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)
Section titled “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-NAMErole_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 = s3provider = AWSenv_auth = trueregion = us-east-1role_arn = arn:aws:iam::123456789012:role/CrossAccountS3Rolerole_session_name = rclone-sessionrole_external_id = unique-role-external-id-12345In 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
CrossAccountS3Rolein account123456789012 - 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
Section titled “S3 Permissions”When using the sync subcommand of rclone the following minimum
permissions are required to be available on the bucket being written to:
ListBucketDeleteObjectGetObjectPutObjectPutObjectACLCreateBucket(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_NAMEhas 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)
Section titled “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
Section titled “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/fileIn 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
Section titled “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
Section titled “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 like365d,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` 365dCopying Object Lock settings from source
Section titled “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` copyYou 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` copyAdditional Object Lock options
Section titled “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 withrclone 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)
Options
Section titled “Options”Standard options
Section titled “Standard options”The wizard asks for these when you add the drive.
provider
Section titled “provider”Choose your S3 provider.
Type: string
Choices:
AWS: Amazon Web Services (AWS) S3Alibaba: Alibaba Cloud Object Storage System (OSS) formerly AliyunArvanCloud: Arvan Cloud Object Storage (AOS)BizflyCloud: Bizfly Cloud Simple StorageCeph: Ceph Object StorageChinaMobile: China Mobile Ecloud Elastic Object Storage (EOS)Cloudflare: Cloudflare R2 StorageCubbit: Cubbit DS3 Object StorageDigitalOcean: DigitalOcean SpacesDreamhost: Dreamhost DreamObjectsExaba: Exaba Object StorageFastly: Fastly Object StorageFileLu: FileLu S5 (S3-Compatible Object Storage)FlashBlade: Pure Storage FlashBlade Object StorageGCS: Google Cloud StorageHCP: Hitachi Content Platform (HCP)Hetzner: Hetzner Object StorageHuaweiOBS: Huawei Object Storage ServiceIBMCOS: IBM COS S3IDrive: IDrive e2ImpossibleCloud: Impossible Cloud Object StorageIntercolo: Intercolo Object StorageIONOS: IONOS CloudLeviia: Leviia Object StorageLiara: Liara Object StorageLinode: Linode Object StorageLyveCloud: Seagate Lyve CloudMagalu: Magalu Object StorageMega: MEGA S4 Object StorageMinio: Minio Object StorageNetease: Netease Object Storage (NOS)Outscale: OUTSCALE Object Storage (OOS)OVHcloud: OVHcloud Object StoragePetabox: Petabox Object StorageQiniu: Qiniu Object Storage (Kodo)Rabata: Rabata Cloud StorageRackCorp: RackCorp Object StorageRclone: Rclone S3 ServerScaleway: Scaleway Object StorageScality: Scality (RING / ARTESCA)SeaweedFS: SeaweedFS S3Selectel: Selectel Object StorageServercore: Servercore Object StorageSpectraLogic: Spectra Logic Black PearlStorj: Storj (S3 Compatible Gateway)Synology: Synology C2 Object StorageTencentCOS: Tencent Cloud Object Storage (COS)US3: US3 Object StorageWasabi: Wasabi Object StorageZadara: Zadara Object StorageZata: Zata (S3 compatible Gateway)ZeroServices: Zero Services GmbH (ZERO-Z3)Other: Any other S3 compatible provider
env_auth
Section titled “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.
Type: bool · Default: false
Choices:
false: Enter AWS credentials in the next step.true: Get AWS credentials from the environment (env vars or IAM).
access_key_id
Section titled “access_key_id”AWS Access Key ID.
Leave blank for anonymous access or runtime credentials.
Type: string
secret_access_key
Section titled “secret_access_key”AWS Secret Access Key (password).
Leave blank for anonymous access or runtime credentials.
Type: string
region
Section titled “region”Region to connect to.
Leave blank if you are using an S3 clone and you don’t have a region.
Type: string
Only for providers: 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, Scality, SeaweedFS, Selectel, Servercore, Synology, Wasabi, Zadara, Zata, ZeroServices, Other
Choices:
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: AWSus-east-2: US East (Ohio) Region. Needs location constraint us-east-2. Provider: AWSus-west-1: US West (Northern California) Region. Needs location constraint us-west-1. Provider: AWSus-west-2: US West (Oregon) Region. Needs location constraint us-west-2. Provider: AWSca-central-1: Canada (Central) Region. Needs location constraint ca-central-1. Provider: AWSeu-west-1: EU (Ireland) Region. Needs location constraint EU or eu-west-1. Provider: AWSeu-west-2: EU (London) Region. Needs location constraint eu-west-2. Provider: AWSeu-west-3: EU (Paris) Region. Needs location constraint eu-west-3. Provider: AWSeu-north-1: EU (Stockholm) Region. Needs location constraint eu-north-1. Provider: AWSeu-south-1: EU (Milan) Region. Needs location constraint eu-south-1. Provider: AWSeu-central-1: EU (Frankfurt) Region. Needs location constraint eu-central-1. Provider: AWSap-southeast-1: Asia Pacific (Singapore) Region. Needs location constraint ap-southeast-1. Provider: AWSap-southeast-2: Asia Pacific (Sydney) Region. Needs location constraint ap-southeast-2. Provider: AWSap-northeast-1: Asia Pacific (Tokyo) Region. Needs location constraint ap-northeast-1. Provider: AWSap-northeast-2: Asia Pacific (Seoul). Needs location constraint ap-northeast-2. Provider: AWSap-northeast-3: Asia Pacific (Osaka-Local). Needs location constraint ap-northeast-3. Provider: AWSap-south-1: Asia Pacific (Mumbai). Needs location constraint ap-south-1. Provider: AWSap-east-1: Asia Pacific (Hong Kong) Region. Needs location constraint ap-east-1. Provider: AWSsa-east-1: South America (Sao Paulo) Region. Needs location constraint sa-east-1. Provider: AWSil-central-1: Israel (Tel Aviv) Region. Needs location constraint il-central-1. Provider: AWSme-south-1: Middle East (Bahrain) Region. Needs location constraint me-south-1. Provider: AWSaf-south-1: Africa (Cape Town) Region. Needs location constraint af-south-1. Provider: AWScn-north-1: China (Beijing) Region. Needs location constraint cn-north-1. Provider: AWScn-northwest-1: China (Ningxia) Region. Needs location constraint cn-northwest-1. Provider: AWSus-gov-east-1: AWS GovCloud (US-East) Region. Needs location constraint us-gov-east-1. Provider: AWSus-gov-west-1: AWS GovCloud (US) Region. Needs location constraint us-gov-west-1. Provider: AWShn: Ha Noi Provider: BizflyCloudhcm: Ho Chi Minh Provider: BizflyCloud(empty): Use this if unsure. Will use v4 signatures and an empty region. Provider: Ceph,DigitalOcean,Dreamhost,Exaba,GCS,HCP,IBMCOS,Leviia,LyveCloud,Minio,Netease,Scality,SeaweedFS,Wasabi,Otherother-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,Scality,SeaweedFS,Wasabi,Otherauto: R2 buckets are automatically distributed across Cloudflare’s data centers for low latency. Provider: Cloudflareeu-west-1: Europe West Provider: Cubbitau-east-1: AU East 1 Provider: Fastlyeu-central: EU Central Provider: Fastlyeu-south-1: EU South 1 Provider: Fastlyeu-west-1: EU West 1 Provider: Fastlyjp-central-1: JP Central 1 Provider: Fastlyuk-east-1: UK East 1 Provider: Fastlyus-central-1: US Central 1 Provider: Fastlyus-east: US East Provider: Fastlyus-east-1: US East 1 Provider: Fastlyus-west: US West Provider: Fastlyus-west-1: US West 1 Provider: Fastlyglobal: Global Provider: FileLuus-east: North America (US-East) Provider: FileLueu-central: Europe (EU-Central) Provider: FileLuap-southeast: Asia Pacific (AP-Southeast) Provider: FileLume-central: Middle East (ME-Central) Provider: FileLuhel1: Helsinki Provider: Hetznerfsn1: Falkenstein Provider: Hetznernbg1: Nuremberg Provider: Hetzneraf-south-1: AF-Johannesburg Provider: HuaweiOBSap-southeast-2: AP-Bangkok Provider: HuaweiOBSap-southeast-3: AP-Singapore Provider: HuaweiOBScn-east-3: CN East-Shanghai1 Provider: HuaweiOBScn-east-2: CN East-Shanghai2 Provider: HuaweiOBScn-north-1: CN North-Beijing1 Provider: HuaweiOBScn-north-4: CN North-Beijing4 Provider: HuaweiOBScn-south-1: CN South-Guangzhou Provider: HuaweiOBSap-southeast-1: CN-Hong Kong Provider: HuaweiOBSsa-argentina-1: LA-Buenos Aires1 Provider: HuaweiOBSsa-peru-1: LA-Lima1 Provider: HuaweiOBSna-mexico-1: LA-Mexico City1 Provider: HuaweiOBSsa-chile-1: LA-Santiago2 Provider: HuaweiOBSsa-brazil-1: LA-Sao Paulo1 Provider: HuaweiOBSru-northwest-2: RU-Moscow2 Provider: HuaweiOBSeu-central-2: Frankfurt, Germany Provider: ImpossibleCloudeu-west-1: Amsterdam, Netherlands Provider: ImpossibleCloudeu-west-2: London, UK Provider: ImpossibleCloudeu-west-3: Paris, France Provider: ImpossibleCloudeu-east-1: Poznań, Poland Provider: ImpossibleCloudeu-north-1: Copenhagen, Denmark Provider: ImpossibleCloudus-east-1: New York, USA Provider: ImpossibleCloudde-fra: Frankfurt, Germany Provider: Intercolode: Frankfurt, Germany Provider: IONOS,OVHcloudeu-central-2: Berlin, Germany Provider: IONOSeu-central-3: Berlin, Germany Provider: IONOSeu-central-4: Frankfurt, Germany Provider: IONOSeu-south-2: Logrono, Spain Provider: IONOSus-central-1: Lenexa, USA Provider: IONOSeu-west-2: Paris, France Provider: Outscaleus-east-2: New Jersey, USA Provider: Outscaleus-west-1: California, USA Provider: Outscalecloudgouv-eu-west-1: SecNumCloud, Paris, France Provider: Outscaleap-northeast-1: Tokyo, Japan Provider: Outscalegra: Gravelines, France Provider: OVHcloudrbx: Roubaix, France Provider: OVHcloudsbg: Strasbourg, France Provider: OVHcloudeu-west-par: Paris, France (3AZ) Provider: OVHclouduk: London, United Kingdom Provider: OVHcloudwaw: Warsaw, Poland Provider: OVHcloudbhs: Beauharnois, Canada Provider: OVHcloudca-east-tor: Toronto, Canada Provider: OVHcloudsgp: Singapore Provider: OVHcloudap-southeast-syd: Sydney, Australia Provider: OVHcloudap-south-mum: Mumbai, India Provider: OVHcloudus-east-va: Vint Hill, Virginia, USA Provider: OVHcloudus-west-or: Hillsboro, Oregon, USA Provider: OVHcloudrbx-archive: Roubaix, France (Cold Archive) Provider: OVHcloudus-east-1: US East (N. Virginia) Provider: Petabox,Rabataeu-central-1: Europe (Frankfurt) Provider: Petaboxap-southeast-1: Asia Pacific (Singapore) Provider: Petaboxme-south-1: Middle East (Bahrain) Provider: Petaboxsa-east-1: South America (São Paulo) Provider: Petaboxcn-east-1: The default endpoint - a good choice if you are unsure. East China Region 1. Needs location constraint cn-east-1. Provider: Qiniucn-east-2: East China Region 2. Needs location constraint cn-east-2. Provider: Qiniucn-north-1: North China Region 1. Needs location constraint cn-north-1. Provider: Qiniucn-south-1: South China Region 1. Needs location constraint cn-south-1. Provider: Qiniuus-north-1: North America Region. Needs location constraint us-north-1. Provider: Qiniuap-southeast-1: Southeast Asia Region 1. Needs location constraint ap-southeast-1. Provider: Qiniuap-northeast-1: Northeast Asia Region 1. Needs location constraint ap-northeast-1. Provider: Qiniueu-west-1: EU (Ireland) Provider: Rabataeu-west-2: EU (London) Provider: Rabataglobal: Global CDN (All locations) Region Provider: RackCorpau: Australia (All states) Provider: RackCorpau-nsw: NSW (Australia) Region Provider: RackCorpau-qld: QLD (Australia) Region Provider: RackCorpau-vic: VIC (Australia) Region Provider: RackCorpau-wa: Perth (Australia) Region Provider: RackCorpph: Manila (Philippines) Region Provider: RackCorpth: Bangkok (Thailand) Region Provider: RackCorphk: HK (Hong Kong) Region Provider: RackCorpmn: Ulaanbaatar (Mongolia) Region Provider: RackCorpkg: Bishkek (Kyrgyzstan) Region Provider: RackCorpid: Jakarta (Indonesia) Region Provider: RackCorpjp: Tokyo (Japan) Region Provider: RackCorpsg: SG (Singapore) Region Provider: RackCorpde: Frankfurt (Germany) Region Provider: RackCorpus: USA (AnyCast) Region Provider: RackCorpus-east-1: New York (USA) Region Provider: RackCorpus-west-1: Freemont (USA) Region Provider: RackCorpnz: Auckland (New Zealand) Region Provider: RackCorpnl-ams: Amsterdam, The Netherlands Provider: Scalewayfr-par: Paris, France Provider: Scalewaypl-waw: Warsaw, Poland Provider: Scalewayru-1: St. Petersburg Provider: Selectel,Servercoreru-3: St. Petersburg Provider: Selectelru-7: Moscow Provider: Selectel,Servercoregis-1: Moscow Provider: Selectel,Servercorekz-1: Kazakhstan Provider: Selecteluz-2: Uzbekistan Provider: Selecteluz-2: Tashkent, Uzbekistan Provider: Servercorekz-1: Almaty, Kazakhstan Provider: Servercoreeu-001: Europe Region 1 Provider: Synologyeu-002: Europe Region 2 Provider: Synologyus-001: US Region 1 Provider: Synologyus-002: US Region 2 Provider: Synologytw-001: Asia (Taiwan) Provider: Synologyus-east-1: The default region. Leave location constraint empty. Provider: Zadaraus-east-1: Indore, Madhya Pradesh, India Provider: Zatazero-fra1: Frankfurt 1 Provider: ZeroServiceszero-fra2: Frankfurt 2 Provider: ZeroServiceszero-eyl1: Eyl 1 Provider: ZeroServices
endpoint
Section titled “endpoint”Endpoint for S3 API.
Required when using an S3 clone.
Type: string
Only for providers: 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, Scality, SeaweedFS, Selectel, Servercore, SpectraLogic, Storj, Synology, TencentCOS, US3, Wasabi, Zadara, Zata, ZeroServices, Other
Choices:
oss-accelerate.aliyuncs.com: Global Accelerate Provider: Alibabaoss-accelerate-overseas.aliyuncs.com: Global Accelerate (outside mainland China) Provider: Alibabaoss-cn-hangzhou.aliyuncs.com: East China 1 (Hangzhou) Provider: Alibabaoss-cn-shanghai.aliyuncs.com: East China 2 (Shanghai) Provider: Alibabaoss-cn-qingdao.aliyuncs.com: North China 1 (Qingdao) Provider: Alibabaoss-cn-beijing.aliyuncs.com: North China 2 (Beijing) Provider: Alibabaoss-cn-zhangjiakou.aliyuncs.com: North China 3 (Zhangjiakou) Provider: Alibabaoss-cn-huhehaote.aliyuncs.com: North China 5 (Hohhot) Provider: Alibabaoss-cn-wulanchabu.aliyuncs.com: North China 6 (Ulanqab) Provider: Alibabaoss-cn-shenzhen.aliyuncs.com: South China 1 (Shenzhen) Provider: Alibabaoss-cn-heyuan.aliyuncs.com: South China 2 (Heyuan) Provider: Alibabaoss-cn-guangzhou.aliyuncs.com: South China 3 (Guangzhou) Provider: Alibabaoss-cn-chengdu.aliyuncs.com: West China 1 (Chengdu) Provider: Alibabaoss-cn-hongkong.aliyuncs.com: Hong Kong (Hong Kong) Provider: Alibabaoss-us-west-1.aliyuncs.com: US West 1 (Silicon Valley) Provider: Alibabaoss-us-east-1.aliyuncs.com: US East 1 (Virginia) Provider: Alibabaoss-ap-southeast-1.aliyuncs.com: Southeast Asia Southeast 1 (Singapore) Provider: Alibabaoss-ap-southeast-2.aliyuncs.com: Asia Pacific Southeast 2 (Sydney) Provider: Alibabaoss-ap-southeast-3.aliyuncs.com: Southeast Asia Southeast 3 (Kuala Lumpur) Provider: Alibabaoss-ap-southeast-5.aliyuncs.com: Asia Pacific Southeast 5 (Jakarta) Provider: Alibabaoss-ap-northeast-1.aliyuncs.com: Asia Pacific Northeast 1 (Japan) Provider: Alibabaoss-ap-south-1.aliyuncs.com: Asia Pacific South 1 (Mumbai) Provider: Alibabaoss-eu-central-1.aliyuncs.com: Central Europe 1 (Frankfurt) Provider: Alibabaoss-eu-west-1.aliyuncs.com: West Europe (London) Provider: Alibabaoss-me-east-1.aliyuncs.com: Middle East 1 (Dubai) Provider: Alibabas3.ir-thr-at1.arvanstorage.ir: The default endpoint - a good choice if you are unsure. Tehran Iran (Simin) Provider: ArvanClouds3.ir-tbz-sh1.arvanstorage.ir: Tabriz Iran (Shahriar) Provider: ArvanCloudhn.ss.bfcplatform.vn: Hanoi endpoint Provider: BizflyCloudhcm.ss.bfcplatform.vn: Ho Chi Minh endpoint Provider: BizflyCloudeos-wuxi-1.cmecloud.cn: The default endpoint - a good choice if you are unsure. East China (Suzhou) Provider: ChinaMobileeos-jinan-1.cmecloud.cn: East China (Jinan) Provider: ChinaMobileeos-ningbo-1.cmecloud.cn: East China (Hangzhou) Provider: ChinaMobileeos-shanghai-1.cmecloud.cn: East China (Shanghai-1) Provider: ChinaMobileeos-zhengzhou-1.cmecloud.cn: Central China (Zhengzhou) Provider: ChinaMobileeos-hunan-1.cmecloud.cn: Central China (Changsha-1) Provider: ChinaMobileeos-zhuzhou-1.cmecloud.cn: Central China (Changsha-2) Provider: ChinaMobileeos-guangzhou-1.cmecloud.cn: South China (Guangzhou-2) Provider: ChinaMobileeos-dongguan-1.cmecloud.cn: South China (Guangzhou-3) Provider: ChinaMobileeos-beijing-1.cmecloud.cn: North China (Beijing-1) Provider: ChinaMobileeos-beijing-2.cmecloud.cn: North China (Beijing-2) Provider: ChinaMobileeos-beijing-4.cmecloud.cn: North China (Beijing-3) Provider: ChinaMobileeos-huhehaote-1.cmecloud.cn: North China (Huhehaote) Provider: ChinaMobileeos-chengdu-1.cmecloud.cn: Southwest China (Chengdu) Provider: ChinaMobileeos-chongqing-1.cmecloud.cn: Southwest China (Chongqing) Provider: ChinaMobileeos-guiyang-1.cmecloud.cn: Southwest China (Guiyang) Provider: ChinaMobileeos-xian-1.cmecloud.cn: Nouthwest China (Xian) Provider: ChinaMobileeos-yunnan.cmecloud.cn: Yunnan China (Kunming) Provider: ChinaMobileeos-yunnan-2.cmecloud.cn: Yunnan China (Kunming-2) Provider: ChinaMobileeos-tianjin-1.cmecloud.cn: Tianjin China (Tianjin) Provider: ChinaMobileeos-jilin-1.cmecloud.cn: Jilin China (Changchun) Provider: ChinaMobileeos-hubei-1.cmecloud.cn: Hubei China (Xiangyan) Provider: ChinaMobileeos-jiangxi-1.cmecloud.cn: Jiangxi China (Nanchang) Provider: ChinaMobileeos-gansu-1.cmecloud.cn: Gansu China (Lanzhou) Provider: ChinaMobileeos-shanxi-1.cmecloud.cn: Shanxi China (Taiyuan) Provider: ChinaMobileeos-liaoning-1.cmecloud.cn: Liaoning China (Shenyang) Provider: ChinaMobileeos-hebei-1.cmecloud.cn: Hebei China (Shijiazhuang) Provider: ChinaMobileeos-fujian-1.cmecloud.cn: Fujian China (Xiamen) Provider: ChinaMobileeos-guangxi-1.cmecloud.cn: Guangxi China (Nanning) Provider: ChinaMobileeos-anhui-1.cmecloud.cn: Anhui China (Huainan) Provider: ChinaMobiles3.cubbit.eu: Cubbit DS3 Object Storage endpoint Provider: Cubbits3.{tenant_name}.cubbit.eu: Multi-tenant endpoint - replace {tenant_name} with your actual tenant name. Do not select this directly Provider: Cubbitsyd1.digitaloceanspaces.com: DigitalOcean Spaces Sydney 1 Provider: DigitalOceansfo3.digitaloceanspaces.com: DigitalOcean Spaces San Francisco 3 Provider: DigitalOceansfo2.digitaloceanspaces.com: DigitalOcean Spaces San Francisco 2 Provider: DigitalOceanfra1.digitaloceanspaces.com: DigitalOcean Spaces Frankfurt 1 Provider: DigitalOceannyc3.digitaloceanspaces.com: DigitalOcean Spaces New York 3 Provider: DigitalOceanams3.digitaloceanspaces.com: DigitalOcean Spaces Amsterdam 3 Provider: DigitalOceansgp1.digitaloceanspaces.com: DigitalOcean Spaces Singapore 1 Provider: DigitalOceanlon1.digitaloceanspaces.com: DigitalOcean Spaces London 1 Provider: DigitalOceantor1.digitaloceanspaces.com: DigitalOcean Spaces Toronto 1 Provider: DigitalOceanblr1.digitaloceanspaces.com: DigitalOcean Spaces Bangalore 1 Provider: DigitalOceanobjects-us-east-1.dream.io: Dream Objects endpoint Provider: Dreamhostau-east-1.object.fastlystorage.app: AU East 1 Provider: Fastlyeu-central.object.fastlystorage.app: EU Central Provider: Fastlyeu-south-1.object.fastlystorage.app: EU South 1 Provider: Fastlyeu-west-1.object.fastlystorage.app: EU West 1 Provider: Fastlyjp-central-1.object.fastlystorage.app: JP Central 1 Provider: Fastlyuk-east-1.object.fastlystorage.app: UK East 1 Provider: Fastlyus-central-1.object.fastlystorage.app: US Central 1 Provider: Fastlyus-east.object.fastlystorage.app: US East Provider: Fastlyus-east-1.object.fastlystorage.app: US East 1 Provider: Fastlyus-west.object.fastlystorage.app: US West Provider: Fastlyus-west-1.object.fastlystorage.app: US West 1 Provider: Fastlys5lu.com: Global FileLu S5 endpoint Provider: FileLuus.s5lu.com: North America (US-East) region endpoint Provider: FileLueu.s5lu.com: Europe (EU-Central) region endpoint Provider: FileLuap.s5lu.com: Asia Pacific (AP-Southeast) region endpoint Provider: FileLume.s5lu.com: Middle East (ME-Central) region endpoint Provider: FileLuhttps://storage.googleapis.com: Google Cloud Storage endpoint Provider: GCShel1.your-objectstorage.com: Helsinki Provider: Hetznerfsn1.your-objectstorage.com: Falkenstein Provider: Hetznernbg1.your-objectstorage.com: Nuremberg Provider: Hetznerobs.af-south-1.myhuaweicloud.com: AF-Johannesburg Provider: HuaweiOBSobs.ap-southeast-2.myhuaweicloud.com: AP-Bangkok Provider: HuaweiOBSobs.ap-southeast-3.myhuaweicloud.com: AP-Singapore Provider: HuaweiOBSobs.cn-east-3.myhuaweicloud.com: CN East-Shanghai1 Provider: HuaweiOBSobs.cn-east-2.myhuaweicloud.com: CN East-Shanghai2 Provider: HuaweiOBSobs.cn-north-1.myhuaweicloud.com: CN North-Beijing1 Provider: HuaweiOBSobs.cn-north-4.myhuaweicloud.com: CN North-Beijing4 Provider: HuaweiOBSobs.cn-south-1.myhuaweicloud.com: CN South-Guangzhou Provider: HuaweiOBSobs.ap-southeast-1.myhuaweicloud.com: CN-Hong Kong Provider: HuaweiOBSobs.sa-argentina-1.myhuaweicloud.com: LA-Buenos Aires1 Provider: HuaweiOBSobs.sa-peru-1.myhuaweicloud.com: LA-Lima1 Provider: HuaweiOBSobs.na-mexico-1.myhuaweicloud.com: LA-Mexico City1 Provider: HuaweiOBSobs.sa-chile-1.myhuaweicloud.com: LA-Santiago2 Provider: HuaweiOBSobs.sa-brazil-1.myhuaweicloud.com: LA-Sao Paulo1 Provider: HuaweiOBSobs.ru-northwest-2.myhuaweicloud.com: RU-Moscow2 Provider: HuaweiOBSs3.us.cloud-object-storage.appdomain.cloud: US Cross Region Endpoint Provider: IBMCOSs3.dal.us.cloud-object-storage.appdomain.cloud: US Cross Region Dallas Endpoint Provider: IBMCOSs3.wdc.us.cloud-object-storage.appdomain.cloud: US Cross Region Washington DC Endpoint Provider: IBMCOSs3.sjc.us.cloud-object-storage.appdomain.cloud: US Cross Region San Jose Endpoint Provider: IBMCOSs3.private.us.cloud-object-storage.appdomain.cloud: US Cross Region Private Endpoint Provider: IBMCOSs3.private.dal.us.cloud-object-storage.appdomain.cloud: US Cross Region Dallas Private Endpoint Provider: IBMCOSs3.private.wdc.us.cloud-object-storage.appdomain.cloud: US Cross Region Washington DC Private Endpoint Provider: IBMCOSs3.private.sjc.us.cloud-object-storage.appdomain.cloud: US Cross Region San Jose Private Endpoint Provider: IBMCOSs3.us-east.cloud-object-storage.appdomain.cloud: US Region East Endpoint Provider: IBMCOSs3.private.us-east.cloud-object-storage.appdomain.cloud: US Region East Private Endpoint Provider: IBMCOSs3.us-south.cloud-object-storage.appdomain.cloud: US Region South Endpoint Provider: IBMCOSs3.private.us-south.cloud-object-storage.appdomain.cloud: US Region South Private Endpoint Provider: IBMCOSs3.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Endpoint Provider: IBMCOSs3.fra.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Frankfurt Endpoint Provider: IBMCOSs3.mil.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Milan Endpoint Provider: IBMCOSs3.ams.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Amsterdam Endpoint Provider: IBMCOSs3.private.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Private Endpoint Provider: IBMCOSs3.private.fra.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Frankfurt Private Endpoint Provider: IBMCOSs3.private.mil.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Milan Private Endpoint Provider: IBMCOSs3.private.ams.eu.cloud-object-storage.appdomain.cloud: EU Cross Region Amsterdam Private Endpoint Provider: IBMCOSs3.eu-gb.cloud-object-storage.appdomain.cloud: Great Britain Endpoint Provider: IBMCOSs3.private.eu-gb.cloud-object-storage.appdomain.cloud: Great Britain Private Endpoint Provider: IBMCOSs3.eu-de.cloud-object-storage.appdomain.cloud: EU Region DE Endpoint Provider: IBMCOSs3.private.eu-de.cloud-object-storage.appdomain.cloud: EU Region DE Private Endpoint Provider: IBMCOSs3.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Endpoint Provider: IBMCOSs3.tok.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Tokyo Endpoint Provider: IBMCOSs3.hkg.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Hong Kong Endpoint Provider: IBMCOSs3.seo.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Seoul Endpoint Provider: IBMCOSs3.private.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Private Endpoint Provider: IBMCOSs3.private.tok.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Tokyo Private Endpoint Provider: IBMCOSs3.private.hkg.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Hong Kong Private Endpoint Provider: IBMCOSs3.private.seo.ap.cloud-object-storage.appdomain.cloud: APAC Cross Regional Seoul Private Endpoint Provider: IBMCOSs3.jp-tok.cloud-object-storage.appdomain.cloud: APAC Region Japan Endpoint Provider: IBMCOSs3.private.jp-tok.cloud-object-storage.appdomain.cloud: APAC Region Japan Private Endpoint Provider: IBMCOSs3.au-syd.cloud-object-storage.appdomain.cloud: APAC Region Australia Endpoint Provider: IBMCOSs3.private.au-syd.cloud-object-storage.appdomain.cloud: APAC Region Australia Private Endpoint Provider: IBMCOSs3.ams03.cloud-object-storage.appdomain.cloud: Amsterdam Single Site Endpoint Provider: IBMCOSs3.private.ams03.cloud-object-storage.appdomain.cloud: Amsterdam Single Site Private Endpoint Provider: IBMCOSs3.che01.cloud-object-storage.appdomain.cloud: Chennai Single Site Endpoint Provider: IBMCOSs3.private.che01.cloud-object-storage.appdomain.cloud: Chennai Single Site Private Endpoint Provider: IBMCOSs3.mel01.cloud-object-storage.appdomain.cloud: Melbourne Single Site Endpoint Provider: IBMCOSs3.private.mel01.cloud-object-storage.appdomain.cloud: Melbourne Single Site Private Endpoint Provider: IBMCOSs3.osl01.cloud-object-storage.appdomain.cloud: Oslo Single Site Endpoint Provider: IBMCOSs3.private.osl01.cloud-object-storage.appdomain.cloud: Oslo Single Site Private Endpoint Provider: IBMCOSs3.tor01.cloud-object-storage.appdomain.cloud: Toronto Single Site Endpoint Provider: IBMCOSs3.private.tor01.cloud-object-storage.appdomain.cloud: Toronto Single Site Private Endpoint Provider: IBMCOSs3.seo01.cloud-object-storage.appdomain.cloud: Seoul Single Site Endpoint Provider: IBMCOSs3.private.seo01.cloud-object-storage.appdomain.cloud: Seoul Single Site Private Endpoint Provider: IBMCOSs3.mon01.cloud-object-storage.appdomain.cloud: Montreal Single Site Endpoint Provider: IBMCOSs3.private.mon01.cloud-object-storage.appdomain.cloud: Montreal Single Site Private Endpoint Provider: IBMCOSs3.mex01.cloud-object-storage.appdomain.cloud: Mexico Single Site Endpoint Provider: IBMCOSs3.private.mex01.cloud-object-storage.appdomain.cloud: Mexico Single Site Private Endpoint Provider: IBMCOSs3.sjc04.cloud-object-storage.appdomain.cloud: San Jose Single Site Endpoint Provider: IBMCOSs3.private.sjc04.cloud-object-storage.appdomain.cloud: San Jose Single Site Private Endpoint Provider: IBMCOSs3.mil01.cloud-object-storage.appdomain.cloud: Milan Single Site Endpoint Provider: IBMCOSs3.private.mil01.cloud-object-storage.appdomain.cloud: Milan Single Site Private Endpoint Provider: IBMCOSs3.hkg02.cloud-object-storage.appdomain.cloud: Hong Kong Single Site Endpoint Provider: IBMCOSs3.private.hkg02.cloud-object-storage.appdomain.cloud: Hong Kong Single Site Private Endpoint Provider: IBMCOSs3.par01.cloud-object-storage.appdomain.cloud: Paris Single Site Endpoint Provider: IBMCOSs3.private.par01.cloud-object-storage.appdomain.cloud: Paris Single Site Private Endpoint Provider: IBMCOSs3.sng01.cloud-object-storage.appdomain.cloud: Singapore Single Site Endpoint Provider: IBMCOSs3.private.sng01.cloud-object-storage.appdomain.cloud: Singapore Single Site Private Endpoint Provider: IBMCOSeu-central-2.storage.impossibleapi.net: Frankfurt, Germany Provider: ImpossibleCloudeu-west-1.storage.impossibleapi.net: Amsterdam, Netherlands Provider: ImpossibleCloudeu-west-2.storage.impossibleapi.net: London, UK Provider: ImpossibleCloudeu-west-3.storage.impossibleapi.net: Paris, France Provider: ImpossibleCloudeu-east-1.storage.impossibleapi.net: Poznań, Poland Provider: ImpossibleCloudeu-north-1.storage.impossibleapi.net: Copenhagen, Denmark Provider: ImpossibleCloudus-east-1.storage.impossibleapi.net: New York, USA Provider: ImpossibleCloudde-fra.i3storage.com: Frankfurt, Germany Provider: Intercolos3.eu-central-1.ionoscloud.com: Frankfurt, Germany Provider: IONOSs3.eu-central-2.ionoscloud.com: Berlin, Germany Provider: IONOSs3.eu-central-3.ionoscloud.com: Berlin, Germany Provider: IONOSs3.eu-central-4.ionoscloud.com: Frankfurt, Germany Provider: IONOSs3.eu-south-2.ionoscloud.com: Logrono, Spain Provider: IONOSs3.us-central-1.ionoscloud.com: Lenexa, USA Provider: IONOSs3.leviia.com: The default endpoint Leviia Provider: Leviiastorage.iran.liara.space: The default endpoint Iran Provider: Liaranl-ams-1.linodeobjects.com: Amsterdam, NL (nl-ams-1) Provider: Linodeus-southeast-1.linodeobjects.com: Atlanta, GA, US (us-southeast-1) Provider: Linodein-maa-1.linodeobjects.com: Chennai, IN (in-maa-1) Provider: Linodeus-ord-1.linodeobjects.com: Chicago, IL, US (us-ord-1) Provider: Linodeeu-central-1.linodeobjects.com: Frankfurt, DE (eu-central-1) Provider: Linodeid-cgk-1.linodeobjects.com: Jakarta, ID (id-cgk-1) Provider: Linodegb-lon-1.linodeobjects.com: London 2, UK (gb-lon-1) Provider: Linodeus-lax-1.linodeobjects.com: Los Angeles, CA, US (us-lax-1) Provider: Linodees-mad-1.linodeobjects.com: Madrid, ES (es-mad-1) Provider: Linodeus-mia-1.linodeobjects.com: Miami, FL, US (us-mia-1) Provider: Linodeit-mil-1.linodeobjects.com: Milan, IT (it-mil-1) Provider: Linodeus-east-1.linodeobjects.com: Newark, NJ, US (us-east-1) Provider: Linodejp-osa-1.linodeobjects.com: Osaka, JP (jp-osa-1) Provider: Linodefr-par-1.linodeobjects.com: Paris, FR (fr-par-1) Provider: Linodebr-gru-1.linodeobjects.com: Sao Paulo, BR (br-gru-1) Provider: Linodeus-sea-1.linodeobjects.com: Seattle, WA, US (us-sea-1) Provider: Linodeap-south-1.linodeobjects.com: Singapore, SG (ap-south-1) Provider: Linodesg-sin-1.linodeobjects.com: Singapore 2, SG (sg-sin-1) Provider: Linodese-sto-1.linodeobjects.com: Stockholm, SE (se-sto-1) Provider: Linodejp-tyo-1.linodeobjects.com: Tokyo 3, JP (jp-tyo-1) Provider: Linodeus-iad-10.linodeobjects.com: Washington, DC, US (us-iad-10) Provider: Linodes3.us-west-1.{account_name}.lyve.seagate.com: US West 1 - California Provider: LyveClouds3.eu-west-1.{account_name}.lyve.seagate.com: EU West 1 - Ireland Provider: LyveCloudbr-se1.magaluobjects.com: São Paulo, SP (BR), br-se1 Provider: Magalubr-ne1.magaluobjects.com: Fortaleza, CE (BR), br-ne1 Provider: Magalus3.eu-luxembourg-1.megas4.com: Mega S4 Luxembourg 1 Provider: Megas3.eu-luxembourg-2.megas4.com: Mega S4 Luxembourg 2 Provider: Megas3.eu-amsterdam-1.megas4.com: Mega S4 Amsterdam 1 Provider: Megas3.eu-amsterdam-2.megas4.com: Mega S4 Amsterdam 2 Provider: Megas3.eu-paris-1.megas4.com: Mega S4 Paris 1 Provider: Megas3.eu-paris-2.megas4.com: Mega S4 Paris 2 Provider: Megas3.eu-barcelona-1.megas4.com: Mega S4 Barcelona 1 Provider: Megas3.eu-barcelona-2.megas4.com: Mega S4 Barcelona 2 Provider: Megas3.ca-montreal-1.megas4.com: Mega S4 Montreal 1 Provider: Megas3.ca-montreal-2.megas4.com: Mega S4 Montreal 2 Provider: Megas3.ca-vancouver-1.megas4.com: Mega S4 Vancouver 1 Provider: Megas3.ca-vancouver-2.megas4.com: Mega S4 Vancouver 2 Provider: Megas3.ap-tokyo-1.megas4.com: Mega S4 Tokyo 1 Provider: Megas3.ap-tokyo-2.megas4.com: Mega S4 Tokyo 2 Provider: Megaoos.eu-west-2.outscale.com: Outscale EU West 2 (Paris) Provider: Outscaleoos.us-east-2.outscale.com: Outscale US east 2 (New Jersey) Provider: Outscaleoos.us-west-1.outscale.com: Outscale EU West 1 (California) Provider: Outscaleoos.cloudgouv-eu-west-1.outscale.com: Outscale SecNumCloud (Paris) Provider: Outscaleoos.ap-northeast-1.outscale.com: Outscale AP Northeast 1 (Japan) Provider: Outscales3.gra.io.cloud.ovh.net: OVHcloud Gravelines, France Provider: OVHclouds3.rbx.io.cloud.ovh.net: OVHcloud Roubaix, France Provider: OVHclouds3.sbg.io.cloud.ovh.net: OVHcloud Strasbourg, France Provider: OVHclouds3.eu-west-par.io.cloud.ovh.net: OVHcloud Paris, France (3AZ) Provider: OVHclouds3.de.io.cloud.ovh.net: OVHcloud Frankfurt, Germany Provider: OVHclouds3.uk.io.cloud.ovh.net: OVHcloud London, United Kingdom Provider: OVHclouds3.waw.io.cloud.ovh.net: OVHcloud Warsaw, Poland Provider: OVHclouds3.bhs.io.cloud.ovh.net: OVHcloud Beauharnois, Canada Provider: OVHclouds3.ca-east-tor.io.cloud.ovh.net: OVHcloud Toronto, Canada Provider: OVHclouds3.sgp.io.cloud.ovh.net: OVHcloud Singapore Provider: OVHclouds3.ap-southeast-syd.io.cloud.ovh.net: OVHcloud Sydney, Australia Provider: OVHclouds3.ap-south-mum.io.cloud.ovh.net: OVHcloud Mumbai, India Provider: OVHclouds3.us-east-va.io.cloud.ovh.us: OVHcloud Vint Hill, Virginia, USA Provider: OVHclouds3.us-west-or.io.cloud.ovh.us: OVHcloud Hillsboro, Oregon, USA Provider: OVHclouds3.rbx-archive.io.cloud.ovh.net: OVHcloud Roubaix, France (Cold Archive) Provider: OVHclouds3.petabox.io: US East (N. Virginia) Provider: Petaboxs3.us-east-1.petabox.io: US East (N. Virginia) Provider: Petaboxs3.eu-central-1.petabox.io: Europe (Frankfurt) Provider: Petaboxs3.ap-southeast-1.petabox.io: Asia Pacific (Singapore) Provider: Petaboxs3.me-south-1.petabox.io: Middle East (Bahrain) Provider: Petaboxs3.sa-east-1.petabox.io: South America (São Paulo) Provider: Petaboxs3-cn-east-1.qiniucs.com: East China Endpoint 1 Provider: Qinius3-cn-east-2.qiniucs.com: East China Endpoint 2 Provider: Qinius3-cn-north-1.qiniucs.com: North China Endpoint 1 Provider: Qinius3-cn-south-1.qiniucs.com: South China Endpoint 1 Provider: Qinius3-us-north-1.qiniucs.com: North America Endpoint 1 Provider: Qinius3-ap-southeast-1.qiniucs.com: Southeast Asia Endpoint 1 Provider: Qinius3-ap-northeast-1.qiniucs.com: Northeast Asia Endpoint 1 Provider: Qinius3.us-east-1.rabata.io: US East (N. Virginia) Provider: Rabatas3.eu-west-1.rabata.io: EU West (Ireland) Provider: Rabatas3.eu-west-2.rabata.io: EU West (London) Provider: Rabatas3.rackcorp.com: Global (AnyCast) Endpoint Provider: RackCorpau.s3.rackcorp.com: Australia (Anycast) Endpoint Provider: RackCorpau-nsw.s3.rackcorp.com: Sydney (Australia) Endpoint Provider: RackCorpau-qld.s3.rackcorp.com: Brisbane (Australia) Endpoint Provider: RackCorpau-vic.s3.rackcorp.com: Melbourne (Australia) Endpoint Provider: RackCorpau-wa.s3.rackcorp.com: Perth (Australia) Endpoint Provider: RackCorpph.s3.rackcorp.com: Manila (Philippines) Endpoint Provider: RackCorpth.s3.rackcorp.com: Bangkok (Thailand) Endpoint Provider: RackCorphk.s3.rackcorp.com: HK (Hong Kong) Endpoint Provider: RackCorpmn.s3.rackcorp.com: Ulaanbaatar (Mongolia) Endpoint Provider: RackCorpkg.s3.rackcorp.com: Bishkek (Kyrgyzstan) Endpoint Provider: RackCorpid.s3.rackcorp.com: Jakarta (Indonesia) Endpoint Provider: RackCorpjp.s3.rackcorp.com: Tokyo (Japan) Endpoint Provider: RackCorpsg.s3.rackcorp.com: SG (Singapore) Endpoint Provider: RackCorpde.s3.rackcorp.com: Frankfurt (Germany) Endpoint Provider: RackCorpus.s3.rackcorp.com: USA (AnyCast) Endpoint Provider: RackCorpus-east-1.s3.rackcorp.com: New York (USA) Endpoint Provider: RackCorpus-west-1.s3.rackcorp.com: Freemont (USA) Endpoint Provider: RackCorpnz.s3.rackcorp.com: Auckland (New Zealand) Endpoint Provider: RackCorps3.nl-ams.scw.cloud: Amsterdam Endpoint Provider: Scaleways3.fr-par.scw.cloud: Paris Endpoint Provider: Scaleways3.pl-waw.scw.cloud: Warsaw Endpoint Provider: Scalewaylocalhost:8333: SeaweedFS S3 localhost Provider: SeaweedFSs3.ru-1.storage.selcloud.ru: St. Petersburg Provider: Selectels3.ru-3.storage.selcloud.ru: St. Petersburg Provider: Selectels3.ru-7.storage.selcloud.ru: Moscow Provider: Selectel,Servercores3.gis-1.storage.selcloud.ru: Moscow Provider: Selectel,Servercores3.kz-1.storage.selcloud.ru: Kazakhstan Provider: Selectels3.uz-2.storage.selcloud.ru: Uzbekistan Provider: Selectels3.ru-1.storage.selcloud.ru: Saint Petersburg Provider: Servercores3.uz-2.srvstorage.uz: Tashkent, Uzbekistan Provider: Servercores3.kz-1.srvstorage.kz: Almaty, Kazakhstan Provider: Servercoregateway.storjshare.io: Global Hosted Gateway Provider: Storjeu-001.s3.synologyc2.net: EU Endpoint 1 Provider: Synologyeu-002.s3.synologyc2.net: EU Endpoint 2 Provider: Synologyus-001.s3.synologyc2.net: US Endpoint 1 Provider: Synologyus-002.s3.synologyc2.net: US Endpoint 2 Provider: Synologytw-001.s3.synologyc2.net: TW Endpoint 1 Provider: Synologycos.ap-beijing.myqcloud.com: Beijing Region Provider: TencentCOScos.ap-nanjing.myqcloud.com: Nanjing Region Provider: TencentCOScos.ap-shanghai.myqcloud.com: Shanghai Region Provider: TencentCOScos.ap-guangzhou.myqcloud.com: Guangzhou Region Provider: TencentCOScos.ap-chengdu.myqcloud.com: Chengdu Region Provider: TencentCOScos.ap-chongqing.myqcloud.com: Chongqing Region Provider: TencentCOScos.ap-hongkong.myqcloud.com: Hong Kong (China) Region Provider: TencentCOScos.ap-singapore.myqcloud.com: Singapore Region Provider: TencentCOScos.ap-mumbai.myqcloud.com: Mumbai Region Provider: TencentCOScos.ap-seoul.myqcloud.com: Seoul Region Provider: TencentCOScos.ap-bangkok.myqcloud.com: Bangkok Region Provider: TencentCOScos.ap-tokyo.myqcloud.com: Tokyo Region Provider: TencentCOScos.na-siliconvalley.myqcloud.com: Silicon Valley Region Provider: TencentCOScos.na-ashburn.myqcloud.com: Virginia Region Provider: TencentCOScos.na-toronto.myqcloud.com: Toronto Region Provider: TencentCOScos.eu-frankfurt.myqcloud.com: Frankfurt Region Provider: TencentCOScos.eu-moscow.myqcloud.com: Moscow Region Provider: TencentCOScos.accelerate.myqcloud.com: Use Tencent COS Accelerate Endpoint Provider: TencentCOSs3-cn-bj.ufileos.com: North China (Beijing 2) Provider: US3s3-cn-wlcb.ufileos.com: North China (Ulanqab) Provider: US3s3-cn-sh2.ufileos.com: Shanghai Provider: US3s3-cn-gd.ufileos.com: South China (Guangzhou) Provider: US3s3-hk.ufileos.com: Hongkong Provider: US3s3-us-ca.ufileos.com: United States (Los Angeles) Provider: US3s3-sg.ufileos.com: Singapore Provider: US3s3-idn-jakarta.ufileos.com: Indonesia (Jakarta) Provider: US3s3-tw-tp.ufileos.com: Taiwan (Taipei) Provider: US3s3-afr-nigeria.ufileos.com: Nigeria (Lagos) Provider: US3s3-bra-saopaulo.ufileos.com: Brazil (São Paulo) Provider: US3s3-uae-dubai.ufileos.com: United Arab Emirates (Dubai) Provider: US3s3-ge-fra.ufileos.com: Germany (Frankfurt) Provider: US3s3-vn-sng.ufileos.com: Vietnam (Ho Chi Minh City) Provider: US3s3-us-ws.ufileos.com: United States (Washington) Provider: US3s3-ind-mumbai.ufileos.com: India (Mumbai) Provider: US3s3-kr-seoul.ufileos.com: Seoul (South Korea) Provider: US3s3-jpn-tky.ufileos.com: Japan (Tokyo) Provider: US3s3-th-bkk.ufileos.com: Bangkok (Thailand) Provider: US3s3-uk-london.ufileos.com: United Kingdom (London) Provider: US3s3-rus-mosc.ufileos.com: Russia (Moscow) Provider: US3s3-cn-guiyang1.ufileos.com: Guiyang 1 Provider: US3s3-pk-khi.ufileos.com: Pakistan Provider: US3s3.wasabisys.com: Wasabi US East 1 (N. Virginia) Provider: Wasabis3.us-east-2.wasabisys.com: Wasabi US East 2 (N. Virginia) Provider: Wasabis3.us-central-1.wasabisys.com: Wasabi US Central 1 (Texas) Provider: Wasabis3.us-west-1.wasabisys.com: Wasabi US West 1 (Oregon) Provider: Wasabis3.ca-central-1.wasabisys.com: Wasabi CA Central 1 (Toronto) Provider: Wasabis3.eu-central-1.wasabisys.com: Wasabi EU Central 1 (Amsterdam) Provider: Wasabis3.eu-central-2.wasabisys.com: Wasabi EU Central 2 (Frankfurt) Provider: Wasabis3.eu-west-1.wasabisys.com: Wasabi EU West 1 (London) Provider: Wasabis3.eu-west-2.wasabisys.com: Wasabi EU West 2 (Paris) Provider: Wasabis3.eu-south-1.wasabisys.com: Wasabi EU South 1 (Milan) Provider: Wasabis3.ap-northeast-1.wasabisys.com: Wasabi AP Northeast 1 (Tokyo) endpoint Provider: Wasabis3.ap-northeast-2.wasabisys.com: Wasabi AP Northeast 2 (Osaka) endpoint Provider: Wasabis3.ap-southeast-1.wasabisys.com: Wasabi AP Southeast 1 (Singapore) Provider: Wasabis3.ap-southeast-2.wasabisys.com: Wasabi AP Southeast 2 (Sydney) Provider: Wasabiidr01.zata.ai: South Asia Endpoint Provider: Zatafra1.s3.zeroservices.eu: Frankfurt 1 Provider: ZeroServicesfra.s3.zeroservices.eu: Frankfurt 2 Provider: ZeroServiceseyl1.s3.zeroservices.eu: Eyl 1 Provider: ZeroServices
location_constraint
Section titled “location_constraint”Location constraint - must be set to match the Region.
Leave blank if not sure. Used when creating buckets only.
Type: string
Only for providers: AWS, ArvanCloud, Ceph, ChinaMobile, DigitalOcean, Dreamhost, Exaba, GCS, HCP, Hetzner, IBMCOS, ImpossibleCloud, LyveCloud, Minio, Netease, Qiniu, Rabata, RackCorp, Scality, SeaweedFS, Synology, Wasabi, Zata, ZeroServices, Other
Choices:
(empty): Empty for US Region, Northern Virginia, or Pacific Northwest Provider: AWSus-east-2: US East (Ohio) Region Provider: AWSus-west-1: US West (Northern California) Region Provider: AWSus-west-2: US West (Oregon) Region Provider: AWSca-central-1: Canada (Central) Region Provider: AWSeu-west-1: EU (Ireland) Region Provider: AWSeu-west-2: EU (London) Region Provider: AWSeu-west-3: EU (Paris) Region Provider: AWSeu-north-1: EU (Stockholm) Region Provider: AWSeu-south-1: EU (Milan) Region Provider: AWSEU: EU Region Provider: AWSap-southeast-1: Asia Pacific (Singapore) Region Provider: AWSap-southeast-2: Asia Pacific (Sydney) Region Provider: AWSap-northeast-1: Asia Pacific (Tokyo) Region Provider: AWSap-northeast-2: Asia Pacific (Seoul) Region Provider: AWSap-northeast-3: Asia Pacific (Osaka-Local) Region Provider: AWSap-south-1: Asia Pacific (Mumbai) Region Provider: AWSap-east-1: Asia Pacific (Hong Kong) Region Provider: AWSsa-east-1: South America (Sao Paulo) Region Provider: AWSil-central-1: Israel (Tel Aviv) Region Provider: AWSme-south-1: Middle East (Bahrain) Region Provider: AWSaf-south-1: Africa (Cape Town) Region Provider: AWScn-north-1: China (Beijing) Region Provider: AWScn-northwest-1: China (Ningxia) Region Provider: AWSus-gov-east-1: AWS GovCloud (US-East) Region Provider: AWSus-gov-west-1: AWS GovCloud (US) Region Provider: AWSir-thr-at1: Tehran Iran (Simin) Provider: ArvanCloudir-tbz-sh1: Tabriz Iran (Shahriar) Provider: ArvanCloudwuxi1: East China (Suzhou) Provider: ChinaMobilejinan1: East China (Jinan) Provider: ChinaMobileningbo1: East China (Hangzhou) Provider: ChinaMobileshanghai1: East China (Shanghai-1) Provider: ChinaMobilezhengzhou1: Central China (Zhengzhou) Provider: ChinaMobilehunan1: Central China (Changsha-1) Provider: ChinaMobilezhuzhou1: Central China (Changsha-2) Provider: ChinaMobileguangzhou1: South China (Guangzhou-2) Provider: ChinaMobiledongguan1: South China (Guangzhou-3) Provider: ChinaMobilebeijing1: North China (Beijing-1) Provider: ChinaMobilebeijing2: North China (Beijing-2) Provider: ChinaMobilebeijing4: North China (Beijing-3) Provider: ChinaMobilehuhehaote1: North China (Huhehaote) Provider: ChinaMobilechengdu1: Southwest China (Chengdu) Provider: ChinaMobilechongqing1: Southwest China (Chongqing) Provider: ChinaMobileguiyang1: Southwest China (Guiyang) Provider: ChinaMobilexian1: Northwest China (Xian) Provider: ChinaMobileyunnan: Yunnan China (Kunming) Provider: ChinaMobileyunnan2: Yunnan China (Kunming-2) Provider: ChinaMobiletianjin1: Tianjin China (Tianjin) Provider: ChinaMobilejilin1: Jilin China (Changchun) Provider: ChinaMobilehubei1: Hubei China (Xiangyan) Provider: ChinaMobilejiangxi1: Jiangxi China (Nanchang) Provider: ChinaMobilegansu1: Gansu China (Lanzhou) Provider: ChinaMobileshanxi1: Shanxi China (Taiyuan) Provider: ChinaMobileliaoning1: Liaoning China (Shenyang) Provider: ChinaMobilehebei1: Hebei China (Shijiazhuang) Provider: ChinaMobilefujian1: Fujian China (Xiamen) Provider: ChinaMobileguangxi1: Guangxi China (Nanning) Provider: ChinaMobileanhui1: Anhui China (Huainan) Provider: ChinaMobileus-standard: US Cross Region Standard Provider: IBMCOSus-vault: US Cross Region Vault Provider: IBMCOSus-cold: US Cross Region Cold Provider: IBMCOSus-flex: US Cross Region Flex Provider: IBMCOSus-east-standard: US East Region Standard Provider: IBMCOSus-east-vault: US East Region Vault Provider: IBMCOSus-east-cold: US East Region Cold Provider: IBMCOSus-east-flex: US East Region Flex Provider: IBMCOSus-south-standard: US South Region Standard Provider: IBMCOSus-south-vault: US South Region Vault Provider: IBMCOSus-south-cold: US South Region Cold Provider: IBMCOSus-south-flex: US South Region Flex Provider: IBMCOSeu-standard: EU Cross Region Standard Provider: IBMCOSeu-vault: EU Cross Region Vault Provider: IBMCOSeu-cold: EU Cross Region Cold Provider: IBMCOSeu-flex: EU Cross Region Flex Provider: IBMCOSeu-gb-standard: Great Britain Standard Provider: IBMCOSeu-gb-vault: Great Britain Vault Provider: IBMCOSeu-gb-cold: Great Britain Cold Provider: IBMCOSeu-gb-flex: Great Britain Flex Provider: IBMCOSap-standard: APAC Standard Provider: IBMCOSap-vault: APAC Vault Provider: IBMCOSap-cold: APAC Cold Provider: IBMCOSap-flex: APAC Flex Provider: IBMCOSmel01-standard: Melbourne Standard Provider: IBMCOSmel01-vault: Melbourne Vault Provider: IBMCOSmel01-cold: Melbourne Cold Provider: IBMCOSmel01-flex: Melbourne Flex Provider: IBMCOStor01-standard: Toronto Standard Provider: IBMCOStor01-vault: Toronto Vault Provider: IBMCOStor01-cold: Toronto Cold Provider: IBMCOStor01-flex: Toronto Flex Provider: IBMCOScn-east-1: East China Region 1 Provider: Qiniucn-east-2: East China Region 2 Provider: Qiniucn-north-1: North China Region 1 Provider: Qiniucn-south-1: South China Region 1 Provider: Qiniuus-north-1: North America Region 1 Provider: Qiniuap-southeast-1: Southeast Asia Region 1 Provider: Qiniuap-northeast-1: Northeast Asia Region 1 Provider: Qiniuus-east-1: US East (N. Virginia) Provider: Rabataeu-west-1: EU (Ireland) Provider: Rabataeu-west-2: EU (London) Provider: Rabataglobal: Global CDN Region Provider: RackCorpau: Australia (All locations) Provider: RackCorpau-nsw: NSW (Australia) Region Provider: RackCorpau-qld: QLD (Australia) Region Provider: RackCorpau-vic: VIC (Australia) Region Provider: RackCorpau-wa: Perth (Australia) Region Provider: RackCorpph: Manila (Philippines) Region Provider: RackCorpth: Bangkok (Thailand) Region Provider: RackCorphk: HK (Hong Kong) Region Provider: RackCorpmn: Ulaanbaatar (Mongolia) Region Provider: RackCorpkg: Bishkek (Kyrgyzstan) Region Provider: RackCorpid: Jakarta (Indonesia) Region Provider: RackCorpjp: Tokyo (Japan) Region Provider: RackCorpsg: SG (Singapore) Region Provider: RackCorpde: Frankfurt (Germany) Region Provider: RackCorpus: USA (AnyCast) Region Provider: RackCorpus-east-1: New York (USA) Region Provider: RackCorpus-west-1: Fremont (USA) Region Provider: RackCorpnz: Auckland (New Zealand) Region Provider: RackCorp
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.
Type: string
Only for providers: 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, Scality, SeaweedFS, TencentCOS, US3, Wasabi, Zata, ZeroServices, Other
Choices:
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,Scality,SeaweedFS,US3,Wasabi,Zata,ZeroServices,Otherpublic-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,Scality,SeaweedFS,TencentCOS,US3,Wasabi,Zata,ZeroServices,Otherpublic-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,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Otherauthenticated-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,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Otherbucket-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,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Otherbucket-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,Scality,SeaweedFS,TencentCOS,Wasabi,Zata,ZeroServices,Otherprivate: 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: IBMCOSpublic-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: IBMCOSpublic-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: IBMCOSauthenticated-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: IBMCOSdefault: Owner gets Full_CONTROL. No one else has access rights (default). Provider: TencentCOS
server_side_encryption
Section titled “server_side_encryption”The server-side encryption algorithm used when storing this object in S3.
Type: string
Only for providers: AWS, Ceph, ChinaMobile, Minio
Choices:
(empty): None Provider: AWS,Ceph,ChinaMobile,MinioAES256: AES256 Provider: AWS,Ceph,ChinaMobile,Minioaws:kms: aws:kms Provider: AWS,Ceph,Minio
sse_kms_key_id
Section titled “sse_kms_key_id”If using KMS ID you must provide the ARN of Key.
Type: string
Only for providers: AWS, Ceph, Minio
Choices:
(empty): Nonearn:aws:kms:us-east-1:*: arn:aws:kms:*
storage_class
Section titled “storage_class”The storage class to use when storing new objects in S3.
Type: string
Only for providers: AWS, Alibaba, ArvanCloud, ChinaMobile, Liara, Magalu, OVHcloud, Qiniu, Scaleway, TencentCOS, US3
Choices:
(empty): Default Provider: AWS,Alibaba,ChinaMobile,OVHcloud,TencentCOS,US3STANDARD: Standard storage class Provider: AWS,Alibaba,ArvanCloud,ChinaMobile,Liara,Magalu,OVHcloud,Qiniu,TencentCOS,US3REDUCED_REDUNDANCY: Reduced redundancy storage class Provider: AWSSTANDARD_IA: Standard Infrequent Access storage class Provider: AWS,OVHcloudONEZONE_IA: One Zone Infrequent Access storage class Provider: AWSGLACIER: Glacier Flexible Retrieval storage class Provider: AWSDEEP_ARCHIVE: Glacier Deep Archive storage class Provider: AWSINTELLIGENT_TIERING: Intelligent-Tiering storage class Provider: AWSGLACIER_IR: Glacier Instant Retrieval storage class Provider: AWS,MagaluGLACIER: Archive storage mode Provider: Alibaba,ChinaMobile,QiniuSTANDARD_IA: Infrequent access storage mode Provider: Alibaba,ChinaMobile,TencentCOS,US3EXPRESS_ONEZONE: High Performance storage class Provider: OVHcloudONEZONE_IA: Standard Infrequent Access storage class Provider: OVHcloudGLACIER: Active Archive storage class Provider: OVHcloudGLACIER_IR: Active Archive storage class Provider: OVHcloudDEEP_ARCHIVE: Cold Archive storage class Provider: OVHcloudINTELLIGENT_TIERING: Standard storage class Provider: OVHcloudLINE: Infrequent access storage mode Provider: QiniuDEEP_ARCHIVE: Deep archive storage mode Provider: Qiniu(empty): Default. Provider: ScalewaySTANDARD: The Standard class for any upload. Suitable for on-demand content like streaming or CDN. Available in all regions. Provider: ScalewayGLACIER: Archived storage. Prices are lower, but it needs to be restored first to be accessed. Available in the FR-PAR region only. Provider: ScalewayONEZONE_IA: One Zone - Infrequent Access. A good choice for storing secondary backup copies or easily re-creatable data. Available in all regions. Provider: ScalewayARCHIVE: Archive storage mode Provider: TencentCOS,US3
ibm_api_key
Section titled “ibm_api_key”IBM API Key to be used to obtain IAM token
Type: string
Only for providers: IBMCOS
ibm_resource_instance_id
Section titled “ibm_resource_instance_id”IBM service instance id
Type: string
Only for providers: IBMCOS
bucket_object_lock_enabled
Section titled “bucket_object_lock_enabled”Enable Object Lock when creating new buckets.
Type: bool · Default: false
Advanced options
Section titled “Advanced options”The wizard shows these under Advanced options. Most drives work without changing any of them.
bucket_acl
Section titled “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.
Type: string
Only for providers: 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, ZeroServices, Other
Choices:
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.
requester_pays
Section titled “requester_pays”Enables requester pays option when interacting with S3 bucket.
Type: bool · Default: false
Only for providers: AWS
sse_customer_algorithm
Section titled “sse_customer_algorithm”If using SSE-C, the server-side encryption algorithm used when storing this object in S3.
Type: string
Only for providers: AWS, Ceph, ChinaMobile, Minio
Choices:
(empty): NoneAES256: AES256
sse_customer_key
Section titled “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.
Type: string
Only for providers: AWS, Ceph, ChinaMobile, Minio
Choices:
(empty): None
sse_customer_key_base64
Section titled “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.
Type: string
Only for providers: AWS, Ceph, ChinaMobile, Minio
Choices:
(empty): None
sse_customer_key_md5
Section titled “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.
Type: string
Only for providers: AWS, Ceph, ChinaMobile, Minio
Choices:
(empty): None
upload_cutoff
Section titled “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.
Type: SizeSuffix · Default: 200Mi
chunk_size
Section titled “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.
Type: SizeSuffix · Default: 5Mi
max_upload_parts
Section titled “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.
Type: int · Default: 10000
copy_cutoff
Section titled “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 1 byte and the maximum is 5 GiB.
Type: SizeSuffix · Default: 4.656Gi
disable_checksum
Section titled “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.
Type: bool · Default: false
shared_credentials_file
Section titled “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"Type: string
profile
Section titled “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.
Type: string
session_token
Section titled “session_token”An AWS session token.
Type: string
role_arn
Section titled “role_arn”ARN of the IAM role to assume.
Leave blank if not using assume role.
Type: string
role_session_name
Section titled “role_session_name”Session name for assumed role.
If empty, a session name will be generated automatically.
Type: string
role_session_duration
Section titled “role_session_duration”Session duration for assumed role.
If empty, the default session duration will be used.
Type: string
role_external_id
Section titled “role_external_id”External ID for assumed role.
Leave blank if not using an external ID.
Type: string
upload_concurrency
Section titled “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.
Type: int · Default: 4
force_path_style
Section titled “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.
Type: bool · Default: true
v2_auth
Section titled “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.
Type: bool · Default: false
use_dual_stack
Section titled “use_dual_stack”If true use AWS S3 dual-stack endpoint (IPv6 support).
See AWS Docs on Dualstack Endpoints
Type: bool · Default: false
use_accelerate_endpoint
Section titled “use_accelerate_endpoint”If true use the AWS S3 accelerated endpoint.
See: AWS S3 Transfer acceleration
Type: bool · Default: false
Only for providers: AWS
use_arn_region
Section titled “use_arn_region”If true, enables arn region support for the service.
Type: bool · Default: false
leave_parts_on_error
Section titled “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.
Type: bool · Default: false
Only for providers: AWS
list_chunk
Section titled “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.
Type: int · Default: 1000
list_version
Section titled “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.
Type: int · Default: 0
list_url_encode
Section titled “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.
Type: Tristate · Default: unset
no_check_bucket
Section titled “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.
Type: bool · Default: false
no_head
Section titled “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.
Type: bool · Default: false
no_head_object
Section titled “no_head_object”If set, do not do HEAD before GET when getting objects.
Type: bool · Default: false
encoding
Section titled “encoding”The encoding for the backend.
See the encoding section in the overview for more info.
Type: Encoding · Default: Slash,InvalidUtf8,Dot
disable_http2
Section titled “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
Type: bool · Default: false
download_url
Section titled “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.
Type: string
directory_markers
Section titled “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.
Type: bool · Default: false
use_multipart_etag
Section titled “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.
Type: Tristate · Default: unset
use_unsigned_payload
Section titled “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.
Type: Tristate · Default: unset
use_presigned_request
Section titled “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.
Type: bool · Default: false
use_data_integrity_protections
Section titled “use_data_integrity_protections”If true use AWS S3 data integrity protections.
See AWS Docs on Data Integrity Protections
Type: Tristate · Default: unset
versions
Section titled “versions”Include old versions in directory listings.
Type: bool · Default: false
version_at
Section titled “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.
Type: Time · Default: off
version_deleted
Section titled “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.
Type: bool · Default: false
decompress
Section titled “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.
Type: bool · Default: false
might_gzip
Section titled “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 MMMIf 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.
Type: Tristate · Default: unset
use_accept_encoding_gzip
Section titled “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.
Type: Tristate · Default: unset
no_system_metadata
Section titled “no_system_metadata”Suppress setting and reading of system metadata
Type: bool · Default: false
use_already_exists
Section titled “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.
Type: Tristate · Default: unset
use_multipart_uploads
Section titled “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.
Type: Tristate · Default: unset
list_versions_oldest_first
Section titled “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.
Type: Tristate · Default: unset
use_x_id
Section titled “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.
Type: Tristate · Default: unset
sign_accept_encoding
Section titled “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.
Type: Tristate · Default: unset
directory_bucket
Section titled “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 rmdiryet - Directory Buckets do not appear when doing
rclone lsfat the top level. - Rclone can’t remove auto created directories yet. In theory this should
work with
directory_markers = truebut it doesn’t. - Directories don’t seem to appear in recursive (ListR) listings.
Type: bool · Default: false
Only for providers: AWS
sdk_log_mode
Section titled “sdk_log_mode”Set to debug the SDK
This can be set to a comma separated list of the following functions:
SigningRetriesRequestRequestWithBodyResponseResponseWithBodyDeprecatedUsageRequestEventMessageResponseEventMessage
Use Off to disable and All to set all log levels. You will need to
use -vv to see the debug level logs.
Type: Bits · Default: Off
ibm_iam_endpoint
Section titled “ibm_iam_endpoint”IBM IAM Endpoint to use for authentication.
Leave blank to use the default public endpoint.
Type: string
Only for providers: IBMCOS
object_lock_mode
Section titled “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
Type: string
Choices:
GOVERNANCE: Set Object Lock mode to GOVERNANCECOMPLIANCE: Set Object Lock mode to COMPLIANCEcopy: Copy from source object (requires –metadata)
object_lock_retain_until_date
Section titled “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
Type: string
Choices:
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 now1y: Set retention for 1 year from now
object_lock_legal_hold_status
Section titled “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
Type: string
Choices:
ON: Enable legal holdOFF: Disable legal holdcopy: Copy from source object (requires –metadata)
bypass_governance_retention
Section titled “bypass_governance_retention”Allow deleting or modifying objects locked with GOVERNANCE mode.
Type: bool · Default: false
object_lock_set_after_upload
Section titled “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.
Type: bool · Default: false
object_lock_supported
Section titled “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).
Type: Tristate · Default: unset
description
Section titled “description”Description of the remote.
Type: string
Anonymous access to public buckets
Section titled “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 = s3provider = AWSThen use it as normal with the name of the public bucket, e.g.
rclone lsd anons3:1000genomesYou 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:1000genomesProviders
Section titled “Providers”AWS S3
Section titled “AWS S3”This is the provider used as main example and described in the configuration section above.
AWS Directory Buckets
Section titled “AWS Directory Buckets”From rclone v1.69 Directory Buckets are supported.
You will need to set the directory_bucket = true config parameter
or use --s3-directory-bucket.
Note that rclone cannot yet:
- Create directory buckets
- List directory buckets
See the --s3-directory-bucket flag for more info
AWS Snowball Edge
Section titled “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 = s3provider = Otheraccess_key_id = YOUR_ACCESS_KEYsecret_access_key = YOUR_SECRET_KEYendpoint = http://[IP of Snowball]:8080upload_cutoff = 0Alibaba OSS
Section titled “Alibaba OSS”Here is an example of making an Alibaba Cloud (Aliyun) OSS configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/s/q> nname> ossType 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> s3Choose 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> AlibabaGet 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> 1AWS Access Key ID.Leave blank for anonymous access or runtime credentials.Enter a string value. Press Enter for the default ("").access_key_id> accesskeyidAWS Secret Access Key (password)Leave blank for anonymous access or runtime credentials.Enter a string value. Press Enter for the default ("").secret_access_key> secretaccesskeyEndpoint 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> 1Canned ACL used when creating buckets and storing or copying objects.
Note that this ACL is applied when server-side copying objects as S3doesn'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> 1The 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> 1Edit advanced config? (y/n)y) Yesn) Noy/n> nRemote config--------------------[oss]type = s3provider = Alibabaenv_auth = falseaccess_key_id = accesskeyidsecret_access_key = secretaccesskeyendpoint = oss-cn-hangzhou.aliyuncs.comacl = privatestorage_class = Standard--------------------y) Yes this is OKe) Edit this remoted) Delete this remotey/e/d> yArvanCloud
Section titled “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 remotes) Set configuration passwordn/s> nname> ArvanCloudType 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> s3Get 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> 1AWS Access Key ID - leave blank for anonymous access or runtime credentials.access_key_id> YOURACCESSKEYAWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.secret_access_key> YOURSECRETACCESSKEYRegion 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.comLocation 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-aclChoose 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 = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion = ir-thr-at1endpoint = s3.arvanstorage.comlocation_constraint =acl =server_side_encryption =storage_class =--------------------y) Yes this is OKe) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[ArvanCloud]type = s3provider = ArvanCloudenv_auth = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion =endpoint = s3.arvanstorage.comlocation_constraint =acl =server_side_encryption =storage_class =BizflyCloud
Section titled “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 = s3provider = BizflyCloudenv_auth = falseaccess_key_id = YOUR_ACCESS_KEYsecret_access_key = YOUR_SECRET_KEYregion = HNendpoint = hn.ss.bfcplatform.vnlocation_constraint =acl =server_side_encryption =storage_class =Switch region and endpoint to HCM and hcm.ss.bfcplatform.vn for Ho Chi
Minh City.
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 = s3provider = Cephenv_auth = falseaccess_key_id = XXXsecret_access_key = YYYregion =endpoint = https://ceph.endpoint.example.comlocation_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.
Rclone defaults sign_accept_encoding to false for the Ceph provider.
That avoids SignatureDoesNotMatch errors when a reverse proxy (for
example Cloudflare) rewrites the Accept-Encoding request header. You
can override this with --s3-sign-accept-encoding / sign_accept_encoding
if needed.
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)
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/s/q> nname> ChinaMobileOption 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> s3Option 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> ChinaMobileOption 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> accesskeyidOption 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> secretaccesskeyOption 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> 1Option 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> 1Option 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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> privateOption 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) Yesn) No (default)y/n> n--------------------[ChinaMobile]type = s3provider = ChinaMobileaccess_key_id = accesskeyidsecret_access_key = secretaccesskeyendpoint = eos-wuxi-1.cmecloud.cnlocation_constraint = wuxi1acl = private--------------------y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yCloudflare R2
Section titled “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 configThis 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 remotes) Set configuration passwordq) Quit confign/s/q> nname> r2Option 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> s3Option 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> CloudflareOption 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> 1Option 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_KEYOption 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_KEYOption 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> 1Option 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.comEdit advanced config?y) Yesn) No (default)y/n> n--------------------y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave your config looking something like:
[r2]type = s3provider = Cloudflareaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_ACCESS_KEYregion = autoendpoint = https://ACCOUNT_ID.r2.cloudflarestorage.comacl = privateNow 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
Section titled “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> s3provider> Cubbitenv_auth> falseaccess_key_id> YOUR_ACCESS_KEYsecret_access_key> YOUR_SECRET_KEYregion> 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 = s3provider = Cubbitaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_KEYregion = eu-west-1endpoint = s3.cubbit.euYou 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-bucketrclone copy /path/to/files cubbit-ds3:my-bucketDigitalOcean Spaces
Section titled “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> s3env_auth> 1access_key_id> YOUR_ACCESS_KEYsecret_access_key> YOUR_SECRET_KEYregion>endpoint> nyc3.digitaloceanspaces.comlocation_constraint>acl>storage_class>The resulting configuration file should look like:
[spaces]type = s3provider = DigitalOceanenv_auth = falseaccess_key_id = YOUR_ACCESS_KEYsecret_access_key = YOUR_SECRET_KEYregion =endpoint = nyc3.digitaloceanspaces.comlocation_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-spacerclone copy /path/to/files spaces:my-new-spaceDreamhost
Section titled “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 = s3provider = DreamHostenv_auth = falseaccess_key_id = your_access_keysecret_access_key = your_secret_keyregion =endpoint = objects-us-west-1.dream.iolocation_constraint =acl = privateserver_side_encryption =storage_class =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 remotes) Set configuration passwordq) Quit confign/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) Yesn) No (default)y/n> nAnd the config generated will end up looking like this:
[exaba]type = s3provider = Exabaaccess_key_id = XXXsecret_access_key = XXXendpoint = http://127.0.0.1:9000/Fastly Object Storage
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.appKeep this "fastly" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThe resulting configuration file should look like:
[fastly]type = s3provider = Fastlyaccess_key_id = YOUR_ACCESS_KEYsecret_access_key = YOUR_SECRET_KEYregion = us-eastendpoint = us-east.object.fastlystorage.appGoogle Cloud Storage
Section titled “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 = s3provider = GCSaccess_key_id = your_access_keysecret_access_key = your_secret_keyendpoint = https://storage.googleapis.comNote 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 NextKeyMarkerThis is Google bug #312292516.
Hetzner Object Storage
Section titled “Hetzner Object Storage”Here is an example of making a Hetzner Object Storage configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n
Enter name for new remote.name> my-hetznerOption 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> s3Option 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> HetznerOption 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_KEYOption 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_KEYOption 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 StorageChoose 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) No (default)y/n>Configuration complete.Options:- type: s3- provider: Hetzner- access_key_id: ACCESS_KEY- secret_access_key: SECRET_KEYKeep this "my-hetzner" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d>Current remotes:
Name Type==== ====my-hetzner s3
e) Edit existing remoten) New remoted) Delete remoter) Rename remotec) Copy remotes) Set configuration passwordq) Quit confige/n/d/r/c/s/q>This will leave the config file looking like this.
[my-hetzner]type = s3provider = Hetzneraccess_key_id = ACCESS_KEYsecret_access_key = SECRET_KEYregion = hel1endpoint = hel1.your-objectstorage.comacl = privateHitachi Content Platform (HCP)
Section titled “Hitachi Content Platform (HCP)”Here is an example of making a Hitachi Content Platform (HCP) configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n
Enter name for new remote.name> my-hcpOption 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> s3Option 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> HCPOption 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_KEYOption 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_KEYOption endpoint.Endpoint for HCP S3 compatible API.Enter a value. Press Enter to leave empty.endpoint> https://hcp.example.comEdit advanced config?y) Yesn) 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.comKeep this "my-hcp" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d>Current remotes:
Name Type==== ====my-hcp s3
e) Edit existing remoten) New remoted) Delete remoter) Rename remotec) Copy remotes) Set configuration passwordq) Quit confige/n/d/r/c/s/q>This will leave the config file looking like this.
[my-hcp]type = s3provider = HCPaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_KEYendpoint = https://hcp.example.comKnown limitations
Section titled “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
Section titled “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 = s3provider = HuaweiOBSaccess_key_id = your-access-key-idsecret_access_key = your-secret-access-keyregion = af-south-1endpoint = obs.af-south-1.myhuaweicloud.comacl = privateOr you can also configure via the interactive command line:
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/s/q> nname> obsOption 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> s3Option 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> 9Option 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> 1Option 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-idOption 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-keyOption 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> 1Option 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> 1Option 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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> 1Edit advanced config?y) Yesn) No (default)y/n>--------------------[obs]type = s3provider = HuaweiOBSaccess_key_id = your-access-key-idsecret_access_key = your-secret-access-keyregion = af-south-1endpoint = obs.af-south-1.myhuaweicloud.comacl = private--------------------y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yCurrent remotes:
Name Type==== ====obs s3
e) Edit existing remoten) New remoted) Delete remoter) Rename remotec) Copy remotes) Set configuration passwordq) Quit confige/n/d/r/c/s/q> qIBM COS (S3)
Section titled “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 defaultsNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/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 value1 / 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 value1 / 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-aclChoose a number from below, or type in your own value1 / 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 = s3Provider = IBMCOSaccess_key_id = xxxsecret_access_key = yyyendpoint = s3-api.us-geo.objectstorage.softlayer.netlocation_constraint = us-standardacl = private -
Execute rclone commands
1) Create a bucket. rclone mkdir IBM-COS-XREGION:newbucket2) 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 newbucket3) List contents of a bucket. rclone ls IBM-COS-XREGION:newbucket 18685952 test.exe4) Copy a file from local to remote. rclone copy /Users/file.txt IBM-COS-XREGION:newbucket5) 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.txtIBM IAM authentication
Section titled “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_idandsecret_access_keyblank -
Paste your
ibm_api_keyOption ibm_api_key.IBM API Key to be used to obtain IAM tokenEnter a value of type string. Press Enter for the default (1).ibm_api_key> -
Paste your
ibm_resource_instance_idOption ibm_resource_instance_id.IBM service instance idEnter a value of type string. Press Enter for the default (2).ibm_resource_instance_id> -
In advanced settings type true for
v2_authOption 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
Section titled “IDrive e2”Here is an example of making an IDrive e2 configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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) Yesn) 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.comKeep this "e2" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yImpossible Cloud
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n
Enter name for new remote.name> my-impossible-cloudOption 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> s3Option 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> ImpossibleCloudOption 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_KEYOption 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_KEYOption 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> 1Option endpoint.Endpoint for Impossible Cloud Object StorageChoose 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> 1Option 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.netKeep this "my-impossible-cloud" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d>Current remotes:
Name Type==== ====my-impossible-cloud s3
e) Edit existing remoten) New remoted) Delete remoter) Rename remotec) Copy remotes) Set configuration passwordq) Quit confige/n/d/r/c/s/q>This will leave the config file looking like this.
[my-impossible-cloud]type = s3provider = ImpossibleCloudaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_KEYregion = eu-central-2endpoint = eu-central-2.storage.impossibleapi.netacl = privateIntercolo Object Storage
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.comKeep this "intercolo" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[intercolo]type = s3provider = Intercoloaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_KEYregion = de-fraendpoint = de-fra.i3storage.comIONOS Cloud
Section titled “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-fraType 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> s3Type 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> IONOSPress 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_KEYChoose 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> 2Choose 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> 1Press 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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) Yesn) 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.comKeep this "ionos-fra" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yDone! 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)
Terminal window rclone mkdir ionos-fra:my-bucket -
List available buckets
Terminal window rclone lsd ionos-fra: -
Copy a file from local to remote
Terminal window rclone copy /Users/file.txt ionos-fra:my-bucket -
List contents of a bucket
Terminal window rclone ls ionos-fra:my-bucket -
Copy a file from remote to local
Terminal window rclone copy ionos-fra:my-bucket/file.txt
Leviia Cloud Object Storage
Section titled “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 configand selectnfor a new remote.rclone configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n -
Give the name of the configuration. For example, name it ‘leviia’.
name> leviia -
Select
s3storage.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
Leviiaprovider.Choose a number from below, or type in your own value1 / 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 value1 / Enter AWS credentials in the next step\ "false"2 / Get AWS credentials from the environment (env vars or IAM)\ "true"env_auth> 1AWS Access Key ID.Leave blank for anonymous access or runtime credentials.Enter a string value. Press Enter for the default ("").access_key_id> ZnIx.xxxxxxxxxxxxxxxAWS 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 endpoint1 | Leviia.\ (s3.leviia.com)[snip]endpoint> 1 -
Choose acl.
Note that this ACL is applied when server-side copying objects as S3doesn'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> 1Edit advanced config? (y/n)y) Yesn) No (default)y/n> nRemote 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 remoted) Delete this remotey/e/d> yCurrent remotes:Name Type==== ====leviia s3
Here is an example of making a Liara Object Storage configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordn/s> nname> LiaraType 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> s3Get 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> 1AWS Access Key ID - leave blank for anonymous access or runtime credentials.access_key_id> YOURACCESSKEYAWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.secret_access_key> YOURSECRETACCESSKEYRegion 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.spaceCanned 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-aclChoose 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 = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYendpoint = storage.iran.liara.spacelocation_constraint =acl =server_side_encryption =storage_class =--------------------y) Yes this is OKe) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[Liara]type = s3provider = Liaraenv_auth = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion =endpoint = storage.iran.liara.spacelocation_constraint =acl =server_side_encryption =storage_class =Linode
Section titled “Linode”Here is an example of making a Linode Object Storage configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.comKeep this "linode" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[linode]type = s3provider = Linodeaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_ACCESS_KEYendpoint = eu-central-1.linodeobjects.comLinode Object Storage is Ceph-backed. Rclone defaults
sign_accept_encoding to false for this provider so SigV4 requests do
not fail with SignatureDoesNotMatch (see the Ceph section).
Magalu
Section titled “Magalu”Here is an example of making a Magalu Object Storage configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.comKeep this "magalu" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[magalu]type = s3provider = Magaluaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_ACCESS_KEYendpoint = br-ne1.magaluobjects.comMEGA S4
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.ioKeep this "megas4" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[megas4]type = s3provider = Megaaccess_key_id = XXXsecret_access_key = XXXendpoint = s3.eu-central-1.s4.mega.ioMinio 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:9000AccessKey: USWUXHGYZQYFYFFIT3RESecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03Region: us-east-1SQS 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 TotalThese details need to go into rclone config like this. Note that it
is important to put the region in as stated above.
env_auth> 1access_key_id> USWUXHGYZQYFYFFIT3REsecret_access_key> MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03region> us-east-1endpoint> http://192.168.1.106:9000location_constraint>server_side_encryption>Which makes the config file look like this
[minio]type = s3provider = Minioenv_auth = falseaccess_key_id = USWUXHGYZQYFYFFIT3REsecret_access_key = MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03region = us-east-1endpoint = http://192.168.1.106:9000location_constraint =server_side_encryption =So once set up, for example, to copy files into a bucket
rclone copy /path/to/files minio:bucketNetease NOS
Section titled “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
Section titled “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 = s3provider = Outscaleenv_auth = falseaccess_key_id = ABCDEFGHIJ0123456789secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXregion = eu-west-2endpoint = oos.eu-west-2.outscale.comacl = privateYou can also run rclone config to go through the interactive setup process:
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/s/q> nEnter name for new remote.name> outscaleOption 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> outscaleOption 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> OutscaleOption 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> ABCDEFGHIJ0123456789Option 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> XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXOption 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> 1Option 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> 1Option 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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> 1Edit advanced config?y) Yesn) No (default)y/n> nConfiguration complete.Options:- type: s3- provider: Outscale- access_key_id: ABCDEFGHIJ0123456789- secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX- endpoint: oos.eu-west-2.outscale.comKeep this "outscale" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yOVHcloud
Section titled “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 remotes) Set configuration passwordq) Quit confign/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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: privateKeep this "ovhcloud-rbx" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yYour configuration file should now look like this:
[ovhcloud-rbx]type = s3provider = OVHcloudaccess_key_id = my_accesssecret_access_key = my_secretregion = rbxendpoint = s3.rbx.io.cloud.ovh.netacl = privatePetabox
Section titled “Petabox”Here is an example of making a Petabox configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordn/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.ioKeep this "My Petabox Storage" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[My Petabox Storage]type = s3provider = Petaboxaccess_key_id = YOUR_ACCESS_KEY_IDsecret_access_key = YOUR_SECRET_ACCESS_KEYregion = us-east-1endpoint = s3.petabox.ioPure Storage FlashBlade
Section titled “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 configThis will guide you through an interactive setup process:
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.comKeep this "flashblade" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis results in the following configuration being stored in ~/.config/rclone/rclone.conf:
[flashblade]type = s3provider = FlashBladeaccess_key_id = ACCESS_KEY_IDsecret_access_key = SECRET_ACCESS_KEYendpoint = https://s3.flashblade.example.comNote: 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)
Section titled “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 configand selectnfor a new remote.rclone configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n -
Give the name of the configuration. For example, name it ‘qiniu’.
name> qiniu -
Select
s3storage.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
Qiniuprovider.Choose a number from below, or type in your own value1 / 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 value1 / Enter AWS credentials in the next step\ "false"2 / Get AWS credentials from the environment (env vars or IAM)\ "true"env_auth> 1AWS Access Key ID.Leave blank for anonymous access or runtime credentials.Enter a string value. Press Enter for the default ("").access_key_id> AKIDxxxxxxxxxxAWS 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> 1Option 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> 1Option 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 S3doesn'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> 2The 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 value1 / 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> 1Edit advanced config? (y/n)y) Yesn) No (default)y/n> nRemote 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 remoted) Delete this remotey/e/d> yCurrent remotes:Name Type==== ====qiniu s3
FileLu S5
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit confign/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) Yesn) No (default)y/n> n
Configuration complete.Options:- type: s3- provider: FileLu- access_key_id: XXX- secret_access_key: XXX- endpoint: s5lu.comKeep this "s5lu" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[s5lu]type = s3provider = FileLuaccess_key_id = XXXsecret_access_key = XXXendpoint = s5lu.comRabata
Section titled “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 configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/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) Yesn) 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-2Keep this "rabata" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> y
Current remotes:
Name Type==== ====rabata s3RackCorp
Section titled “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 = s3provider = RackCorpenv_auth = trueaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion = au-nswendpoint = s3.rackcorp.comlocation_constraint = au-nswRclone Serve S3
Section titled “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:pathThis will be compatible with an rclone remote which is defined like this:
[serves3]type = s3provider = Rcloneendpoint = http://127.0.0.1:8080/access_key_id = ACCESS_KEY_IDsecret_access_key = SECRET_ACCESS_KEYuse_multipart_uploads = falseNote that setting use_multipart_uploads = false is to work around
a bug which will be fixed in due course.
Scaleway
Section titled “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 = s3provider = Scalewayenv_auth = falseendpoint = s3.nl-ams.scw.cloudaccess_key_id = SCWXXXXXXXXXXXXXXsecret_access_key = 1111111-2222-3333-44444-55555555555555region = nl-amslocation_constraint = nl-amsacl = privateupload_cutoff = 5Mchunk_size = 5Mcopy_cutoff = 5MScaleway 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)
Scality
Section titled “Scality”Scality RING and ARTESCA both expose an
S3-compatible object storage API that works with rclone using s3 as the
type and Scality as the provider.
Both products are S3 clones, so you always need to set the endpoint to the
S3 API of your deployment (the S3 Connector service on RING, or the S3
data-service endpoint on ARTESCA). The Scality provider uses path-style
addressing (endpoint/bucket/key) which is supported out of the box and does
not require any wildcard/virtual-host DNS entries.
Get your access key, secret key and endpoint from your Scality administrator
(on ARTESCA these are created per account under Identity > Accounts in the
UI; on RING they are created with vaultclient or the S3 Console).
Here is an example of making a Scality configuration. First run:
rclone configThis will guide you through an interactive setup process.
No remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n
Enter name for new remote.name> scality
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, ...Scaleway, Scality, SeaweedFS, ... \ (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 / Scality (RING / ARTESCA) \ (Scality)[snip]provider> Scality
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. / 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>
Option endpoint.Endpoint for S3 API.Required when using an S3 clone.Enter a value. Press Enter to leave empty.endpoint> https://s3.example.com
Edit advanced config?y) Yesn) No (default)y/n>
Configuration complete.Options:- type: s3- provider: Scality- access_key_id: S3_ACCESS_KEY- secret_access_key: S3_SECRET_KEY- endpoint: https://s3.example.comKeep this "scality" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[scality]type = s3provider = Scalityaccess_key_id = S3_ACCESS_KEYsecret_access_key = S3_SECRET_KEYendpoint = https://s3.example.comSeagate Lyve Cloud
Section titled “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 configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> nname> remoteChoose 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> s3Choose 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> LyveCloudTake 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> XXXAWS Secret Access Key (password).Leave blank for anonymous access or runtime credentials.Enter a value. Press Enter to leave empty.secret_access_key> YYYLeave 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.comLeave 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 = s3provider = LyveCloudaccess_key_id = XXXsecret_access_key = YYYendpoint = s3.us-east-1.lyvecloud.seagate.comSeaweedFS
Section titled “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 = s3provider = SeaweedFSaccess_key_id = anysecret_access_key = anyendpoint = localhost:8333So once set up, for example to copy files into a bucket
rclone copy /path/to/files seaweedfs_s3:fooSelectel
Section titled “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 remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.ruKeep this "selectel" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yAnd your config should end up looking like this:
[selectel]type = s3provider = Selectelaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_ACCESS_KEYregion = ru-1endpoint = s3.ru-1.storage.selcloud.ruServercore
Section titled “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 remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.ruKeep this "servercore" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> ySpectra Logic
Section titled “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 remotes) Set configuration passwordq) Quit confign/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) Yesn) 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.comKeep this "spectratest" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yAnd your config should end up looking like this:
[spectratest]type = s3provider = SpectraLogicaccess_key_id = ACCESS_KEYsecret_access_key = SECRET_ACCESS_KEYendpoint = https://bp.example.comStorj 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> s3Get 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> 1Option 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) Yesn) No (default)y/n> nNote that s3 credentials are generated when you create an access grant.
Backend quirks
Section titled “Backend quirks”--chunk-sizeis 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
Section titled “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 rcatwill fail as the metadata doesn’t match after upload - Uploading files with
rclone mountwill fail for the same reason- This can worked around by using
--vfs-cache-mode writesor--vfs-cache-mode fullor setting--s3-upload-cutofflarge
- This can worked around by using
- Files uploaded via a multipart upload won’t have their modtimes
- This will mean that
rclone syncwill likely keep trying to upload files bigger than--s3-upload-cutoff - This can be worked around with
--checksumor--size-onlyor setting--s3-upload-cutofflarge - The maximum value for
--s3-upload-cutoffis 5GiB though
- This will mean that
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
Section titled “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
Section titled “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 configThis will guide you through an interactive setup process.
No remotes found, make a new one\?n) New remotes) Set configuration passwordq) Quit config
n/s/q> n
Enter name for new remote.1name> 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) Yesn) Noy/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 transactionsrclone does if you know the bucket exists already.It can also be needed if the user you are using does not have bucketcreation permissions. Before v1.52.0 this would have passed silentlydue 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: trueKeep this "syno" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remote
y/e/d> yTencent COS
Section titled “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 configand selectnfor a new remote.rclone configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n -
Give the name of the configuration. For example, name it ‘cos’.
name> cos -
Select
s3storage.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
TencentCOSprovider.Choose a number from below, or type in your own value1 / 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 value1 / Enter AWS credentials in the next step\ "false"2 / Get AWS credentials from the environment (env vars or IAM)\ "true"env_auth> 1AWS Access Key ID.Leave blank for anonymous access or runtime credentials.Enter a string value. Press Enter for the default ("").access_key_id> AKIDxxxxxxxxxxAWS 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 S3doesn'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 value1 / Owner gets Full_CONTROL. No one else has access rights (default).\ "default"[snip]acl> 1The 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 value1 / Default\ ""[snip]storage_class> 1Edit advanced config? (y/n)y) Yesn) No (default)y/n> nRemote config--------------------[cos]type = s3provider = TencentCOSenv_auth = falseaccess_key_id = xxxsecret_access_key = xxxendpoint = cos.ap-guangzhou.myqcloud.comacl = default--------------------y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yCurrent remotes:Name Type==== ====cos s3
Tencent COS Global Acceleration Endpoint
Section titled “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 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:
Terminal window rclone configNo remotes found, make a new one?n) New remotes) Set configuration passwordq) Quit confign/s/q> n -
Give the name of the configuration. For example, name it ‘US3’.
name> US3 -
Select
s3storage.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
US3provider.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 value1 / Enter AWS credentials in the next step\ "false"2 / Get AWS credentials from the environment (env vars or IAM)\ "true"env_auth> 1Option 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> AKIDxxxxxxxxxxAWS 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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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> 1The 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 value1 / Default\ ""[snip]storage_class> 1Edit advanced config? (y/n)y) Yesn) No (default)y/n> nConfiguration complete.Options:- type: s3- provider: US3- access_key_id: xx- secret_access_key: xx- endpoint: s3-cn-bj.ufileos.com- acl: privateKeep this "US3" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yCurrent remotes:Name Type==== ====US3 s3
Wasabi
Section titled “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 remotes) Set configuration passwordn/s> nname> wasabiType 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> s3Get 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> 1AWS Access Key ID - leave blank for anonymous access or runtime credentials.access_key_id> YOURACCESSKEYAWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials.secret_access_key> YOURSECRETACCESSKEYRegion 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-1Endpoint 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.comLocation 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-aclChoose 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 = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion = us-east-1endpoint = s3.wasabisys.comlocation_constraint =acl =server_side_encryption =storage_class =--------------------y) Yes this is OKe) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[wasabi]type = s3provider = Wasabienv_auth = falseaccess_key_id = YOURACCESSKEYsecret_access_key = YOURSECRETACCESSKEYregion =endpoint = s3.wasabisys.comlocation_constraint =acl =server_side_encryption =storage_class =Zadara Object Storage
Section titled “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 configThis will guide you through an interactive setup process:
No remotes found, make a new one\?n) New remotes) Set configuration passwordn/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) Yesn) 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.comKeep this "Zadara-Object-Storage" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d> yThis will leave the config file looking like this.
[Zadara-Object-Storage]type = s3provider = Zadaraaccess_key_id = S3_ACCESS_KEYsecret_access_key = S3_SECRET_KEYendpoint = https://vsa-00000001-public-zadara-cloud-01.zadarazios.comZata Object Storage
Section titled “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 configThis will guide you through an interactive setup process:
e) Edit existing remoten) New remoted) Delete remoter) Rename remotec) Copy remotes) Set configuration passwordq) Quit confige/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-aclNote that this ACL is applied when server-side copying objects as S3doesn'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 andthe 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) Yesn) 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.aiKeep this "my zata storage" remote?y) Yes this is OK (default)e) Edit this remoted) Delete this remotey/e/d>This will leave the config file looking like this.
[my zata storage]type = s3provider = Zataaccess_key_id = xxxsecret_access_key = xxxregion = us-east-1endpoint = idr01.zata.aiZero Services (ZERO-Z3)
Section titled “Zero Services (ZERO-Z3)”Zero Services GmbH offers ZERO-Z3, S3-compatible object storage hosted in the EU on its own network (AS215197). It is built on Ceph RADOS Gateway.
First run:
rclone configThis will guide you through an interactive setup process:
n) New remoten/s/q> n
Enter name for new remote.name> zero-z3
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, ..., ZeroServices, ... and others \ (s3)Storage> s3
Option provider.Choose your S3 provider.[snip]XX / Zero Services GmbH (ZERO-Z3) \ (ZeroServices)provider> ZeroServices
Option env_auth.Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars). 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.access_key_id> ACCESS_KEY
Option secret_access_key.AWS Secret Access Key (password).secret_access_key> SECRET_KEY
Option region.Region to connect to. 1 / Frankfurt 1 \ (zero-fra1) 2 / Frankfurt 2 \ (zero-fra2) 3 / Eyl 1 \ (zero-eyl1)region> 2
Option endpoint.Endpoint for ZERO-Z3. 1 / Frankfurt 1 \ (fra1.s3.zeroservices.eu) 2 / Frankfurt 2 \ (fra.s3.zeroservices.eu) 3 / Eyl 1 \ (eyl1.s3.zeroservices.eu)endpoint> 2
Option acl.Canned ACL used when creating buckets and storing or copying objects.[snip]acl> 1
Edit advanced config?y/n> n
Configuration complete.Options:- type: s3- provider: ZeroServices- access_key_id: ACCESS_KEY- secret_access_key: SECRET_KEY- region: zero-fra2- endpoint: fra.s3.zeroservices.euKeep this "zero-z3" remote?y/e/d> yMemory usage
Section titled “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
Section titled “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.