Use object storage (Rclone)

Manage object storage with Rclone — install, configure, common commands, advanced flags

Rclone is a powerful CLI tool for managing cloud storage — sync, transfer, cache, and manage files across many providers. This page shows how to drive Alaya NeW Object Storage with Rclone.

Prerequisites

An object-storage instance is already provisioned; see Object storage.

Install

Linux

Manual install

# Download and install
curl https://rclone.org/install.sh | sudo bash

# Verify
rclone --version

Via package manager

# Debian / Ubuntu
sudo apt update && sudo apt install rclone
rclone --version

# CentOS / RHEL
sudo yum install epel-release
sudo yum install rclone
rclone --version

# Fedora
sudo dnf install rclone
rclone --version

Windows

Download the latest installer from the Rclone downloads page.
Verify in cmd:
```
rclone --version
```

macOS

# Homebrew
brew install rclone

# Verify
rclone --version

Configure

You can configure either by editing the config file directly or by running the wizard. Editing the file is recommended.

Option 1: Config file (recommended)

Edit /root/.config/rclone/rclone.conf (Linux example):

[s3_store]                   # Custom name
type = s3
provider = Ceph
access_key_id = *******      # Replace with your access_key_id
secret_access_key = *******  # Replace with your secret_access_key
endpoint = https://s3.hd-01.alayanew.com:8082
acl = public-read-write
no_check_bucket = true

Variable	Description	Source	Example
`s3_store`	Custom name	You decide	`s3_store`
`access_key_id`	Access Key ID	SMS notification	`Asjnf****233s`
`secret_access_key`	Secret Access Key	SMS notification	`sder*******nfksu9j5lw`
`endpoint`	Endpoint URL	OSS detail page	`https://s3.hd-01.alayanew.com:8082`

Option 2: `rclone config` wizard

rclone config

Select n to create a new remote, name it (e.g. s3_store), pick s3 as the type, complete authentication, and q to quit.

Common commands

Command	Description
`rclone lsd`	List directories / containers / buckets at the path
`rclone ls`	List object sizes and paths
`rclone copy`	Copy files
`rclone move`	Move files
`rclone delete`	Delete files or directories
`rclone rmdir`	Delete empty directories
`rclone sync`	Sync files (modifies destination only)
`rclone help`	Show help
`rclone help <command>`	Show help for a specific command
`rclone listremotes`	List configured remotes
`rclone config show <name>`	Show a remote's config

Advanced

Command	Description
`rclone copy /local s3_store:/remote --bwlimit 1M`	Limit transfer rate
`rclone copy /local s3_store:/remote --retries 3`	Retry failed transfers
`rclone copy /local s3_store:/remote --log-file transfer.log`	Log transfers
`rclone copy /local s3_store:/remote --progress`	Show progress
`rclone copy /local s3_store:/remote --include ".txt" --exclude ".log"`	Filter files
`rclone copy /local s3_store:/remote --transfers 4`	Concurrent transfers

For caching, encryption, and other features, see the Rclone docs.

Keep your Access Key ID and Secret Access Key safe — never check them into a repo.

Use object storage (Rclone)

On this page