New targets for new documentation
This commit is contained in:
Nico Schottelius
parent
517c34880a
commit
05e392e5c1
2 changed files with 6 additions and 863 deletions
10
Makefile
10
Makefile
|
|
@ -7,7 +7,7 @@ INSTALL=install
|
|||
CCOLLECT=ccollect.sh
|
||||
LN=ln -sf
|
||||
|
||||
prefix=/usr/packages/ccollect-0.2
|
||||
prefix=/usr/packages/ccollect-git
|
||||
bindir=$(prefix)/bin
|
||||
destination=$(bindir)/$(CCOLLECT)
|
||||
|
||||
|
|
@ -34,8 +34,9 @@ install-script:
|
|||
$(INSTALL) -D -m 0755 -s $(CCOLLECT) $(destination)
|
||||
|
||||
documentation:
|
||||
@echo "Generating HTML-documentation"
|
||||
@echo "Generating HTML-documentation (en de) ..."
|
||||
@asciidoc -n -o doc/ccollect.html doc/ccollect.text
|
||||
@asciidoc -n -o doc/ccollect-DE.html doc/ccollect-DE.text
|
||||
|
||||
#
|
||||
# Developer targets
|
||||
|
|
@ -48,6 +49,7 @@ push-work:
|
|||
@cg-push sygroup
|
||||
|
||||
publish-doc: documentation
|
||||
@chmod a+r doc/ccollect.html
|
||||
@scp doc/ccollect.html doc/ccollect.text $(host):$(docdir)
|
||||
@echo "Transferring files to $(host)"
|
||||
@chmod a+r doc/*.html doc/*.text
|
||||
@scp doc/*.text doc/*.html $(host):$(docdir)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,859 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
||||
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<meta name="generator" content="AsciiDoc 7.0.2" />
|
||||
<style type="text/css">
|
||||
/* Debug borders */
|
||||
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
|
||||
/*
|
||||
border: 1px solid red;
|
||||
*/
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 1em 5% 1em 5%;
|
||||
}
|
||||
|
||||
a { color: blue; }
|
||||
a:visited { color: fuchsia; }
|
||||
|
||||
em {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
tt {
|
||||
color: navy;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #527bbd;
|
||||
font-family: sans-serif;
|
||||
margin-top: 1.2em;
|
||||
margin-bottom: 0.5em;
|
||||
line-height: 1.3;
|
||||
}
|
||||
|
||||
h1 {
|
||||
border-bottom: 2px solid silver;
|
||||
}
|
||||
h2 {
|
||||
border-bottom: 2px solid silver;
|
||||
padding-top: 0.5em;
|
||||
}
|
||||
|
||||
div.sectionbody {
|
||||
font-family: serif;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid silver;
|
||||
}
|
||||
|
||||
p {
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
span#author {
|
||||
color: #527bbd;
|
||||
font-family: sans-serif;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
span#email {
|
||||
}
|
||||
span#revision {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div#footer {
|
||||
font-family: sans-serif;
|
||||
font-size: small;
|
||||
border-top: 2px solid silver;
|
||||
padding-top: 0.5em;
|
||||
margin-top: 4.0em;
|
||||
}
|
||||
div#footer-text {
|
||||
float: left;
|
||||
padding-bottom: 0.5em;
|
||||
}
|
||||
div#footer-badges {
|
||||
float: right;
|
||||
padding-bottom: 0.5em;
|
||||
}
|
||||
|
||||
div#preamble,
|
||||
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
|
||||
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
||||
div.admonitionblock {
|
||||
margin-right: 10%;
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
div.admonitionblock {
|
||||
margin-top: 2.5em;
|
||||
margin-bottom: 2.5em;
|
||||
}
|
||||
|
||||
div.content { /* Block element content. */
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/* Block element titles. */
|
||||
div.title, caption.title {
|
||||
font-family: sans-serif;
|
||||
font-weight: bold;
|
||||
text-align: left;
|
||||
margin-top: 1.0em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
div.title + * {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
td div.title:first-child {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
div.content div.title:first-child {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
div.content + div.title {
|
||||
margin-top: 0.0em;
|
||||
}
|
||||
|
||||
div.sidebarblock > div.content {
|
||||
background: #ffffee;
|
||||
border: 1px solid silver;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.listingblock > div.content {
|
||||
border: 1px solid silver;
|
||||
background: #f4f4f4;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.quoteblock > div.content {
|
||||
padding-left: 2.0em;
|
||||
}
|
||||
div.quoteblock .attribution {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.admonitionblock .icon {
|
||||
vertical-align: top;
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
text-decoration: underline;
|
||||
color: #527bbd;
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
div.admonitionblock td.content {
|
||||
padding-left: 0.5em;
|
||||
border-left: 2px solid silver;
|
||||
}
|
||||
|
||||
div.exampleblock > div.content {
|
||||
border-left: 2px solid silver;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.verseblock div.content {
|
||||
white-space: pre;
|
||||
}
|
||||
|
||||
div.imageblock div.content { padding-left: 0; }
|
||||
div.imageblock img { border: 1px solid silver; }
|
||||
span.image img { border-style: none; }
|
||||
|
||||
dl {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
dt {
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0;
|
||||
font-style: italic;
|
||||
}
|
||||
dd > *:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
list-style-position: outside;
|
||||
}
|
||||
ol.olist2 {
|
||||
list-style-type: lower-alpha;
|
||||
}
|
||||
|
||||
div.tableblock > table {
|
||||
border-color: #527bbd;
|
||||
border-width: 3px;
|
||||
}
|
||||
thead {
|
||||
font-family: sans-serif;
|
||||
font-weight: bold;
|
||||
}
|
||||
tfoot {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.hlist {
|
||||
margin-top: 0.8em;
|
||||
margin-bottom: 0.8em;
|
||||
}
|
||||
td.hlist1 {
|
||||
vertical-align: top;
|
||||
font-style: italic;
|
||||
padding-right: 0.8em;
|
||||
}
|
||||
td.hlist2 {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
@media print {
|
||||
div#footer-badges { display: none; }
|
||||
}
|
||||
/* Workarounds for IE6's broken and incomplete CSS2. */
|
||||
|
||||
div.sidebar-content {
|
||||
background: #ffffee;
|
||||
border: 1px solid silver;
|
||||
padding: 0.5em;
|
||||
}
|
||||
div.sidebar-title, div.image-title {
|
||||
font-family: sans-serif;
|
||||
font-weight: bold;
|
||||
margin-top: 0.0em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
div.listingblock div.content {
|
||||
border: 1px solid silver;
|
||||
background: #f4f4f4;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.quoteblock-content {
|
||||
padding-left: 2.0em;
|
||||
}
|
||||
|
||||
div.exampleblock-content {
|
||||
border-left: 2px solid silver;
|
||||
padding-left: 0.5em;
|
||||
}
|
||||
</style>
|
||||
<title>ccollect - Installing, Configuring and Using</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="header">
|
||||
<h1>ccollect - Installing, Configuring and Using</h1>
|
||||
<span id="author">Nico Schottelius</span><br />
|
||||
<span id="email"><tt><<a href="mailto:nico-linux-ccollect__@__schottelius.org">nico-linux-ccollect__@__schottelius.org</a>></tt></span><br />
|
||||
<span id="revision">version 0.3.3,</span>
|
||||
for ccollect 0.3.2-0.3.3, Initial Version from 2006-01-13
|
||||
</div>
|
||||
<div id="preamble">
|
||||
<div class="sectionbody">
|
||||
<p>(pseudo) incremental backup
|
||||
with different exclude lists
|
||||
using hardlinks and <tt>rsync</tt></p>
|
||||
</div>
|
||||
</div>
|
||||
<h2>1. Introduction</h2>
|
||||
<div class="sectionbody">
|
||||
<p>ccollect is a backup utitily written in the sh-scripting language.
|
||||
It does not depend on a specific shell, only <tt>/bin/sh</tt> needs to be
|
||||
bourne shell compatibel (like <em>dash</em>, <em>ksh</em>, <em>zsh</em>, <em>bash</em>, …).</p>
|
||||
<h3>1.1. Why you can only backup TO localhost</h3>
|
||||
<p>While thinking about the design of ccollect, I thought about enabling
|
||||
backup to <strong>remote</strong> hosts. Though this sounds like a nice feature
|
||||
(<em>Backup my notebook to the server now.</em>), it is in my opinion a
|
||||
bad idea to backup to a remote host, because you have to open
|
||||
security at your backup host. Think of the following situation: You backup
|
||||
your farm of webservers <strong>to</strong> a backup host somewhere else. One of
|
||||
your webservers gets compromised, then your backup server will be compromised,
|
||||
too. Think of it the other way round: The backup server (now behind a
|
||||
firewall using NAT and strong firewall rules) connects to the
|
||||
webservers and pulls the data <strong>from</strong> them. If someone gets access to one
|
||||
of the webservers, the person will perhaps not even see your machine. If
|
||||
he/she sees that there are connections from a host to the compromised
|
||||
machine, he/she will not be able to login to the backup machine.
|
||||
All other backups are still secure.</p>
|
||||
</div>
|
||||
<h2>2. Requirements</h2>
|
||||
<div class="sectionbody">
|
||||
<h3>2.1. Installing ccollect</h3>
|
||||
<p>For the installation, you need at least</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
either <tt>cp</tt> and <tt>chmod</tt> or <tt>install</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
for more comfort: <tt>make</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
for rebuilding the generated documentation: additionally <tt>asciidoc</tt>
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>2.2. Using ccollect</h3>
|
||||
<div class="title">Running ccollect requires the following tools installed:</div><ul>
|
||||
<li>
|
||||
<p>
|
||||
<tt>bc</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>cp</tt> with support for hard links (<em>cp -al</em>)
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>date</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>rsync</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>ssh</tt> (if you want to use rsync over ssh, which is recommened for security)
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<h2>3. Installing</h2>
|
||||
<div class="sectionbody">
|
||||
<p>Either type <em>make install</em> or simply copy it to a directory in your
|
||||
$PATH and execute <em>chmod <strong>0755</strong> /path/to/ccollect.sh</em>.</p>
|
||||
</div>
|
||||
<h2>4. Configuring</h2>
|
||||
<div class="sectionbody">
|
||||
<h3>4.1. Runtime options</h3>
|
||||
<p><tt>ccollect</tt> looks for its configuration in <em>/etc/ccollect</em> or, if set, in
|
||||
the directory specified by the variable <em>$CCOLLECT_CONF</em>
|
||||
(use <em>CCOLLECT_CONF=/your/config/dir ccollect.sh</em> on the shell).</p>
|
||||
<p>When you start <tt>ccollect</tt>, you have either to specify which intervall
|
||||
to backup (daily, weekly, yearly; you can specify the names yourself, see below).</p>
|
||||
<p>The intervall is used to specify how many backups to keep.</p>
|
||||
<p>There are also some self explaining parameters you can pass to ccollect, simply use
|
||||
"ccollect.sh —help" for info.</p>
|
||||
<h3>4.2. General configuration</h3>
|
||||
<p>The general configuration can be found below $CCOLLECT_CONF/defaults or
|
||||
/etc/ccollect/defaults. All options specified here are generally valid for
|
||||
all source definitions. Though the values can be overwritten in the source
|
||||
configuration.</p>
|
||||
<p>All configuration entries are plain-text (use UTF-8 if you use
|
||||
non ASCII characters) files.</p>
|
||||
<h4>4.2.1. Intervall definition</h4>
|
||||
<p>The intervall definition can be found below
|
||||
<em>$CCOLLECT_CONF/defaults/intervalls/</em> or <em>/etc/ccollect/defaults/intervalls</em>.
|
||||
Every file below this directory specifies an intervall. The name of the file is the
|
||||
name of the intervall: <tt>intervalls/<em><intervall name></em></tt>.</p>
|
||||
<p>The content of this file should be a single line containing a number.
|
||||
This number defines how many versions of this intervall to keep.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [10:23] zaphodbeeblebrox:ccollect-0.2% ls -l conf/defaults/intervalls/
|
||||
insgesamt 12
|
||||
-rw-r--r-- 1 nico users 3 2005-12-08 10:24 daily
|
||||
-rw-r--r-- 1 nico users 3 2005-12-08 11:36 monthly
|
||||
-rw-r--r-- 1 nico users 2 2005-12-08 11:36 weekly
|
||||
[10:23] zaphodbeeblebrox:ccollect-0.2% cat conf/defaults/intervalls/*
|
||||
28
|
||||
12
|
||||
4</tt></pre>
|
||||
</div></div>
|
||||
<p>This means to keep 28 daily backups, 12 monthly backups and 4 weekly.</p>
|
||||
<h4>4.2.2. General pre- and post-execution</h4>
|
||||
<p>If you add <em>$CCOLLECT_CONF/defaults/<tt>pre_exec</tt></em> or
|
||||
<em>/etc/ccollect/defaults/<tt>pre_exec</tt></em> (same with <tt>post_exec</tt>), <tt>ccollect</tt>
|
||||
will start <tt>pre_exec</tt> before the whole backup process and
|
||||
<tt>post_exec</tt> after backup of all sources is done.</p>
|
||||
<p>The following example describes how to report free disk space in
|
||||
human readable format before and after the whole backup process:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>[13:00] hydrogenium:~# mkdir -p /etc/ccollect/defaults/
|
||||
[13:00] hydrogenium:~# echo '#!/bin/sh' > /etc/ccollect/defaults/pre_exec
|
||||
[13:01] hydrogenium:~# echo '' >> /etc/ccollect/defaults/pre_exec
|
||||
[13:01] hydrogenium:~# echo 'df -h' >> /etc/ccollect/defaults/pre_exec
|
||||
[13:01] hydrogenium:~# chmod 0755 /etc/ccollect/defaults/pre_exec
|
||||
[13:01] hydrogenium:~# ln -s /etc/ccollect/defaults/pre_exec /etc/ccollect/defaults/post_exec</tt></pre>
|
||||
</div></div>
|
||||
<h3>4.3. Source configuration</h3>
|
||||
<p>Each source configuration exists below <em>$CCOLLECT_CONF/sources/$name</em> or
|
||||
<em>/etc/ccollect/sources/$name</em>.</p>
|
||||
<p>The name you choose for the subdirectory describes the source.</p>
|
||||
<p>Each source has at least the following files:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<tt>source</tt> (a text file containing the <tt>rsync</tt> compatible path to backup)
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>destination</tt> (a link to the directory we should backup to)
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Additionally a source may have the following files:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
<tt>verbose</tt> whether to be verbose (passes -v to <tt>rsync</tt>)
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>very_verbose</tt> be very verbose (-v also for <tt>mkdir</tt>, <tt>cp</tt>, <tt>rm</tt>)
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>summary</tt> create a transfer summary when <tt>rsync</tt> finished
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>exclude</tt> exclude list for <tt>rsync</tt>. newline (<em>\n</em>) seperated list.
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>rsync_options</tt> extra options to pass to <tt>rsync</tt>
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>pre_exec</tt> program to execute before backuping this source
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
<tt>post_exec</tt> program to execute after backuping this source
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [10:47] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2
|
||||
insgesamt 12
|
||||
lrwxrwxrwx 1 nico users 20 2005-11-17 16:44 destination -> /home/nico/backupdir
|
||||
-rw-r--r-- 1 nico users 62 2005-12-07 17:43 exclude
|
||||
drwxr-xr-x 2 nico users 4096 2005-12-07 17:38 intervalls
|
||||
-rw-r--r-- 1 nico users 15 2005-11-17 16:44 source
|
||||
[10:47] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/exclude
|
||||
openvpn-2.0.1.tar.gz
|
||||
nicht_reinnehmen
|
||||
etwas mit leerzeichenli
|
||||
[10:47] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/intervalls
|
||||
insgesamt 4
|
||||
-rw-r--r-- 1 nico users 2 2005-12-07 17:38 daily
|
||||
[10:48] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/intervalls/daily
|
||||
5
|
||||
[10:48] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/source
|
||||
/home/nico/vpn</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.1. Detailled description of "source"</h4>
|
||||
<p><tt>source</tt> describes a <tt>rsync</tt> compatible source (one line only).</p>
|
||||
<p>For instance <em>backup_user@foreign_host:/home/server/video</em>.
|
||||
To use the <tt>rsync</tt> protocol without the <tt>ssh</tt>-tunnel, use
|
||||
<em>rsync::USER@HOST/SRC</em>. For more information have a look at the manpage
|
||||
of <tt>rsync</tt>,<tt>rsync</tt>(1).</p>
|
||||
<h4>4.3.2. Detailled description of "verbose"</h4>
|
||||
<p><tt>verbose</tt> tells <tt>ccollect</tt> that the log should contain verbose messages.</p>
|
||||
<p>If this file exists in the source specification <strong>-v</strong> will be passed to <tt>rsync</tt>.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [11:35] zaphodbeeblebrox:ccollect-0.2% touch conf/sources/testsource1/verbose</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.3. Detailled description of "very_verbose"</h4>
|
||||
<p><tt>very_verbose</tt> tells <tt>ccollect</tt> that it should log very verbose.</p>
|
||||
<p>If this file exists in the source specification <strong>-v</strong> will be passed to
|
||||
<tt>rsync</tt>, <tt>cp</tt>, <tt>rm</tt> and <tt>mkdir</tt>.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [23:67] nohost:~% touch conf/sources/testsource1/very_verbose</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.4. Detailled description of "summary"</h4>
|
||||
<p>If you create the file <tt>summary</tt> below the source definition,
|
||||
<tt>ccollect</tt> will present you with a nice summary at the end.</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>backup:~# touch /etc/ccollect/sources/root/summary
|
||||
backup:~# ccollect.sh werktags root
|
||||
==> ccollect.sh: Beginning backup using intervall werktags <==
|
||||
[root] Beginning to backup this source ...
|
||||
[root] Currently 3 backup(s) exist, total keeping 50 backup(s).
|
||||
[root] Beginning to backup, this may take some time...
|
||||
[root] Hard linking...
|
||||
[root] Transferring files...
|
||||
[root]
|
||||
[root] Number of files: 84183
|
||||
[root] Number of files transferred: 32
|
||||
[root] Total file size: 26234080536 bytes
|
||||
[root] Total transferred file size: 9988252 bytes
|
||||
[root] Literal data: 9988252 bytes
|
||||
[root] Matched data: 0 bytes
|
||||
[root] File list size: 3016771
|
||||
[root] File list generation time: 1.786 seconds
|
||||
[root] File list transfer time: 0.000 seconds
|
||||
[root] Total bytes sent: 13009119
|
||||
[root] Total bytes received: 2152
|
||||
[root]
|
||||
[root] sent 13009119 bytes received 2152 bytes 2891393.56 bytes/sec
|
||||
[root] total size is 26234080536 speedup is 2016.26
|
||||
[root] Successfully finished backup.
|
||||
==> Finished ccollect.sh <==</tt></pre>
|
||||
</div></div>
|
||||
<p>You could also combine it with <tt>verbose</tt> or <tt>very_verbose</tt>, but they
|
||||
already print some statistics (but not all / the same as presented by
|
||||
<tt>summary</tt>).</p>
|
||||
<h4>4.3.5. Detailled description of "exclude"</h4>
|
||||
<p><tt>exclude</tt> specifies a list of paths to exclude. The entries are new line (\n)
|
||||
seperated.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [11:35] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/exclude
|
||||
openvpn-2.0.1.tar.gz
|
||||
nicht_reinnehmen
|
||||
etwas mit leerzeichenli
|
||||
something with spaces is not a problem</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.6. Detailled description of "destination"</h4>
|
||||
<p><tt>destination</tt> must be a link to the destination directory.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [11:36] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/destination
|
||||
lrwxrwxrwx 1 nico users 20 2005-11-17 16:44 conf/sources/testsource2/destination -> /home/nico/backupdir</tt></pre>
|
||||
</div></div>
|
||||
<p>To speak truth, this is not fully correct. <tt>ccollect</tt> will also backup
|
||||
your data, if <tt>destination</tt> is a directory. But do you really want to have
|
||||
a backup below /etc?</p>
|
||||
<h4>4.3.7. Detailled description of "intervalls/"</h4>
|
||||
<p>When you create a subdirectory <tt>intervalls/</tt> within your source configuration
|
||||
directory, you can specify individiual intervalls for this specific source.
|
||||
Each file below this directory describes an intervall.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [11:37] zaphodbeeblebrox:ccollect-0.2% ls -l conf/sources/testsource2/intervalls/
|
||||
insgesamt 8
|
||||
-rw-r--r-- 1 nico users 2 2005-12-07 17:38 daily
|
||||
-rw-r--r-- 1 nico users 3 2005-12-14 11:33 yearly
|
||||
[11:37] zaphodbeeblebrox:ccollect-0.2% cat conf/sources/testsource2/intervalls/*
|
||||
5
|
||||
20</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.8. Detailled description of "rsync_options"</h4>
|
||||
<p>When you create the file <tt>rsync_options</tt> below your source configuration,
|
||||
all the parameters found in this file will be passed to rsync. This
|
||||
way you can pass additional options to rsync. For instance you can tell rsync
|
||||
to show progress ("—progress") or which -password-file ("—password-file")
|
||||
to use for automatic backup over the rsync-protocol.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt> [23:42] hydrogenium:ccollect-0.2% cat conf/sources/test_rsync/rsync_options
|
||||
--password-file=/home/user/backup/protected_password_file</tt></pre>
|
||||
</div></div>
|
||||
<h4>4.3.9. Detailled description of "pre_exec" and "post_exec"</h4>
|
||||
<p>When you create <tt>pre_exec</tt> and / or <tt>post_exec</tt> below your source
|
||||
configuration, <tt>ccollect</tt> will execute this command before,
|
||||
respective after doing the backup for <strong>this specific</strong> source.
|
||||
If you want to have pre-/post-exec before and after <strong>all</strong>
|
||||
backups, see above for general configuration.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>[13:09] hydrogenium:ccollect-0.3% cat conf/sources/with_exec/pre_exec
|
||||
#!/bin/sh
|
||||
|
||||
# Show whats free before
|
||||
df -h
|
||||
[13:09] hydrogenium:ccollect-0.3% cat conf/sources/with_exec/post_exec
|
||||
#!/bin/sh
|
||||
|
||||
# Show whats free after
|
||||
df -h</tt></pre>
|
||||
</div></div>
|
||||
</div>
|
||||
<h2>5. Hints</h2>
|
||||
<div class="sectionbody">
|
||||
<h3>5.1. Using rsync protocol without ssh</h3>
|
||||
<p>When you have a computer with little computing power, it may be useful to use
|
||||
rsync without ssh, directly using the rsync protocol
|
||||
(specify <em>user@host::share</em> in <tt>source</tt>). You may wish to use
|
||||
<tt>rsync_options</tt> to specify a password file to use for automatic backup.</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>backup:~# cat /etc/ccollect/sources/sample.backup.host.org/source
|
||||
backup@webserver::backup-share
|
||||
|
||||
backup:~# cat /etc/ccollect/sources/sample.backup.host.org/rsync_options
|
||||
--password-file=/etc/ccollect/sources/sample.backup.host.org/rsync_password
|
||||
|
||||
backup:~# cat /etc/ccollect/sources/sample.backup.host.org/rsync_password
|
||||
this_is_the_rsync_password</tt></pre>
|
||||
</div></div>
|
||||
<p>This hint was reported by Daniel Aubry.</p>
|
||||
<h3>5.2. Not-excluding top-level directories</h3>
|
||||
<p>When you exclude "/proc" or "/mnt" from your backup, you may run into
|
||||
trouble when you restore your backup. When you use "/proc/*" or "/mnt/*"
|
||||
instead <tt>ccollect</tt> will backup empty directories.</p>
|
||||
<div class="admonitionblock">
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
<div class="title">Note</div>
|
||||
</td>
|
||||
<td class="content">
|
||||
<p>When those directories contain hidden files
|
||||
(those beginning with a dot (<strong>.</strong>)),
|
||||
they will still be transferred!</p>
|
||||
</td>
|
||||
</tr></table>
|
||||
</div>
|
||||
<p>This hint was reported by Marcus Wagner.</p>
|
||||
<h3>5.3. Re-using already created rsync-backups</h3>
|
||||
<p>If you used <tt>rsync</tt> directly before you use <tt>ccollect</tt>, you can
|
||||
use this old backup as initial backup for <tt>ccollect</tt>: You
|
||||
simply move it into a subdirectory named "<em>intervall</em>.0".</p>
|
||||
<p>Example:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>backup:/home/backup/web1# ls
|
||||
bin dev etc initrd lost+found mnt root srv usr vmlinuz
|
||||
boot doc home lib media opt sbin tmp var vmlinuz.old
|
||||
|
||||
backup:/home/backup/web1# mkdir daily.0
|
||||
|
||||
# ignore error about copying to itself
|
||||
backup:/home/backup/web1# mv * daily.0 2>/dev/null
|
||||
|
||||
backup:/home/backup/web1# ls
|
||||
daily.0</tt></pre>
|
||||
</div></div>
|
||||
<p>Now you could use /home/backup/web1 as the <tt>destination</tt> for the backup.</p>
|
||||
<div class="admonitionblock">
|
||||
<table><tr>
|
||||
<td class="icon">
|
||||
<div class="title">Note</div>
|
||||
</td>
|
||||
<td class="content">
|
||||
<p>Do <strong>not</strong> name the first backup something like "daily.initial", but use
|
||||
the "<strong>0</strong>" (or some very low number, at least lower than the current year)
|
||||
as extension. <tt>ccollect</tt> uses <tt>sort</tt> to find the latest backup. <tt>ccollect</tt>
|
||||
itself uses <em>intervall.YEAR-MONTH-DAY-HOUR:MINUTE.PID</em>. This notation will
|
||||
<strong>always</strong> be before "daily.initial", as numbers are earlier in the list
|
||||
which is produced by <tt>sort</tt>. So, if you have a directory named "daily.initial",
|
||||
<tt>ccollect</tt> will always diff against this backup and transfer and delete
|
||||
files which where deleted in previous backups. This means you simply
|
||||
waste resources, but your backup will be complete.</p>
|
||||
</td>
|
||||
</tr></table>
|
||||
</div>
|
||||
<h3>5.4. Using pre_/post_exec</h3>
|
||||
<p>Your pre_/post_exec script does not need to be a script, you can also
|
||||
use a link to</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
an existing program
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
an already written script
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The only requirement is that it is executable.</p>
|
||||
</div>
|
||||
<h2>6. F.A.Q.</h2>
|
||||
<div class="sectionbody">
|
||||
<h3>6.1. What happens, if one backup is broken or empty?</h3>
|
||||
<p>Let us assume, that one backup failed (connection broke or the source
|
||||
hard disk had some failures). So we've one backup in our history,
|
||||
which is incomplete.</p>
|
||||
<p>The next time you use <tt>ccollect</tt>, it will transfer the missing files.
|
||||
This leads to</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>
|
||||
more transferred files
|
||||
</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>
|
||||
much greater disk space usage, as no hardlinks can be used
|
||||
</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>6.2. When backing up from localhost the destination is also included. Is this a bug?</h3>
|
||||
<p>No. <tt>ccollect</tt> passes your source definition directly to <tt>rsync</tt>. It
|
||||
does not try to analyze it. So it actually does not know if a source
|
||||
comes from local harddisk or from a remote server. And it does not want
|
||||
to. When you backup from the local harddisk (which is perhaps not
|
||||
even a good idea when thinking of security) add the <tt>destination</tt>
|
||||
to <em>source/exclude</em>. (Daniel Aubry reported this problem)</p>
|
||||
<h3>6.3. Why does ccollect say "Permission denied" with my pre-/postexec script?</h3>
|
||||
<p>The most common error is to not give your script the correct
|
||||
permissions. Try <tt>chmod 0755 /etc/ccollect/sources/<em>yoursource</em>/*_exec</tt>`.</p>
|
||||
</div>
|
||||
<h2>7. Examples</h2>
|
||||
<div class="sectionbody">
|
||||
<h3>7.1. A backup host configuration from scratch</h3>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>srwali01:~# mkdir /etc/ccollect
|
||||
srwali01:~# mkdir -p /etc/ccollect/defaults/intervalls/
|
||||
srwali01:~# echo 28 > /etc/ccollect/defaults/intervalls/taeglich
|
||||
srwali01:~# echo 52 > /etc/ccollect/defaults/intervalls/woechentlich
|
||||
srwali01:~# cd /etc/ccollect/
|
||||
srwali01:/etc/ccollect# mkdir sources
|
||||
srwali01:/etc/ccollect# cd sources/
|
||||
srwali01:/etc/ccollect/sources# ls
|
||||
srwali01:/etc/ccollect/sources# mkdir local-root
|
||||
srwali01:/etc/ccollect/sources# cd local-root/
|
||||
srwali01:/etc/ccollect/sources/local-root# echo / > source
|
||||
srwali01:/etc/ccollect/sources/local-root# cat > exclude << EOF
|
||||
> /proc
|
||||
> /sys
|
||||
> /mnt
|
||||
> EOF
|
||||
srwali01:/etc/ccollect/sources/local-root# ln -s /mnt/hdbackup/local-root destination
|
||||
srwali01:/etc/ccollect/sources/local-root# mkdir /mnt/hdbackup/local-root
|
||||
srwali01:/etc/ccollect/sources/local-root# ccollect.sh taeglich local-root
|
||||
/o> ccollect.sh: Beginning backup using intervall taeglich
|
||||
/=> Beginning to backup "local-root" ...
|
||||
|-> 0 backup(s) already exist, keeping 28 backup(s).</tt></pre>
|
||||
</div></div>
|
||||
<p>After that, I added some more sources:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>srwali01:~# cd /etc/ccollect/sources
|
||||
srwali01:/etc/ccollect/sources# mkdir windos-wl6
|
||||
srwali01:/etc/ccollect/sources# cd windos-wl6/
|
||||
srwali01:/etc/ccollect/sources/windos-wl6# echo /mnt/win/SYS/WL6 > source
|
||||
srwali01:/etc/ccollect/sources/windos-wl6# ln -s /mnt/hdbackup/wl6 destination
|
||||
srwali01:/etc/ccollect/sources/windos-wl6# mkdir /mnt/hdbackup/wl6
|
||||
srwali01:/etc/ccollect/sources/windos-wl6# cd ..
|
||||
srwali01:/etc/ccollect/sources# mkdir windos-daten
|
||||
srwali01:/etc/ccollect/sources/windos-daten# echo /mnt/win/Daten > source
|
||||
srwali01:/etc/ccollect/sources/windos-daten# ln -s /mnt/hdbackup/windos-daten destination
|
||||
srwali01:/etc/ccollect/sources/windos-daten# mkdir /mnt/hdbackup/windos-daten
|
||||
|
||||
# Now add some remote source
|
||||
srwali01:/etc/ccollect/sources/windos-daten# cd ..
|
||||
srwali01:/etc/ccollect/sources# mkdir srwali03
|
||||
srwali01:/etc/ccollect/sources# cd srwali03/
|
||||
srwali01:/etc/ccollect/sources/srwali03# cat > exclude << EOF
|
||||
> /proc
|
||||
> /sys
|
||||
> /mnt
|
||||
> /home
|
||||
> EOF
|
||||
srwali01:/etc/ccollect/sources/srwali03# echo 'root@10.103.2.3:/' > source
|
||||
srwali01:/etc/ccollect/sources/srwali03# ln -s /mnt/hdbackup/srwali03 destination
|
||||
srwali01:/etc/ccollect/sources/srwali03# mkdir /mnt/hdbackup/srwali03</tt></pre>
|
||||
</div></div>
|
||||
<h3>7.2. Using hard-links requires less disk space</h3>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt># du (coreutils) 5.2.1
|
||||
[10:53] srsyg01:sources% du -sh ~/backupdir
|
||||
4.6M /home/nico/backupdir
|
||||
[10:53] srsyg01:sources% du -sh ~/backupdir/*
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:52.28456
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28484
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28507
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28531
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28554
|
||||
4.1M /home/nico/backupdir/daily.2005-12-08-10:53.28577
|
||||
|
||||
srwali01:/etc/ccollect/sources# du -sh /mnt/hdbackup/wl6/
|
||||
186M /mnt/hdbackup/wl6/
|
||||
srwali01:/etc/ccollect/sources# du -sh /mnt/hdbackup/wl6/*
|
||||
147M /mnt/hdbackup/wl6/taeglich.2005-12-08-14:42.312
|
||||
147M /mnt/hdbackup/wl6/taeglich.2005-12-08-14:45.588</tt></pre>
|
||||
</div></div>
|
||||
<p>The backup of our main fileserver:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>backup:~# df -h /home/backup/srsyg01/
|
||||
Filesystem Size Used Avail Use% Mounted on
|
||||
/dev/mapper/backup--01-srsyg01
|
||||
591G 451G 111G 81% /home/backup/srsyg01
|
||||
backup:~# du -sh /home/backup/srsyg01/*
|
||||
432G /home/backup/srsyg01/daily.2006-01-24-01:00.15990
|
||||
432G /home/backup/srsyg01/daily.2006-01-26-01:00.30152
|
||||
434G /home/backup/srsyg01/daily.2006-01-27-01:00.4596
|
||||
435G /home/backup/srsyg01/daily.2006-01-28-01:00.11998
|
||||
437G /home/backup/srsyg01/daily.2006-01-29-01:00.19115
|
||||
437G /home/backup/srsyg01/daily.2006-01-30-01:00.26405
|
||||
438G /home/backup/srsyg01/daily.2006-01-31-01:00.1148
|
||||
439G /home/backup/srsyg01/daily.2006-02-01-01:00.8321
|
||||
439G /home/backup/srsyg01/daily.2006-02-02-01:00.15383
|
||||
439G /home/backup/srsyg01/daily.2006-02-03-01:00.22567
|
||||
16K /home/backup/srsyg01/lost+found
|
||||
backup:~# du --version | head -n1
|
||||
du (coreutils) 5.2.1</tt></pre>
|
||||
</div></div>
|
||||
<p>Newer versions of du also detect the hardlinks, so we can even compare
|
||||
the sizes directly with du:</p>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre><tt>[8:16] eiche:~# du --version | head -n 1
|
||||
du (GNU coreutils) 5.93
|
||||
[8:17] eiche:schwarzesloch# du -slh hydrogenium/*
|
||||
19G hydrogenium/durcheinander.0
|
||||
18G hydrogenium/durcheinander.2006-01-17-00:27.13820
|
||||
19G hydrogenium/durcheinander.2006-01-25-23:18.31328
|
||||
19G hydrogenium/durcheinander.2006-01-26-00:11.3332
|
||||
[8:22] eiche:schwarzesloch# du -sh hydrogenium/*
|
||||
19G hydrogenium/durcheinander.0
|
||||
12G hydrogenium/durcheinander.2006-01-17-00:27.13820
|
||||
1.5G hydrogenium/durcheinander.2006-01-25-23:18.31328
|
||||
200M hydrogenium/durcheinander.2006-01-26-00:11.3332</tt></pre>
|
||||
</div></div>
|
||||
<p>In the second report (without -l) the sizes include the space the inodes of
|
||||
the hardlinks allocate.</p>
|
||||
</div>
|
||||
<div id="footer">
|
||||
<div id="footer-text">
|
||||
Version 0.3.3<br />
|
||||
Last updated 24-Feb-2006 09:41:50 CEST
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in a new issue