Skip to main content

Rclone

Overview​

Rclone is a powerful command-line program for managing files on cloud storage. It supports a wide range of cloud providers, including S3-compatible services like Vietnix Cloud S3 Storage. Rclone is available for Windows, macOS, and Linux, and is ideal for syncing, copying, and automating file operations.

How to Connect Rclone to Vietnix Cloud S3 Storage​

Follow these steps to configure Rclone with Vietnix Cloud S3 Storage:

1. Download and Install Rclone​

  • Visit https://rclone.org/downloads/ to download the latest version for your operating system.
  • Follow the installation instructions for your platform.

2. Get Your Vietnix S3 Credentials​

You will need:

  • Access Key
  • Secret Key
  • Endpoint URL (e.g. https://s3.vn-hcm-1.vietnix.cloud)
  • Bucket Name

Find these details in your Vietnix Cloud Portal.

3. Configure Rclone Remote​

  1. Open a terminal or command prompt.
  2. Run the following command to start configuration: 
    rclone config
  3. Choose n for a new remote and give it a name (e.g. vietnix-s3).
  4. Select S3 as the storage type.
  5. Enter your Access Key ID and Secret Access Key.
  6. For endpoint, enter your Vietnix S3 Endpoint URL (e.g. https://s3.vn-hcm-1.vietnix.cloud).
  7. Set region to vn-hcm-1 or leave blank if not required.
  8. Choose V4 for signature version.
  9. Leave other options as default or adjust as needed.

Example Minimal Configuration​

Your rclone.conf might look like:

[vietnix-s3]
type = s3
provider = Other
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = https://s3.vn-hcm-1.vietnix.cloud
region = vn-hcm-1

4. Test the Connection​

List buckets:

rclone lsd vietnix-s3:

List objects in a bucket:

rclone ls vietnix-s3:your-bucket-name

5. Common Operations​

  • Sync local folder to S3 bucket: 
    rclone sync /path/to/local/folder vietnix-s3:your-bucket-name
  • Copy files from S3 bucket to local: 
    rclone copy vietnix-s3:your-bucket-name /path/to/local/folder

Refer to Rclone documentation for advanced usage and automation.

note
  • Keep your credentials secure and rotate them regularly.
  • For troubleshooting and advanced features, refer to the Rclone Wiki.