From e2faff100f32b1d16a79f4b5142f77562cd23383 Mon Sep 17 00:00:00 2001
From: FarisZR <35614734+fariszr@users.noreply.github.com>
Date: Sat, 19 Mar 2022 03:26:47 +0300
Subject: [PATCH] Add Docker Cron documentaion

---
 docs/markdown/docker.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/docs/markdown/docker.md b/docs/markdown/docker.md
index 86f17b6..83d7d18 100644
--- a/docs/markdown/docker.md
+++ b/docs/markdown/docker.md
@@ -13,6 +13,38 @@ docker run --rm \\
   autorestic backup -va -c /data/.autorestic.yaml
 ```
 
+## Cron
+
+To use cron with the docker image,
+you have 2 environment variables.
+`AUTORESTIC_INITIAL_ARGS` and `CRON_CONFIG_DIR`
+
+- `AUTORESTIC_INITIAL_ARGS` is arguments used for the initial autorestic command on container start up, if you don't set it, autorestic would show available commands.
+
+For example:
+```
+AUTORESTIC_INITIAL_ARGS=backup -va -c /.autorestic.yaml
+```
+Would mean `autorestic backup -va -c /.autorestic.yaml` on container startup.
+
+- `CRON_CONFIG_DIR` to enable Cron, you need to set this to the in-contaier directory of the config file you want to use with Cron.
+
+### Example
+
+```
+version: '3.3'
+
+services:
+  autorestic:
+    image: cupcakearmy/autorestic:latest
+    environment:
+      - AUTORESTIC_INITIAL_ARGS=backup -va -c /.autorestic.yaml
+      - CRON_CONFIG_DIR=/.autorestic.yaml
+    volumes:
+      - ./autorestic.yaml:/.autorestic.yaml
+```
+This would run `autorestic backup -va -c /.autorestic.yaml` on container startup, and check for any backups due in /.autorestic.yaml.
+
 ## Rclone
 
 For rclone you will have to also mount the rclone config file to `/root/.config/rclone/rclone.conf`.
@@ -25,4 +57,4 @@ To check where it is located you can run the following command: `rclone config f
 docker run \\
   -v /home/user/.config/rclone/rclone.conf:/root/.config/rclone/rclone.conf:ro \\
   ...
-```
+```
\ No newline at end of file