swaleio/rclone repository overview

⁠swaleio/rclone

A thin wrapper around rclone⁠ that backs the rclone-copy task. It configures a single rclone remote named remote from task inputs and runs rclone copy <source> <dest>.

⁠The remote model

This image never reads an on-disk rclone config. Instead it maps task inputs to rclone's RCLONE_CONFIG_<REMOTE>_<OPTION> environment variables for one remote whose name is always the literal string remote. Every path you hand the task is therefore written in rclone's remote:path form:

remote:my-bucket/data/          # "remote" == the backend configured from your inputs

The backend behind remote is selected by the remote_type input (default s3). Credentials come from the recognized credential inputs below and are exported only when set, so an unset input never overrides a backend's own default. No eval is used and no config file is written.

To move data in or out of the shared workspace, use a local path such as /mnt/workspace/out on one side of the copy:

source: remote:my-bucket/data     dest: /mnt/workspace/out     # download
source: /mnt/workspace/build      dest: remote:my-bucket/rel   # upload

⁠Supported remote_type values

Other rclone backends that authenticate with a single OAuth token can be named directly (e.g. remote_type: dropbox) and supplied through the token input.

⁠Recognized credential inputs

Each input, when set, is exported as the matching remote-config variable:

Pass credentials as project/account secrets, never as literals.

⁠Invocation

The entrypoint runs, after exporting the config above:

rclone copy "$INPUT_SOURCE" "$INPUT_DEST" $INPUT_FLAGS

• source and dest are remote:path (with a local /mnt/workspace/... path on one side to read from or write to the shared workspace).
• flags is optional extra rclone flags (e.g. --dry-run --progress), passed through verbatim.

The image is Alpine-based and runs as the base image's non-root rclone user (UID 1009) with ca-certificates already installed.

Built from images/rclone⁠ in the swaleio/task-definitions⁠ repository. For how a task definition references an image, see the task definition reference⁠ in the Swale documentation⁠.

The Dockerfile and entrypoint are covered by the MIT License⁠. The software this image packages keeps its own licenses, which ship inside the image.