Archived

This application provides an interface to borg backup. At a later point it might as well work with restic.

This repository has been archived on 2020-04-03. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Andreas Zweili c299c724a2 delete whitespace		2017-06-10 10:29:12 +02:00
borg_interface	delete whitespace	2017-06-10 10:29:12 +02:00
.gitignore	rename backup_to_fileserver to backup_to_external	2016-12-18 15:18:16 +01:00
LICENSE	initial commit	2016-12-13 19:28:37 +01:00
README.md	delete trailing whitespace	2017-04-24 21:44:12 +02:00
backup_to_external.sh	fix path	2016-12-31 15:47:41 +01:00
borg_interface.cfg	change password	2016-12-27 10:09:38 +01:00
borg_interface.sh	Add support for relativ paths	2016-12-31 15:20:25 +01:00

README.md

borg_interface

This application provides an interface to borg backup. At a later point it might as well work with restic.

Installation

To install the application either "git clone" it in the folder you want with:

git clone https://git.2li.ch/Nebucatnetzer/borg_interface.git

or simply download it and extract the zip to your prefered location.:

https://git.2li.ch/Nebucatnetzer/borg_interface/archive/master.zip

Starting

Before starting the application make sure that you have configured it properly. See the section Configuration for more details. To start the application simply execute the borg_interface.sh file. You will then see a list of options which are fairly self explanatory.

Configuration

To configure borg_interface please edit the borg_interface.cfg file. All the options have to be placed under the [DEFAULT] section. The config file itself can reside at ~/.config/borg_interface/borg_interface.cfg (recommended) or at ~/.borg_interface.cfg or next to the borg_interface.sh script.

The proper syntax is:

option: value

option=value

Possible values as of now are:

server

define a server on which the archive reside.

user

defines the user which has permission to connect to the server.

repository_path

defines the path where the repository is set up. This is needed for both a remote and a local repository.

password

defines the repository password

Example Config

[DEFAULT]
server: testserver.local
user: borg
repository_path: /home/borg/backup/repository
password: foo

Backup by using cronjobs

To make it easier to do automated backups I've created the backup_to_external.py function. To use it simply add a cronjob with:

crontab -e

Then enter a line like this for example:

0 * * * *  /path/to/borg_interface/backup_to_external.sh

Now your system will take a backup every hour.

NOTE: Currently the backup path is hardcoded in the backup_to_external.py script but should be quite easy to change. Basically you just need to change the path_to_backup variable. I will add a configuration option for the backup path at a later point.