From 33a1d38edd8bad41de350832b1a7075c749cf27a Mon Sep 17 00:00:00 2001
From: Kai Reinhard <K.Reinhard@micromata.de>
Date: Mon, 10 Dec 2018 06:16:43 +0000
Subject: [PATCH] doc...
---
README.adoc | 24 ++++++++++++++++++++++++
1 files changed, 24 insertions(+), 0 deletions(-)
diff --git a/README.adoc b/README.adoc
index 985cfe5..c5a5f37 100644
--- a/README.adoc
+++ b/README.adoc
@@ -8,6 +8,30 @@
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
+== Configuration
+
+
+~/.borgbutler.json
+----
+{
+ "cache_max_disc_size_mb" : 1000,
+ "repo-configs" : [ {
+ "name" : "My-Laptop-Local-Backup",
+ "repo" : "/Volumes/backup/my-laptop-backup",
+ },
+ {
+ "name" : "My-Laptop-Remote-Backup",
+ "repo" : "ssh://backup.acme.com/./backups/my-laptop",
+ "passwordCommand" : "security find-generic-password -a $USER -s borg-passphrase -w",
+ "rsh" : "ssh -i /Users/horst/.ssh/acme_rsa"
+ } ]
+}
+----
+* `cache_max_disc_size_mb` specifies the cache size BorgButler may use for caching borg results (such as repository
+information, archive information and also file list of archive content.
+* `repo-configs`: You may add a list of all your repos with the borg variables. The name is only used for displaying
+purposes.
+
== For developers
=== Lombok required
--
Gitblit v1.10.0