Skip to Content
DocsApplicationsFile ManagementRclone
Rclone

Rclone

Cloud storage sync and mount utility for Google Drive or Dropbox remotes

Overview

Rclone is a command-line program for syncing files and directories between local storage and cloud providers. QuickBox installs it per user and builds a working directory that includes cache, mount points, and upload scripts.

Rclone is not a media server or download client; it focuses on syncing, mounting, and optional encryption of storage paths.

Key features

QuickBox provisions Rclone with standard mounts, a mergerfs overlay, and scheduled uploads.

🌐 Provider presets

Install with --gdrive or --dropbox; QuickBox creates a remote named gdrive or dropbox and builds the Media tree.

🔐 Optional crypt remote

Use --encrypted to create a crypt remote; encrypted installs mount crypt: to the same path.

🗂️ Managed mounts

Systemd unit rclone@username mounts to /home/username/rclone/gdrive or /home/username/rclone/dropbox with mergerfs overlays at /home/username/rclone/gmedia or /home/username/rclone/dmedia.

⏰ Scheduled uploads

A nightly cron entry runs /home/username/rclone/move.sh at 03:12 server time and writes to /home/username/rclone/move.log.

When to use it

Use Rclone when you want QuickBox to manage cloud mounts, overlays, and scheduled uploads.

Prerequisites

  • You need a per-user Google Drive or Dropbox mount managed by QuickBox.
  • You have provider client ID and client secret ready for setup prompts.
  • You want optional encryption with rclone crypt using two different passwords.
  • You prefer uploads handled by systemd and cron instead of custom scripts.

What you get

  • Install with qb install rclone -u username --gdrive or --dropbox to create remotes and mount targets.
  • Mount points are created under /home/username/rclone with cache, remote, and mergerfs overlay paths.
  • Uploads run through /home/username/rclone/move.sh on a nightly schedule.
  • Services include rclone@username and home-username-rclone-gmedia.mount or home-username-rclone-dmedia.mount.

Installation

Install from the QuickBox CLI

Rclone installs are managed with qb and require a username plus one provider flag. The beta branch is available with —beta.

Command
qb install rclone -u username --gdrive
Description
Install Rclone with a Google Drive remote and gmedia mergerfs mount.
Command
qb install rclone -u username --dropbox --encrypted
Description
Install with Dropbox and create a crypt remote for encrypted mounts.
Command
qb update rclone -u username --beta
Description
Update Rclone using the beta download branch.
Command
qb remove rclone -u username
Description
Remove Rclone for a user and clean its files.

CLI options

-u, --usernameRequired

Target QuickBox username (required).

--gdrive

Configure a Google Drive remote and mount to /home/username/rclone/gdrive with a gmedia mergerfs overlay.

--dropbox

Configure a Dropbox remote and mount to /home/username/rclone/dropbox with a dmedia mergerfs overlay.

--encrypted

Create a crypt remote using passwords provided during setup.

--beta

Install the beta branch from https://beta.rclone.org.

Once installed, Rclone appears in the Service Control panel as RClone with Upload and View Logs actions.

Access and authentication

Rclone provides local mount paths rather than a web UI, and QuickBox stores its configuration under each user’s home directory.

URL / route

There is no web route for Rclone. Access the mounted paths directly at /home/username/rclone/gdrive or /home/username/rclone/dropbox, and use the mergerfs overlay at /home/username/rclone/gmedia or /home/username/rclone/dmedia.

Login / credentials / tokens

During install, QuickBox prompts for the provider client ID and client secret. If —encrypted is selected, it also prompts for encryption and salt passwords that must differ.

Security notes

  • QuickBox enables user_allow_other in /etc/fuse.conf so mounts can use —allow-other.
  • Upload jobs use /home/username/rclone/rclone.lock to prevent concurrent runs.

Configuration and files

QuickBox creates a per-user config directory and an Rclone working folder with cache, mounts, and logs.

/home/username
.config/rclone/# Per-user rclone configuration
├── rclone.conf# Remote definitions and credentials
├── rclone_beta.txt# Present when installed with --beta
└── mergerfs_mount_service.txt# Active mergerfs mount unit name
rclone/# Working directory for mounts and uploads
├── cache/# Upload staging area
├── gdrive/# Google Drive mount (or crypt view when encrypted)
├── dropbox/# Dropbox mount (or crypt view when encrypted)
├── gmedia/# Mergerfs overlay for gdrive installs
├── dmedia/# Mergerfs overlay for dropbox installs
├── move.sh# Upload script invoked by cron
├── move.log# Upload log file
└── rclone.lock# Upload lock file

Common tasks

Use the commands below to manage services, uploads, and logs.

Command
systemctl restart rclone@username
Description
Restart the user’s Rclone mount service.
Command
systemctl status home-username-rclone-gmedia.mount
Description
Check the Google Drive mergerfs mount unit.
Command
systemctl status home-username-rclone-dmedia.mount
Description
Check the Dropbox mergerfs mount unit.
Command
qb user rclone -u username -o upload
Description
Trigger an upload using move.sh.
Command
qb user rclone -u username -o logs
Description
Show the tail of move.log in the CLI.
Command
qb user rclone -u username -o remove_lock
Description
Remove a stale rclone.lock file.
Command
qb clean rclone_logs -u username
Description
Clear move.log for the user.

Typical workflows:

  • Install with one provider flag and confirm mounts at /home/username/rclone.
  • Trigger qb user rclone -u username -o upload after a large cache sync.
  • Use the RClone card in Service Control to upload or view logs.

FAQ

A cron entry is added for 03:12 server time (12 3 * * * /home/username/rclone/move.sh). Each run writes to /home/username/rclone/move.log and uses /home/username/rclone/rclone.lock.
Rclone runs as rclone@username. Google Drive installs create /home/username/rclone/gdrive plus a mergerfs mount at /home/username/rclone/gmedia (unit: home-username-rclone-gmedia.mount). Dropbox installs mirror this with /home/username/rclone/dropbox and /home/username/rclone/dmedia.
Encrypted installs mount crypt: to the same gdrive or dropbox path and the upload script uses the encrypted remote.
Both actions read /home/username/rclone/move.log, which is also used by qb user rclone -o logs.

Best practices

Do

  • Use only one provider flag per install: --gdrive or --dropbox.
  • Keep /home/username/rclone/move.log and rclone.lock owned by the user account.
  • Reinstall with qb if service or mount files need regeneration.

Don't

  • Do not edit systemd unit files under /etc/systemd/system by hand.
  • Do not remove rclone.lock while an upload is active.

Troubleshooting

Mount path not available

Symptom: mount path under /home/username/rclone/ is empty or missing. Checks: confirm rclone@username is active and the correct mount unit is enabled (home-username-rclone-gmedia.mount or home-username-rclone-dmedia.mount).

Uploads not running

Symptom: cache files are not moving to the remote. Checks: confirm the cron entry 12 3 * * * /home/username/rclone/move.sh exists for the user, ensure rclone.lock is not lingering, and run qb user rclone -u username -o upload.

Resources

Resources

Rclone Website
Rclone Documentation

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server
NextcloudSyncthing