{"id":13437489,"url":"https://github.com/sapk/docker-volume-rclone","last_synced_at":"2026-01-11T22:10:07.258Z","repository":{"id":33052088,"uuid":"110361319","full_name":"sapk/docker-volume-rclone","owner":"sapk","description":"Use Rclone as a backend for docker volume (also as a plugin). This permit to easely mount a lot of cloud provider (https://rclone.org/overview).","archived":false,"fork":false,"pushed_at":"2023-02-25T07:00:36.000Z","size":8248,"stargazers_count":110,"open_issues_count":7,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-19T06:42:00.116Z","etag":null,"topics":["docker","docker-plugin","docker-volume","docker-volume-plugin","rclone"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sapk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/docker/Dockerfile","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"liberapay":"sapk"}},"created_at":"2017-11-11T16:32:55.000Z","updated_at":"2025-02-11T21:33:41.000Z","dependencies_parsed_at":"2024-06-18T22:45:45.222Z","dependency_job_id":"fb6d6154-2107-4670-b2bd-d011193aee8b","html_url":"https://github.com/sapk/docker-volume-rclone","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/sapk/docker-volume-rclone","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapk%2Fdocker-volume-rclone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapk%2Fdocker-volume-rclone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapk%2Fdocker-volume-rclone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapk%2Fdocker-volume-rclone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sapk","download_url":"https://codeload.github.com/sapk/docker-volume-rclone/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sapk%2Fdocker-volume-rclone/sbom","scorecard":{"id":800379,"data":{"date":"2025-08-11","repo":{"name":"github.com/sapk/docker-volume-rclone","commit":"2e96b479b2a30da0a07623e6b57160c21a38aee6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.4,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: support/docker/Dockerfile:4","Warn: containerImage not pinned by hash: support/docker/Dockerfile:15","Info:   0 out of   2 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.0.10 not signed: https://api.github.com/repos/sapk/docker-volume-rclone/releases/33313014","Warn: release artifact v0.0.9 not signed: https://api.github.com/repos/sapk/docker-volume-rclone/releases/29368201","Warn: release artifact v0.0.8 not signed: https://api.github.com/repos/sapk/docker-volume-rclone/releases/23906054","Warn: release artifact v0.0.7 not signed: https://api.github.com/repos/sapk/docker-volume-rclone/releases/23020974","Warn: release artifact v0.0.6 not signed: https://api.github.com/repos/sapk/docker-volume-rclone/releases/20167300","Warn: release artifact v0.0.10 does not have provenance: https://api.github.com/repos/sapk/docker-volume-rclone/releases/33313014","Warn: release artifact v0.0.9 does not have provenance: https://api.github.com/repos/sapk/docker-volume-rclone/releases/29368201","Warn: release artifact v0.0.8 does not have provenance: https://api.github.com/repos/sapk/docker-volume-rclone/releases/23906054","Warn: release artifact v0.0.7 does not have provenance: https://api.github.com/repos/sapk/docker-volume-rclone/releases/23020974","Warn: release artifact v0.0.6 does not have provenance: https://api.github.com/repos/sapk/docker-volume-rclone/releases/20167300"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"16 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GO-2022-0236 / GHSA-h86h-8ppg-mxmh","Warn: Project is vulnerable to: GO-2021-0238 / GHSA-83g2-8m93-v3w7","Warn: Project is vulnerable to: GO-2022-0288","Warn: Project is vulnerable to: GO-2022-0969 / GHSA-69cg-p879-7622","Warn: Project is vulnerable to: GO-2022-1144 / GHSA-xrjj-mj9h-534m","Warn: Project is vulnerable to: GO-2023-1571 / GHSA-vvpx-j8f3-3w6h","Warn: Project is vulnerable to: GO-2023-1988 / GHSA-2wrh-6pvc-2jm9","Warn: Project is vulnerable to: GO-2023-2102 / GHSA-4374-p667-p6c8","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GO-2024-2687 / GHSA-4v7x-pqxf-cx7m","Warn: Project is vulnerable to: GO-2024-3333","Warn: Project is vulnerable to: GO-2025-3503 / GHSA-qxp5-gwg8-xv66","Warn: Project is vulnerable to: GO-2025-3595 / GHSA-vvgc-356p-c3xw","Warn: Project is vulnerable to: GO-2022-0493 / GHSA-p782-xgp4-8hr8","Warn: Project is vulnerable to: GO-2021-0113 / GHSA-ppp9-7jff-5vj2","Warn: Project is vulnerable to: GO-2022-1059 / GHSA-69ch-w2m2-3vjp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T10:18:23.156Z","repository_id":33052088,"created_at":"2025-08-23T10:18:23.156Z","updated_at":"2025-08-23T10:18:23.156Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28325085,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T22:09:16.736Z","status":"ssl_error","status_checked_at":"2026-01-11T22:00:47.481Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-plugin","docker-volume","docker-volume-plugin","rclone"],"created_at":"2024-07-31T03:00:57.642Z","updated_at":"2026-01-11T22:10:07.235Z","avatar_url":"https://github.com/sapk.png","language":"Go","readme":"# docker-volume-rclone [![License](https://img.shields.io/badge/license-MIT-red.svg)](https://github.com/sapk/docker-volume-rclone/blob/master/LICENSE) ![Project Status](http://img.shields.io/badge/status-beta-orange.svg)\n[![GitHub release](https://img.shields.io/github/release/sapk/docker-volume-rclone.svg)](https://github.com/sapk/docker-volume-rclone/releases) [![Go Report Card](https://goreportcard.com/badge/github.com/sapk/docker-volume-rclone)](https://goreportcard.com/report/github.com/sapk/docker-volume-rclone)\n[![codecov](https://codecov.io/gh/sapk/docker-volume-rclone/branch/master/graph/badge.svg)](https://codecov.io/gh/sapk/docker-volume-rclone)\n master : [![Travis master](https://api.travis-ci.org/sapk/docker-volume-rclone.svg?branch=master)](https://travis-ci.org/sapk/docker-volume-rclone) develop : [![Travis develop](https://api.travis-ci.org/sapk/docker-volume-rclone.svg?branch=develop)](https://travis-ci.org/sapk/docker-volume-rclone)\n\n\nUse Rclone as a backend for docker volume. This permit to easely mount a lot of cloud provider (https://rclone.org/overview/).\n\nStatus : **BETA (work and in use but still need improvements)**\n\nUse Rclone cli in the plugin container so it depend on fuse on the host.\n\n## Docker plugin (Easy method) [![Docker Pulls](https://img.shields.io/docker/pulls/sapk/plugin-rclone.svg)](https://hub.docker.com/r/sapk/plugin-rclone) [![ImageLayers Size](https://img.shields.io/imagelayers/image-size/sapk/plugin-rclone/latest.svg)](https://hub.docker.com/r/sapk/plugin-rclone)\n```\ndocker plugin install sapk/plugin-rclone\ndocker volume create --driver sapk/plugin-rclone --opt config=\"$(base64 ~/.config/rclone/rclone.conf)\" --opt remote=some-remote:bucket/path --name test\ndocker run -v test:/mnt --rm -ti ubuntu\n```\n\n## Build\n```\nmake\n```\n\n## Start daemon\n```\n./docker-volume-rclone daemon\nOR in a docker container\ndocker run -d --device=/dev/fuse:/dev/fuse --cap-add=SYS_ADMIN --cap-add=MKNOD  -v /run/docker/plugins:/run/docker/plugins -v /var/lib/docker-volumes/rclone:/var/lib/docker-volumes/rclone:shared sapk/docker-volume-rclone\n```\n\nFor more advance params : ```./docker-volume-rclone --help OR ./docker-volume-rclone daemon --help```\n```\nRun listening volume drive deamon to listen for mount request\n\nUsage:\n  docker-volume-rclone daemon [flags]\n\nGlobal Flags:\n  -b, --basedir string   Mounted volume base directory (default \"/var/lib/docker-volumes/rclone\")\n  -v, --verbose          Turns on verbose logging\n```\n\n## Create and Mount volume\n```\ndocker volume create --driver rclone --opt config=\"$(base64 ~/.config/rclone/rclone.conf)\" --opt remote=some-remote:bucket/path --name test\ndocker run -v test:/mnt --rm -ti ubuntu\n```\n\n## Allow acces to non-root user\nSome image doesn't run with the root user (and for good reason). To allow the volume to be accesible to the container user you need to add some mount option: `--opt args=\"--uid 1001 --gid 1001 --allow-root --allow-other\"`.\n\nFor example, to run an ubuntu image with an non root user (uid 33) and mount a volume: \n```\ndocker volume create --driver sapk/plugin-rclone --opt config=\"$(base64 ~/.config/rclone/rclone.conf)\" --opt args=\"--uid 33 --gid 33 --allow-root --allow-other\" --opt remote=some-remote:bucket/path --name test\ndocker run -i -t -u 33:33 --rm -v test:/mnt ubuntu /bin/ls -lah /mnt\n```\n\n## Docker-compose\nFirst put your rclone config in a env variable:\n```\nexport RCLONE_CONF_BASE64=$(base64 ~/.config/rclone/rclone.conf)\n```\nAnd setup you docker-compose.yml file like that\n```\nvolumes:\n  some_vol:\n    driver: sapk/plugin-rclone\n    driver_opts:\n      config: \"${RCLONE_CONF_BASE64}\"\n      args: \"--read-only --fast-list\"\n      remote: \"some-remote:bucket/path\"\n```\nYou can also hard-code your config in the docker-compose file in place of the env variable.\n\n## Healthcheck\nThe docker plugin volume protocol doesn't allow the plugin to inform the container or the docker host that the volume is not available anymore.\nTo ensure that the volume is always live, It is recommended to setup an healthcheck to verify that the mount is responding. \n\nYou can add an healthcheck like this example:\n```\nservices:\n  server:\n    image: my_image\n    healthcheck:\n      test: ls /my/rclone/mount/folder || exit 1\n      interval: 1m\n      timeout: 15s\n      retries: 3\n      start_period: 15s\n```\n\n## Inspired from :\n - https://github.com/ContainX/docker-volume-netshare/\n - https://github.com/vieux/docker-volume-sshfs/\n - https://github.com/sapk/docker-volume-gvfs\n - https://github.com/calavera/docker-volume-glusterfs\n - https://github.com/codedellemc/rexray\n\n## How to debug docker managed plugin :\n```\n#Restart plugin in debug mode\ndocker plugin disable sapk/plugin-rclone\ndocker plugin set sapk/plugin-rclone DEBUG=1\ndocker plugin enable sapk/plugin-rclone\n\n#Get files under /var/log of plugin\nrunc --root /var/run/docker/plugins/runtime-root/plugins.moby list\nrunc --root /var/run/docker/plugins/runtime-root/plugins.moby exec -t $CONTAINER_ID cat /var/log/rclone.log\nrunc --root /var/run/docker/plugins/runtime-root/plugins.moby exec -t $CONTAINER_ID cat /var/log/docker-volume-rclone.log\n```\n","funding_links":["https://liberapay.com/sapk"],"categories":["HarmonyOS","Go","docker"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapk%2Fdocker-volume-rclone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsapk%2Fdocker-volume-rclone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsapk%2Fdocker-volume-rclone/lists"}