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/.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 +```