mirror of https://github.com/micromata/borgbackup-butler.git

doc
Kai Reinhard
14.49.2021 f4401907b2319c0d403b1818e661be81ec5f6d8a
doc
3 files modified
37 ■■■■ changed files
README.adoc 9 ●●●●● patch | view | raw | blame | history
borgbutler-docker/README.adoc 2 ●●● patch | view | raw | blame | history
doc/Development.adoc 26 ●●●●● patch | view | raw | blame | history
README.adoc
@@ -59,10 +59,11 @@
BorgButler working directory `$HOME/BorgButler` is assumed, but you may define any other.
1. `docker run -v $HOME/BorgButler:/Borgbutler -p 127.0.0.1:9042:9042 --name borgbuttler kreinhard/borgbutler` (exporting of `.ssh` is useful for ssh remotes, otherwise skip this setting.)
2. Stopping: simly click `CTRL-C`.
3. Restart: `docker start`
4. Stop: `docker stop`
1. Create your local BorgButler directory: `mkdir $HOME/BorgButler` (for config, caches, backups and restoring of backuped files and directories)
2. `docker run -v $HOME/BorgButler:/Borgbutler -p 127.0.0.1:9042:9042 --name borgbuttler kreinhard/borgbutler` (exporting of `.ssh` is useful for ssh remotes, otherwise skip this setting.)
3. Stopping: simly click `CTRL-C`.
4. Restart: `docker start`
5. Stop: `docker stop`
Enjoy BorgButler by opening your browser: http://localhost:9042
borgbutler-docker/README.adoc
@@ -15,6 +15,6 @@
== Deploying
1. `docker tag bc0459ed7d01 kreinhard/borgbutler:0.3  kreinhard/borgbutler:latest`
1. `docker tag bc0459ed7d01 kreinhard/borgbutler:0.3`
2. `docker push kreinhard/borgbutler:0.3`
3. `docker push kreinhard/borgbutler:latest`
doc/Development.adoc
@@ -8,32 +8,6 @@
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
== Configuration
~/.borgbutler/borgbutler-config.json
[source,json]
----
{
  "repo-configs" : [ {
    "display_name" : "My-Laptop-Local-Backup",
    "repo"         : "/Volumes/backup/my-laptop-backup"
  },
  {
    "display_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"
  } ]
}
----
* `repo-configs`: You may add a list of all your repos with the borg variables. The name is only used for displaying
purposes.
=== 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/`.
== Build and start from command line