Updates: 2026-03-03T00:19:27.661Z

templates/rclone/README.md

@@ -1,8 +1,24 @@
-# rclone (templates)
+# rclone (Portainer template)
 
-### Description
-Description for rclone goes here.
+Rclone is a command-line program to manage files on cloud storage. It is a feature-rich alternative to cloud vendors' web storage interfaces. This template allows you to deploy rclone as a Docker service for automated syncing, mounting, or serving cloud files.
 
-### Configuration
-- Path: templates/rclone/docker-compose.yml
-- Status: Draft
+Quick notes:
+
+- **Persistence**: Ensure you mount a volume for the `rclone.conf` file to keep your remote credentials safe.
+- **Capabilities**: If using `rclone mount`, the container usually requires `--cap-add SYS_ADMIN` and device access to `/dev/fuse`.
+- **Environment**: Use environment variables to pass sensitive flags or configuration overrides.
+
+Usage:
+
+1. Import the compose file into Portainer's Stacks or App Templates.
+2. Map your local data directories and the config directory (usually `~/.config/rclone`).
+3. Configure your remotes via `docker exec -it <container_name> rclone config` or by providing a pre-made config file.
+4. Deploy and monitor logs via Portainer.
+
+Helpful links:
+
+- Official site: https://rclone.org/
+- Documentation: https://rclone.org/docs/
+- Docker Hub: https://hub.docker.com/r/rclone/rclone
+
+**Status:** Ready for configuration