extend readme file

This commit is contained in:
Andreas Zweili 2016-12-14 16:16:55 +01:00
parent 0b2307012f
commit 2b97d5d8a7
1 changed files with 43 additions and 1 deletions

View File

@ -1,3 +1,45 @@
# borg_interface
This application provides an interface to borg backup. At a later point it might as well work with restic.
This application provides an interface to borg backup. At a later point it might
as well work with restic.
### Installation and Getting started
To start the application simply execute the borg_interface 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 proper syntax is:
```
option: value
```
or
```
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
server: testserver.local
user: borg
repository_path: /home/borg/backup/repository
password: foo