From 8ea34f07a664fb156f3cba064217a885d43ca716 Mon Sep 17 00:00:00 2001
From: L3D <l3d@c3woc.de>
Date: Thu, 9 Jul 2020 17:28:35 +0200
Subject: [PATCH] Add some docs to README

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/README.md b/README.md
index 5b0afbc..aecf48a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,65 @@
 # role-postgresql-backup
 Ansible role to automaticcally backup your postgresql database you created with ansible
 
+```
 WÖRK IN PROGRESS, obviously!
+```
+
+ Configuration
+------------------
+
+* required packages to create postgres dump and add a cronjob
+```yaml
+postgresql_backup:
+  required_packages:
+    - postgresql-client
+    - cron
+```
+
+* Where do we store our database backups:
+```yaml
+postgresql_backup:
+  backup_dir: /var/backup/postgresql
+```
+
++ Dateformat we use to create daily backup folder
+```yaml
+postgresql_backup:
+  date_format: '%Y-%m-%d_%H-%M'
+```
+
++ Create cronjob to run backup script?
+```yaml
+postgresql_backup:
+  cron: true
+```
+
++ User that should run the backup script as cronjob
+```yaml
+postgresql_backup:
+  user: root
+```
+
+* Minute and hour to run the cronjob
+```yaml
+postgresql_backup:
+  cron_minute: '*'
+  cron_hour: '0'
+```
+
++ Which database*(s)* do we want to backup` *(example)*
+  *The values for host and port are optional!*
+```yaml
+postgresql_backup:
+  databases:
+   - name: psql_database_name
+     user: psql_database_user
+     password: Topf_Secret1
+     host: localhost
+     port: 5432
+```
+
++ Perform basic versionscheck *(true is recomended)*
+```
+submodules_versioncheck: false
+```