Portainer Templates logo

Portainer Templates

Rclone Config Backup Rclone Config Backup

Container

BackupCloudNetwork OtherTools

Rclone is a command line program to sync files and directories to and from cloud providers (Dropbox, GDrive, Box, etc)

Image details

Pulls: 2k
Architecture: amd64
Image size: 22 MB
User: mediadepot
Created: Dec 16, 2018
Updated: 7 years ago
Status: active

Configuration

Type
Container
Image
mediadepot/rclone:latest
Volumes
/srv/rclone/config : /opt/mediadepot/apps/rclone/mnt/data : /opt/mediadepot/apps

Template by mediadepot

Standalone Install

Select an install method, to see config/commands for deploying Rclone Config Backup

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Rclone Config Backup, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

Requirements

Environmental

The following environmental variables must be populated, when running container

Ports

The following ports must be mapped, when running container

Volumes

The following volumes must be mapped, when running container
  • :/srv/rclone/config
  • :/mnt/data

Config

The config directory inside this container contains 2 files:
  • /srv/rclone/config/rclone.conf - contains rclone configuration
  • /srv/rclone/config/cron-15mins - contains a script that is run every 15 minutes by cron. Must be edited to do what you want

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs rclone
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /opt/mediadepot/apps/rclone (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull mediadepot/rclone:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Rclone Config Backup runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Rclone Config Backup needs bundled into one download. This template pulls mediadepot/rclone:latest, which Docker fetches once (about 22 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Rclone Config Backup's comes from Docker Hub, published by mediadepot.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.

Volumes

A volume is where Rclone Config Backup keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /srv/rclone/config from /opt/mediadepot/apps/rclone on the host
  • /mnt/data from /opt/mediadepot/apps on the host

Networking

Nothing custom is set, so Rclone Config Backup sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container rclone. That's what you'll spot in the containers list and use in commands like docker logs rclone.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Rclone Config Backup up. Add the template list to Portainer once, then deploying Rclone Config Backup is a click rather than a wall of config.