From f5b3310103ea177182c0eb1d29065b44dd228de0 Mon Sep 17 00:00:00 2001
From: Kai Reinhard <K.Reinhard@micromata.de>
Date: Mon, 19 Apr 2021 15:04:36 +0000
Subject: [PATCH] Support of $BorgButlerHome/environment.sh for setting java options.
---
README.adoc | 21 +++++++++++++++------
1 files changed, 15 insertions(+), 6 deletions(-)
diff --git a/README.adoc b/README.adoc
index 821b40e..9b5ea7b 100644
--- a/README.adoc
+++ b/README.adoc
@@ -67,7 +67,7 @@
Enjoy BorgButler by opening your browser: http://localhost:9042
-You may refer the log file through the web browser or in `$HOME/BorgButler/borgbutler.log`.
+You may refer the log file through the web browser or in `${BorgButlerHome}/borgbutler.log`.
For new versions of BorgButler or for changing the running options of your BorgButler container, simply delete the BorgButler docker container by `docker rm borgbutler` and call `docker run` again.
@@ -78,6 +78,8 @@
2. Unzip `borgbutler-server/build/distributions/borgbutler-server-<version>.zip`
3. Run `bin/borgbutler-server` or `bin/borgbutler-server.bat`.
+As BorgButler default home directory, `${HOME}/.borgbutler` is used.
+
=== Starting from sources
You'll need OpenJDK 9+ as well as gradle.
@@ -95,7 +97,7 @@
[source,yaml]
----
-borgCommand: "/Users/kai/.borgbutler/bin/borg-macosx64-1.1.9"
+borgCommand: "${BorgButlerHome}/bin/borg-macosx64-1.1.9"
maxArchiveContentCacheCapacityMb: 200
repoConfigs:
- displayName: "ACME - Backup server 1"
@@ -121,10 +123,10 @@
Here: link:doc/ExampleBorgConfig{outfilesuffix}[Installation]
-==== Backups of configuration files
+=== Backups of configuration files
You may configure and initialize your repositories by the BorgButler app. The config file is generated by BorgButler. Before
-saving a new configuration BorgButler stores a copy of the current configuration in the backup dir: `~/.borgbutler/backup/`.
+saving a new configuration BorgButler stores a copy of the current configuration in the backup dir: `${BorgButlerHome}/backup/`.
== More immpressions
@@ -145,8 +147,15 @@
== Trouble shooting
=== Docker
==== Increase memory (OutOfMemory)
-1. `docker rm borgbutler`
-2. `docker run -e JAVA_OPTS="-Xmx2G" -v ...`
+Edit `${BorgButlerHome}/environment.sh` and restart your docker container (since version 0.7).
+
+[source,bash]
+----
+#!/bin/bash
+
+export JAVA_OPTS=-DXmx4g
+----
+
If your docker container crashes on heavy usage of large borg archives, check the memory settings of your docker installation.
=== How to download/restore?
--
Gitblit v1.10.0