From 5bd1cc55804ae333dc264942b11fa58b506a9ef6 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sun, 3 Jul 2016 22:07:53 -0700 Subject: [PATCH] #18: Fix for README mention of sample files not included in package. Also, added logo. --- NEWS | 5 +++++ README.md | 24 ++++++++++++++++++++---- setup.py | 2 +- static/borgmatic.svg | 1 + 4 files changed, 27 insertions(+), 5 deletions(-) create mode 100644 static/borgmatic.svg diff --git a/NEWS b/NEWS index 2cb9b09..724a7c7 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,8 @@ +1.0.3-dev + + * #18: Fix for README mention of sample files not included in package. + * Added logo. + 1.0.3 * #21: Fix for verbosity flag not actually causing verbose output. diff --git a/README.md b/README.md index 1bae8c1..00c2b97 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -title: Borgmatic +title: borgmatic + +borgmatic logo ## Overview @@ -57,11 +59,14 @@ To install borgmatic, run the following command to download and install it: sudo pip install --upgrade borgmatic -Then, copy the following configuration files: +Then, download a [sample config +file](https://torsion.org/hg/borgmatic/raw-file/tip/sample/config) and a +[sample excludes +file](https://torsion.org/hg/borgmatic/raw-file/tip/sample/excludes). From the +directory where you downloaded them: - sudo cp sample/borgmatic.cron /etc/cron.d/borgmatic sudo mkdir /etc/borgmatic/ - sudo cp sample/config sample/excludes /etc/borgmatic/ + sudo mv config excludes /etc/borgmatic/ Lastly, modify the /etc files with your desired configuration. @@ -111,6 +116,17 @@ If you'd like to see the available command-line arguments, view the help: borgmatic --help +## Autopilot + +If you want to run borgmatic automatically, say once a day, the you can +configure a job runner like cron to invoke it periodically. Download the +[sample cron +file](https://torsion.org/hg/borgmatic/raw-file/tip/sample/borgmatic.cron). +Then, from the directory where you downloaded it: + + sudo cp borgmatic.cron /etc/cron.d/borgmatic + + ## Running tests First install tox, which is used for setting up testing environments: diff --git a/setup.py b/setup.py index d4dbbbe..63b0081 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ from setuptools import setup, find_packages -VERSION = '1.0.3' +VERSION = '1.0.3-dev' setup( diff --git a/static/borgmatic.svg b/static/borgmatic.svg new file mode 100644 index 0000000..1c30816 --- /dev/null +++ b/static/borgmatic.svg @@ -0,0 +1 @@ + \ No newline at end of file