binhex-rclone

Overview

Rclone is a command line program to manage files on cloud storage. It is a feature rich alternative to cloud vendors web storage interfaces. Over 40 cloud storage products support rclone including S3 object stores, business and consumer file storage services, as well as standard transfer protocols. Rclone has powerful cloud equivalents to the unix commands rsync, cp, mv, mount, ls, ncdu, tree, rm, and cat. Rclone's familiar syntax includes shell pipeline support, and --dry-run protection. It is used at the command line, in scripts or via its API. Users call rclone The Swiss army knife of cloud storage, and Technology indistinguishable from magic.

Runtime arguments

Web UI: http://[IP]:[PORT:5572]
Network: bridge
Shell: bash
Privileged: false
Extra Params: --restart=unless-stopped

Template configuration

Port: Web InterfacePorttcp

This is the Web UI port for the application.

Target: 5572
Default: 5572

Port: Rclone AuthorizationPorttcp

This is the Rclone authorization port.

Target: 53682
Default: 53682

Path: /configPathrw

This is the container path to your configuration files, e.g. databases, configuration files, logs etc.

Target: /config
Default: /mnt/user/appdata/rclone

Path: /mediaPathrw

This is the container path to your media files, e.g. movies, tv, music, pictures etc.

Target: /media
Default: /mnt/user

Variable: RCLONE_CONFIG_PATHVariable

Specify the file path to your preconfigured rclone configuration file.

Target: RCLONE_CONFIG_PATH
Default: /config/rclone/config/rclone.conf

Variable: RCLONE_MEDIA_SHARESVariable

Specify the media shares to process in rclone.

Target: RCLONE_MEDIA_SHARES

Variable: RCLONE_REMOTE_NAMEVariable

Specify the remote name as defined in the rclone configuration file.

Target: RCLONE_REMOTE_NAME
Default: remote

Variable: RCLONE_SLEEP_PERIODVariable

Specify the delay between re-runs of rclone.

Target: RCLONE_SLEEP_PERIOD
Default: 24h

Variable: RCLONE_OPERATIONVariable

Specify whether to copy new files or syncronise, syncronise may cause delete operation so use with caution.

Target: RCLONE_OPERATION
Default: copy|sync

Variable: RCLONE_DIRECTIONVariable

Specify the direction to syncronise, local to remote, remote to local or two way sync.

Target: RCLONE_DIRECTION
Default: localtoremote|remotetolocal|both

Variable: ENABLE_WEBUIVariable

Specify whether to enable the rclone Web UI.

Target: ENABLE_WEBUI
Default: yes|no

Variable: WEBUI_USERVariable

Specify the rclone Web UI username.

Target: WEBUI_USER
Default: admin

Variable: WEBUI_PASSVariable

Specify the rclone Web UI password.

Target: WEBUI_PASS

Variable: RCLONE_USER_FLAGSVariable

Specify any additional user defined flags for rclone.

Target: RCLONE_USER_FLAGS

Variable: RCLONE_POST_CHECKVariable

Specify whether to verify local and remote files match.

Target: RCLONE_POST_CHECK
Default: yes|no

Variable: RCLONE_POST_REPORTVariable

Specify what post check level to report.

Target: RCLONE_POST_REPORT
Default: combined|differ|error|match|missing-on-dst|missing-on-src

Variable: ENABLE_HEALTHCHECKVariable

Enable or disable healthchecks.

Target: ENABLE_HEALTHCHECK
Default: yes|no

Variable: HEALTHCHECK_COMMANDVariable

The command or script to execute, if not specified then the script healthcheck.sh will be used (process, dns and https checking).

Target: HEALTHCHECK_COMMAND

Variable: HEALTHCHECK_ACTIONVariable

The action to execute if the healthcheck command returns a non zero exit code, if not specified the action will be 'exit 1', if you want the container to exit on failure then set the action to 'kill 1'.

Target: HEALTHCHECK_ACTION

Variable: HEALTHCHECK_HOSTNAMEVariable

The hostname used when performing HTTPS and DNS healthchecking.

Target: HEALTHCHECK_HOSTNAME
Default: google.com

Variable: PUIDVariable

User ID for the running container

Target: PUID
Default: 99

Variable: PGIDVariable

Group ID for the running container

Target: PGID
Default: 100

Variable: UMASKVariable

UMASK for the running container

Target: UMASK
Default: 000

Links

Template Support Registry Project

Details

Repository

ghcr.io/binhex/arch-rclone

Registry

https://github.com/binhex/arch-rclone/pkgs/container/arch-rclone

Last Updated2026-04-19

First Seen2021-07-10

Run binhex-rclone on Unraid.

binhex-rclone is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS