Skip to main content
Browse documentation

Use rclone with Backup Storage

Use rclone's SFTP backend. Copy the host, port and username from Connection; authentication uses your SSH key.

Configure a remote​

Run rclone config, create a remote named cnbackup and select sftp as its type. Set the host, user storage, assigned port and private key file. Configure these options, using full local paths:

[cnbackup]
type = sftp
host = YOUR_STORAGE_HOST
user = storage
port = YOUR_ASSIGNED_PORT
key_file = /full/path/to/caliber-storage
known_hosts_file = /full/path/to/.ssh/known_hosts
disable_hashcheck = true
shell_type = none

First verify and save the host fingerprint using SFTP, so the known_hosts file contains the correct entry for this host and port. On Windows, use the paths on the machine running rclone. For a passphrase-protected key, use rclone's key-passphrase configuration or an SSH agent; follow the prompts instead of placing a plain passphrase in a shared script.

The hash-check setting avoids remote shell checksum commands. Files are transferred through SFTP.

List, upload and download​

rclone lsd cnbackup:/data
rclone copy ./documents cnbackup:/data/documents --progress
rclone copy cnbackup:/data/documents ./downloaded-documents --progress

copy adds and updates files without removing unrelated destination files. Use --dry-run to preview a command. sync makes the destination match the source and can delete files, so review its dry run before using it.

Check the content​

For a content check that reads the remote files instead of asking the server to calculate hashes:

rclone check ./documents cnbackup:/data/documents --download --one-way

This reads data back and uses transfer allowance. Large verification runs take time. Use operations and scheduling to plan repeat jobs.

Rclone's SFTP documentation describes key formats, SSH-agent authentication and other backend settings.