Rclone Documentation
Rclone is a production-ready command-line tool for syncing, copying, and validating files across local storage and cloud providers.
Who This Track Is For
- Operators running backups, migrations, and restores for servers and VPS
- Developers shipping artifacts to object storage (S3-compatible)
- Anyone who needs repeatable, audited file movement with safety controls
What You Will Build
- A reliable local-plus-cloud backup workflow
- Secure encrypted remotes for sensitive data
- Automated jobs with retry, logging, and alerting
- Repeatable restore drills with RTO/RPO targets
How To Use This Track
- Follow the modules in order (1 to 11). Each lesson includes a safe workflow and a drill/exercise.
- Prefer copy/paste scripts over one-off commands for production.
- Treat destructive operations (sync/delete) like migrations: preview, log, verify, and keep rollback.
Learning Path
| Module | Focus | Lessons |
|---|---|---|
| 1. Introduction | Fundamentals and tooling fit | 3 |
| 2. Commands | Daily command patterns | 3 |
| 3. Remotes and Auth | Provider setup and credentials | 3 |
| 4. Filtering and Selection | Precision control over file sets | 3 |
| 5. Performance and Transfers | Throughput and stability tuning | 3 |
| 6. Sync Safety and Deletes | Safe mirroring and rollback paths | 3 |
| 7. Encryption and Security | Data protection and key hygiene | 3 |
| 8. Automation and Operations | Scheduled and unattended jobs | 3 |
| 9. Backup and DR Strategies | Recovery-focused architecture | 4 |
| 10. Troubleshooting | Root-cause debugging workflow | 3 |
| 11. Cheatsheet | Fast operational reference | 3 |
Common Architectures
1) Local Data -> Cloud Mirror
flowchart LR
SRC[Source: /srv/data] -->|rclone sync| CLOUD[(Remote: backups/data)]
CLOUD -->|rclone check| VERIFY[Verification]
2) Rsync Local Snapshot -> Rclone Cloud Replication
flowchart LR
APP[Production Data] -->|rsync snapshot| LOCAL[Local Backup]
LOCAL -->|rclone sync| CLOUD[(Cloud Remote)]
3) Encrypted Offsite Backups (Crypt Remote)
flowchart LR
SRC[Source] -->|rclone sync| CRYPT[crypt remote]
CRYPT --> BASE[(base remote path)]
warning
Encryption is only as good as your key recovery. Store crypt secrets in a secure runbook and test restores.
Quick Start
first-rclone-run.sh
# 1) Configure a remote
rclone config
# 2) Verify access
rclone lsd myremote:
# 3) Safe preview before sync
rclone sync /srv/data myremote:backups/data --dry-run
# 4) Execute with logs
rclone sync /srv/data myremote:backups/data --log-level INFO --log-file /var/log/rclone.log
note
If you are running rclone via cron/systemd, always set an explicit config path (example: --config /etc/rclone/rclone.conf).
Learning Order
Follow the modules in order from 1 to 11. Each module assumes you practiced commands in the previous one.
Tooling Matrix
| Use Case | Best Tool | Why |
|---|---|---|
| Server-to-server delta copy | rsync | Block-level delta transfer over SSH |
| Multi-cloud/object storage sync | rclone | Native provider APIs and remote abstraction |
| Deduplicated encrypted snapshots | restic | Snapshot repository with retention policy |
Prerequisites
- Linux shell basics (
ls,cp, paths, permissions) - SSH key setup for remote hosts
- One cloud provider account (S3, B2, R2, GCS, Drive, or OneDrive)
Success Criteria
By the end of this track, you can:
- Deploy a safe, scheduled backup job with logs and alerts
- Use filters to avoid syncing caches, build artifacts, and secrets
- Encrypt backups with a crypt remote and prove restore works
- Run a restore drill and measure RTO/RPO
Next Step
Start with What is Rclone.