README 1.52 KB
Newer Older
1 2
this is <README>
===============================================================================
3
csback - A toolkit written in python to manage backups.
4 5 6 7 8 9
===============================================================================

csback is a software suite and toolkit of tools to manage backups and test
their integrity from time to time. The tools are completely written in python
and should work both in python 2 and python 3. Because of avoiding to write
already available tools twice, csback falls back to tools like cron and rsync
Daniel Armbruster's avatar
Daniel Armbruster committed
10 11
the system logger (i.e. syslog-ng) and logrotate whenever possible. These tools
already should be installed on a large range of *nix operating systems.
12 13 14 15

----
Installation:
----
Daniel Armbruster's avatar
Daniel Armbruster committed
16 17 18 19 20 21
Use the provided Makefile and enter 

make install

to your command line. The Makefile will install softlinks to the python scripts
in your local ~/bin directory.
22 23 24 25

----
General approach to use csback:
----
Daniel Armbruster's avatar
Daniel Armbruster committed
26 27 28 29 30 31
First install the csback package as described above. Then write a configuration
file like csbackrc and generate a crontab by using csback2cron. Notice that
csback2cron will not perform any logical checks while converting a configuration
file to the crontab format.
Now announce the generated crontab to your cron deamon. cron will take care
scheduling the processes.
32

Daniel Armbruster's avatar
Daniel Armbruster committed
33 34
For more information how to set up a csback configuration file read the pdf
documentation which comes along with this package.
35

36
----
Daniel Armbruster's avatar
Daniel Armbruster committed
37
Documentation:
38
----
Daniel Armbruster's avatar
Daniel Armbruster committed
39
This package comes along with a pdf documentation which is located in
40
doc/manual.pdf.
41 42 43

----- END OF README -----