What is the rclone Tool?

What is the rclone tool?

rclone is a free tool for managing files and folders on cloud storage on Windows, macOS, Linux and FreeBSD. 


How do I install rclone?

Please follow the installation instructions described here. We generally recommend using the latest stable release from there. Installing rclone via your distro's package manager can cause the download/upload speed to suffer. Before installing rclone you will need the following information:

  • access_key
  • secret_key
  • Contabo's S3 URL


How do I configure rclone with Contabo's Object Storage?

  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.

How do I mount using rclone?

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

Below you can find an 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

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Modified on Tue, 30 Jul at 9:04 AM

Can’t find what you’re looking for?

Get in Touch

Do you have a pre-sales question?