From a3fb460c6b1f2679643df31a7efcd836715d59c2 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Mon, 2 Sep 2019 14:30:11 +0100 Subject: [PATCH] docs: add info on how to build and use the docker images --- RELEASE.md | 13 +++++++++++++ docs/content/install.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index 4c6db9ed5..57e4d1957 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -90,3 +90,16 @@ Now * make LAST_TAG=${NEW_TAG} startdev * git push * Announce! + +## Making a manual build of docker + +The rclone docker image should autobuild on docker hub. If it doesn't +or needs to be updated then rebuild like this. + +``` +docker build -t rclone/rclone:1.49.1 -t rclone/rclone:1.49 -t rclone/rclone:1 -t rclone/rclone:latest . +docker push rclone/rclone:1.49.1 +docker push rclone/rclone:1.49 +docker push rclone/rclone:1 +docker push rclone/rclone:latest +``` diff --git a/docs/content/install.md b/docs/content/install.md index 768adefe4..6df10ba8c 100644 --- a/docs/content/install.md +++ b/docs/content/install.md @@ -81,6 +81,36 @@ Run `rclone config` to setup. See [rclone config docs](/docs/) for more details. rclone config +## Install with docker ## + +The rclone maintains a [docker image for rclone](https://hub.docker.com/r/rclone/rclone). +These images are autobuilt by docker hub from the rclone source based +on a minimal Alpine linux image. + +The `:latest` tag will always point to the latest stable release. You +can use the `:beta` tag to get the latest build from master. You can +also use version tags, eg `:1.49.1`, `:1.49` or `:1`. + +``` +$ docker pull rclone/rclone:latest +latest: Pulling from rclone/rclone +Digest: sha256:0e0ced72671989bb837fea8e88578b3fc48371aa45d209663683e24cfdaa0e11 +... +$ docker run --rm rclone/rclone:latest version +rclone v1.49.1 +- os/arch: linux/amd64 +- go version: go1.12.9 +``` + +You will probably want to mount rclone's config file directory or file +from the host, or configure rclone with environment variables. + +Eg to share your local config with the container + +``` +docker run -v ~/.config/rclone:/root/.config/rclone rclone/rclone:latest listremotes +``` + ## Install from source ## Make sure you have at least [Go](https://golang.org/) 1.7