Object Storage - Use S3 Object Storage with Rclone

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.

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

These guides might also interest you...