From 21b83b4c89abecc18463e36e9b46743f5891873e Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Mon, 6 Dec 2021 17:20:06 +0100 Subject: [PATCH] docker docs --- docs/markdown/_toc.md | 1 + docs/markdown/docker.md | 28 ++++++++++++++++++++++++++++ docs/markdown/installation.md | 2 ++ 3 files changed, 31 insertions(+) create mode 100644 docs/markdown/docker.md diff --git a/docs/markdown/_toc.md b/docs/markdown/_toc.md index bd4e321..9024e0c 100644 --- a/docs/markdown/_toc.md +++ b/docs/markdown/_toc.md @@ -46,6 +46,7 @@ > [1.4 → 1.5](/migration/1.4_1.5) [Examples](/examples) +[Docker](/docker) [QA](/qa) [Community](/community) [Contributors](/contrib) diff --git a/docs/markdown/docker.md b/docs/markdown/docker.md new file mode 100644 index 0000000..32636d2 --- /dev/null +++ b/docs/markdown/docker.md @@ -0,0 +1,28 @@ +# 🐳 Docker + +The docker image is build with rclone and restic already included. It's ment more as a utility image. + +## Remote hosts + +For remote backups (S3, B2, GCS, etc.) it's quite easy, as you only need to mount the config file and the data to backup. + +```bash +docker run --rm \\ + -v $(pwd):/data \\ + cupcakearmy/autorestic \\ + autorestic backup -va +``` + +## Rclone + +For rclone you will have to also mount the rclone config file to `/root/.config/rclone/rclone.conf`. + +To check where it is located you can run the following command: `rclone config file`. + +**Example** + +```bash +docker run \\ + -v /home/user/.config/rclone/rclone.conf:/root/.config/rclone/rclone.conf:ro \\ + ... +``` diff --git a/docs/markdown/installation.md b/docs/markdown/installation.md index 071e9c5..e932d44 100644 --- a/docs/markdown/installation.md +++ b/docs/markdown/installation.md @@ -14,6 +14,8 @@ wget -qO - https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/insta There is an official docker image over at [cupcakearmy/autorestic](https://hub.docker.com/r/cupcakearmy/autorestic). +For some examples see [here](/docker). + ### Manual You can download the right binary from the release page and simply copy it to `/usr/local/bin` or whatever path you prefer. Autoupdates will still work.