FAQ rclone - SynoCommunity/spksrc GitHub Wiki
At installation, the initial configuration for rclone is available under: /var/packages/rclone/var/rclone.conf
.
For package upgrade to preserve configuration, additional files and custom scripts must be placed under /var/packages/rclone/var/
.
Rclone is a powerful command-line tool for managing files on cloud storage. This package provides a straightforward way to set up and use rclone on your Synology NAS.
To add a new remote connection, use the following command:
rclone config
This will guide you through an interactive setup process. Your configuration will be automatically saved to /var/packages/rclone/var/rclone.conf
.
You can also create a connection non-interactively with:
rclone config create <name> <type> <key>=<value> <key2>=<value2>...
To sync a local folder to a remote destination:
rclone sync /path/to/local/folder remote:path/to/remote/folder
For creating backups with detailed logs:
rclone copy /path/to/source remote:backup --create-empty-src-dirs --log-file=/var/packages/rclone/var/backup.log
Mount a remote as a local filesystem (requires FUSE support, which may need additional setup):
rclone mount remote:path /path/to/mountpoint
You can create scheduled tasks using the Synology Task Scheduler. Create a script under /var/packages/rclone/var/scripts/
and make it executable.
Example script (/var/packages/rclone/var/scripts/daily-backup.sh
):
#!/bin/bash
/var/packages/rclone/target/bin/rclone sync /volume1/photos remote:photos \
--create-empty-src-dirs \
--log-file=/var/packages/rclone/var/logs/photos-backup.log
Don't forget to make your script executable:
chmod +x /var/packages/rclone/var/scripts/daily-backup.sh
To limit bandwidth usage during transfers:
rclone copy source:path dest:path --bwlimit 5M
This limits the transfer to 5 MB/s.
Rclone offers many advanced options for fine-tuning its behavior. You can create custom configuration files for different scenarios in /var/packages/rclone/var/configs/
.
Example using an alternative config file:
rclone --config=/var/packages/rclone/var/configs/special.conf sync source:path dest:path
-
Permission Denied: Ensure the commanding user has appropriate permissions to access the files and directories.
-
Connection Issues: Check your network configuration and firewall settings. Some cloud providers may have rate limiting that affects connections.
-
Transfer Failures: Use the
--retries=N
flag to automatically retry failed transfers.