Skip to content

Commit

Permalink
Add instructions on how to run emborg-overdue.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Aug 14, 2019
1 parent d17f3ee commit e7ba2c8
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. Emborg documentation master file
Emborg -- Front-End to Borg Backup
==================================
Emborg Front-End to Borg Backup
=================================

| Version: 1.4.1
| Released: 2019-04-24
Expand Down
27 changes: 26 additions & 1 deletion doc/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ to the end of *root*. *maintainer* is an email address, an email is sent to
this address if there is an issue. *max_age* is the number of hours that may
pass before an archive is considered overdue.

*repositories* can also be specified as a list of dictionaries as follows::
*repositories* can also be specified as multi-line string::

repositories = """
HOST | NAME or PATH | MAINTAINER | MAXIMUM AGE (hours)
Expand All @@ -66,3 +66,28 @@ a # is considered a comment and is ignored, and the finally the lines are split
on '|' and the 4 values are expected to be given in order. If the *maintainer*
is not given, the *default_maintainer* is used. If *max_age* is not given, the
*default_max_age* is used.
To run the program interactively, just make sure *emborg-overdue* has been
installed and is on your path. Then type::

emborg-overdue

It is also common to run *emborg-overdue* on a fixed schedule from cron. To do
so, run::

crontab -e

and add something like the following::

4 5 * * * ~/dumper/.local/bin/emborg-overdue --mail > ~/dumper/emborg-overdue.out 2>&

or

4 5 * * * ~/dumper/.local/bin/emborg-overdue --quiet --mail

The first example runs emborg-overdue at 5:04 AM every day while saving the
output into a file. The use of the ``--mail`` option causes *emborg-overdue* to
send mail to the maintainer when backups are found to be overdue.

The second example is similar except the output suppressed rather than being
saved to a file.

0 comments on commit e7ba2c8

Please sign in to comment.