Skip to main content

rclone

rclone is a free tool for managing files and folders on cloud storage on Windows, macOS, Linux and FreeBSD. This includes protocols including S3 compatible Object Storage.

Please follow the installation instructions described on rclone. We generally recommend using the latest stable release from there and not installing rclone via your distro's package manager. E.g. the download/upload speed can suffer from older rclone versions.

All you will need is:

  • access_key
  • secret_key
  • Contabo's S3 URL

For access_key, secret_key and the S3 URL please check here.

Configuration for Contabo's S3 compatible Object Storage​

Example values​

Steps​

  1. run rclone config
  2. specify n for n) New remote
  3. specify a name, e.g. eu2
  4. specify 5 for Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, China Mobile, Cloudflare, GCS, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Liara, Lyve Cloud, Minio, Netease, Petabox, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, Qiniu and Wasabi
  5. specify 4 for Ceph Object Storage
  6. specify 1 for Enter AWS credentials in the next step.
  7. specify your access_key, e.g. 82046e8110804a43bf29c1ae426a724d for access_key_id
  8. specify your secret_key, e.g. 82e69bd7a52076c527154297a76c2233 for secret_access_key
  9. press return to skip region
  10. specify the S3 URL, e.g. https://eu2.contabostorage.com for endpoint
  11. press return to skip location_constraint
  12. press return to skip acl
  13. press return to skip server_side_encryption
  14. press return to skip sse_kms_key_id
  15. specify n for Edit advanced config
  16. specify y for Yes this is OK (default)
  17. optionally specify q to quit the configuration mode

rclone config​

[eu2]
type = s3
provider = Ceph
access_key_id = 82046e8110804a43bf29c1ae426a724d
secret_access_key = 82e69bd7a52076c527154297a76c2233
endpoint = https://eu2.contabostorage.com/

Usage​

Example to sync the entire current folder to Object Storage:

rclone sync -P . eu2:bucketname/folder

Mount​

Filesystem Caveats

Please note that that a mounted Object Storage bucket doesn't always behave like a normal POSIX file system. Depending on how your application is accessing files, you may encounter issues like:

  • no/wrong file system usage statistics
  • sub-par performance
  • unexpected unmounts
  • duplicate writes leading to hidden objects that occupy space but are invisible to S3 API requests

Example to mount a bucket to /mnt with recommend flags for optimal performance:

rclone mount eu2:bucketname /mnt --vfs-cache-mode full --vfs-fast-fingerprint --no-modtime

To learn more about available mount options, check the rclone mount documentation.