/docker-volume-rclone

Docker volume plugin for rclone

Primary LanguageGoMIT LicenseMIT

Docker volume plugin for rclone

This plugin allows you to mount remote folder using rclone in your container easily.

Go Report Card

Usage

1 - Install the plugin

$ docker plugin install brimstone/volume-rclone

# or to enable debug
docker plugin install brimstone/volume-rclone LOG_LEVEL=DEBUG

2 - Create a volume

Make sure the source path on the rclone server was exists.

Or you'll be failed while use/mount the volume.

$ docker volume create -d brimstone/volume-rclone -o backend=storj -o scope=blah [-o <any_rclone_backend_option>] rclonevolume
rclonevolume
$ docker volume ls
DRIVER                          VOLUME NAME
local                           2d75de358a70ba469ac968ee852efd4234b9118b7722ee26a1c5a90dcaea6751
local                           842a765a9bb11e234642c933b3dfc702dee32b73e0cf7305239436a145b89017
local                           9d72c664cbd20512d4e3d5bb9b39ed11e4a632c386447461d48ed84731e44034
local                           be9632386a2d396d438c9707e261f86fd9f5e72a7319417901d84041c8f14a4d
local                           e1496dfe4fa27b39121e4383d1b16a0a7510f0de89f05b336aab3c0deb4dda0e
brimstone/volume-rclone         rclonevolume

3 - Use the volume

$ docker run -it -v rclonevolume:<path> busybox ls <path>

LICENSE

MIT