Object Storage - Use S3 Object Storage with rClone

Learn how to set up Rclone to synchronize your files to and from S3 Object Storage.

Last updated on 3rd January 2022

Objective

Rclone is a backup tool that can sync to and from various storage backends, and can be used on Windows, macOS and Linux.

This guide explains how to set up Rclone to synchronize your files to and from S3 Object Storage.

OVHcloud provides services which you are responsible for with regard to their configuration and management. You are therefore responsible for ensuring they function correctly.

This guide is designed to assist you in common tasks as much as possible. If you encounter any difficulties performing these actions, please contact a specialist service provider and/or discuss the issue with our community on https://community.ovh.com/en/. OVHcloud cannot provide you with technical support in this regard.

Requirements

  • A bucket
  • A user and defined the required access rights on the bucket
  • Your S3 credentials (access_key and secret_access_key)

See our Getting started with S3 Object Storage guide.

Instructions

To configure Rclone, edit or create the ~/.config/rclone/rclone.conf file and add this:

[<remote_name>]
type = s3
provider = Other
env_auth = false
access_key_id = <access_key>
secret_access_key = <secret_key>
endpoint = https://s3.<region_in_lowercase>.perf.cloud.ovh.net
acl = private
region = <region_in_lowercase>
location_constraint = <region_in_lowercase>

Rclone is now ready for use.

Command examples

List all buckets:

$ rclone lsd <remote_name>:

Create a new bucket:

$ rclone mkdir <remote_name>:mybucket

List the contents of a bucket:

$ rclone ls <remote_name>:mybucket

Synchronise /home/user/documents to a bucket:

$ rclone sync /home/user/documents <remote_name>:mybucket

Copy a file /home/user/file.txt into a bucket:

$ rclone copy /home/user/file.txt <remote_name>:mybucket

Download a file file.txt from a bucket:

$ rclone copy <remote_name>:mybucket/file.txt fichier.txt

You will find on the official rClone website a detailed documentation of the possible actions: Official rClone documentation.

Go further

Join our community of users on https://community.ovh.com/en/.


Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.


These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community