From 61bac7d661577275e6a2996d2d3263807beb9830 Mon Sep 17 00:00:00 2001
From: Kuba Orlik <kontakt@kuba-orlik.name>
Date: Sat, 13 Sep 2025 00:37:27 +0200
Subject: [PATCH] Add example playbook entry

---
 README.md | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 01c87be..718e2a3 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,5 @@
 Sets up backups to Cloudflare R2
 
-
-
-
 # Instalation
 
 In requirements.yml:
@@ -14,8 +11,28 @@ roles:
     name: setup-backups
 ```
 
-
-
 # Setup
 
 Create a Cloudflare R2 account and create an admin token.
+
+Create a file under `templates/backup-scripts/<hostname>.sh.j2` that
+is a shell script that prepares the data for backup - leave empty if
+not necessary.
+
+Then in your playbook run:
+
+```yml
+
+- name: "Setup backups"
+  hosts: ansible1
+  roles:
+    - setup-backups
+  vars:
+    backup_bucket_prefix: "backup"
+    all_backup_paths:
+      - /var/homebox/data
+    cloudflare_r2_access_key: "cloudflare R2 Access key (for S3-type API)"
+    cloudflare_r2_secret_key: "cloudflare R2 secret key (for S3-type API)"
+    cloudflare_r2_endpoint: https://some_endpoint.r2.cloudflarestorage.com
+    BACKUP_PASSWORD: password
+```