Menu
▾
▴
SF.net SVN: safekeep:[644] website/trunk/WebContent
|
From: <di...@us...> - 2009-03-30 06:32:01
|
Revision: 644
http://safekeep.svn.sourceforge.net/safekeep/?rev=644&view=rev
Author: dimi
Date: 2009-03-30 06:31:52 +0000 (Mon, 30 Mar 2009)
Log Message:
-----------
Update man pages on website to latest as of Mon Mar 30 02:31:47 EDT 2009
Modified Paths:
--------------
website/trunk/WebContent/safekeep.backup.html
website/trunk/WebContent/safekeep.conf.html
Modified: website/trunk/WebContent/safekeep.backup.html
===================================================================
--- website/trunk/WebContent/safekeep.backup.html 2009-03-30 06:24:10 UTC (rev 643)
+++ website/trunk/WebContent/safekeep.backup.html 2009-03-30 06:31:52 UTC (rev 644)
@@ -338,24 +338,25 @@
key-data="/home/jdoe/.ssh/backup2_id_dsa"
/>
+ <!-- you can customize the bandwidth limit on a client basis,
+ for example to 50KB/s download/upload -->
+ <bandwidth overall="80" download="50" upload="50" />
+
<!-- location where the backups will be stored on the server
and for how long (D=days, W=weeks, M=months, or Y=years) -->
<repo path="./data" retention="10D"/>
- <options>
- <special-files include="false" />
- </options>
-
<!-- settings for database dump and for volume snapshot -->
<setup>
<!-- database type ("postgres" or "mysql"), and database name,
DB user with backup rights, location of the dump file on the client
host, and flag to remove or not the dump file after the backup is done.
- Databases can be dumped individualy using a dump clause for each database. -->
+ Databases can be dumped individually using a dump clause for each database. -->
<dump
type="postgres"
- db="dbname"
+ db="my_db"
dbuser="foobar"
+ options="--schema=public"
file="/var/backup/dumps/mydata"
cleanup="true"
/>
@@ -367,10 +368,17 @@
size="500M"
/>
+ <!-- location of a script to be executed on the client at different
+ stages of the run. It is called with three arguments:
+ the step of the backup, backup id and the backup root directory -->
+ <script
+ path="/path/to/script"
+ />
+
</setup>
<!-- data to be backup -->
- <data>
+ <data exclude-fifos="true" exclude-sockets="true">
<!-- each type of tag can be present more than one time -->
<!-- if a database dump was created, it must be added in this section -->
<include path="/home"/>
@@ -456,6 +464,38 @@
</p>
</dd>
<dt>
+/backup/bandwidth/@overall
+</dt>
+<dd>
+<p>
+ This is the client bandwidth limit for both upload and download.
+ It is an integer number of KB/s (see the NOTES section in
+ <tt>safekeep.conf(5)</tt> for more information).
+ Optional, overrides <tt>bandwidth.overall</tt> in <tt>safekeep.conf(5)</tt>
+ if specified.
+</p>
+</dd>
+<dt>
+/backup/bandwidth/@download
+</dt>
+<dd>
+<p>
+ This is the client bandwidth limit for download (see
+ <tt>/backup/bandwidth/@overall</tt> for more information).
+ Optional, overrides <tt>/backup/bandwidth/@overall</tt> if specified.
+</p>
+</dd>
+<dt>
+/backup/bandwidth/@upload
+</dt>
+<dd>
+<p>
+ This is the client bandwidth limit for upload (see
+ <tt>/backup/bandwidth/@overall</tt> for more information).
+ Optional, overrides <tt>/backup/bandwidth/@overall</tt> if specified.
+</p>
+</dd>
+<dt>
/backup/repo/@path
</dt>
<dd>
@@ -469,7 +509,7 @@
will fail altogether if the directory can not be created.
Optional, defaults to the client ID, see <tt>/backup/@id</tt>.
Use of the default value is <strong>highly</strong> recommended.
- <strong>NOTE</strong>: if you must set this value explicitely, you must
+ <strong>NOTE</strong>: if you must set this value explicitly, you must
make sure that the path is not shared between different boxes;
a shared repository path <em>will</em> result in data loss.
</p>
@@ -502,11 +542,12 @@
</dt>
<dd>
<p>
+ NOTE: THIS OPTION HAS BEEN DEPRECATED. See data attributes below.
One of "true" or "false". If "true", the dump file will
include all special files, including device files, fifo files and
socket files.
Optional, defaults to "false".
- <strong>NOTE</strong>: specification of no options is equalent to false, but the
+ <strong>NOTE</strong>: specification of no options is equivalent to false, but the
inclusion of other options may cause the underlying backup defaults
to be use.
</p>
@@ -556,11 +597,25 @@
<dd>
<p>
Password of the database user to use while doing the dump.
- This is currently supported only for MySQL databases.
+ NB: this makes the DB password available in a plain text file.
+ Make sure you use appropriate read permissions on the backup
+ configuration file to prevent unauthorized access to the password.
Optional, it has no default value.
</p>
</dd>
<dt>
+/backup/setup/dump/@options
+</dt>
+<dd>
+<p>
+ Extra options to be passed along to the dump command.
+ This is database specific, and it is passed along as-is.
+ Please refer to your database documentation for possible
+ values that you can pass along.
+ Optional, it has no default value.
+</p>
+</dd>
+<dt>
/backup/setup/dump/@user
</dt>
<dd>
@@ -623,6 +678,74 @@
</p>
</dd>
<dt>
+/backup/setup/script/@path
+</dt>
+<dd>
+<p>
+ Execute the script specified path on the client at certain steps
+ of the backup process.
+ This script is executed with three arguments:
+</p>
+<ul>
+<li>
+<p>
+Backup id (/backup/@id)
+</p>
+</li>
+<li>
+<p>
+Backup step
+</p>
+</li>
+<li>
+<p>
+Backup root directory (valid after creation of a snapshot)
+ See the <tt>CLIENT SCRIPT</tt> section for more information.
+ Mandatory for a <tt><script></tt> element.
+</p>
+</li>
+</ul>
+</dd>
+<dt>
+/backup/data/@exclude-devices
+</dt>
+<dd>
+<p>
+ One of "true" or "false". If "true", the dump file will
+ exclude all device files.
+ Optional, defaults to "false".
+ <strong>NOTE</strong>: specification of no attributes is equivalent to false, but the
+ inclusion of other options may cause the underlying backup defaults
+ to be use.
+</p>
+</dd>
+<dt>
+/backup/data/@exclude-fifos
+</dt>
+<dd>
+<p>
+ One of "true" or "false". If "true", the dump file will
+ exclude all fifos.
+ Optional, defaults to "false".
+ <strong>NOTE</strong>: specification of no attributes is equivalent to false, but the
+ inclusion of other options may cause the underlying backup defaults
+ to be use.
+</p>
+</dd>
+<dt>
+/backup/data/@exclude-sockets
+</dt>
+<dd>
+<p>
+ One of "true" or "false". If "true", the dump file will
+ exclude all sockets.
+ Optional, defaults to "false".
+ <strong>NOTE</strong>: specification of no attribute is equivalent to false, but the
+ inclusion of other options may cause the underlying backup defaults
+ to be use.
+</p>
+</dd>
+<dt>
/backup/data/exclude/@path
</dt>
<dd>
@@ -700,13 +823,48 @@
Each file selection condition either matches or doesn't match a given file.
A given file is included or excluded by the file selection system when the
first matching file selection condition specifies that the file be included
-or excluded respecively; if the file matches no include or exclude
+or excluded respectively; if the file matches no include or exclude
statement, it is by default excluded.</p>
<p>When backing up, if a file is excluded, <tt>safekeep(1)</tt> acts
as if that file does not exist in the source directory.</p>
<p>For more information on file selection semantics, please see
<tt>rdiff-backup(1)</tt>.</p>
</div>
+<h2>CLIENT SCRIPT</h2>
+<div class="sectionbody">
+<p><tt>safekeep(1)</tt> support the optional execution of a script or program
+on the client system at different steps during execution of the backup.</p>
+<p>Note: specification of a script which does not exist is not considered an
+error, and is treated as the same as not specifying a script. However, if
+the specified path does match a file or directory, the security tests listed
+below will occur.</p>
+<p>This script is executed with the following three arguments:
+- Safekeep step
+- Backup id
+- Backup root directory, which may be set during the creation of a snapshot.</p>
+<p>The steps currently defined and tokens passed, are:
+- STARTUP - prior to any execution, however, if it exits with a non-zero
+status this constitutes an error and the backup is aborted.
+- PRE-SETUP - prior to running any setup steps being run. A non-zero status
+is considered a warning and execution continues.
+- POST-SETUP - after setup, but prior to execution of backup. A non-zero
+status is considered a warning, and execution continues.
+- POST-BACKUP - after execution of backup. A non-zero status is considered
+a warning, and execution continues.
+- POST-SCRUB - after execution of a server cleanup step, normally only seen
+after a backup failure. A non-zero status is considered a warning, and
+execution continues.</p>
+<p>Due to security considerations, there are a number of checks made on this
+script prior to execution and failure of any of these steps will cause the
+backup for that client to be aborted. The following tests are applied prior
+to each execution of the script (i.e. multiple time per backup), in order:
+- script is a regular file, not a directory or special file,
+- script is executable by the user running on the client system,
+- script is owned by root or the user running on the client system,
+- script is NOT writable by any one except the script owner.</p>
+<p>Note: no test is made on the ownership of the parent directory or any other
+directories.</p>
+</div>
<h2>FILES</h2>
<div class="sectionbody">
<div class="literalblock">
@@ -716,11 +874,11 @@
</div>
<h2>SEE ALSO</h2>
<div class="sectionbody">
-<p>safekeep(1), rdiff-backup(1), lvcreate(8)</p>
+<p>safekeep(1), safekeep.conf(5), rdiff-backup(1), lvcreate(8)</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 07-Oct-2008 16:17:27 EDT
+Last updated 30-Mar-2009 02:31:48 EDT
</div>
</div>
</body>
Modified: website/trunk/WebContent/safekeep.conf.html
===================================================================
--- website/trunk/WebContent/safekeep.conf.html 2009-03-30 06:24:10 UTC (rev 643)
+++ website/trunk/WebContent/safekeep.conf.html 2009-03-30 06:31:52 UTC (rev 644)
@@ -373,8 +373,67 @@
<tt>/usr/sbin/sendmail</tt> to deliver the mail.
</p>
</dd>
+<dt>
+nice.adjustment
+</dt>
+<dd>
+<p>
+ The nice level adjustment for safekeep, for the time
+ being used only on the server side.
+ It specifies an integer to be added to the current nice
+ level. Nicenesses range from -20 (most favorable scheduling)
+ to 19 (least favorable).
+ If no nice level is specified, safekeep is not niced.
+</p>
+</dd>
+<dt>
+bandwidth.overall
+</dt>
+<dd>
+<p>
+ This is the default bandwidth limit for both upload and
+ download for all the clients. It is an integer number of KB/s
+ (see NOTES section for more information).
+ This value is optional.
+</p>
+</dd>
+<dt>
+bandwidth.download
+</dt>
+<dd>
+<p>
+ This is the default bandwidth limit for download across all clients.
+ If specified (with a value greater than 0) it will override
+ the value set in <tt>bandwidth.overall</tt> (refer to it for more
+ informatio). This value is optional.
+</p>
+</dd>
+<dt>
+bandwidth.upload
+</dt>
+<dd>
+<p>
+ This is the default bandwidth limit for upload across all clients.
+ If specified (with a value greater than 0) it will override
+ the value set in <tt>bandwidth.overall</tt> (refer to it for more
+ informatio). This value is optional.
+</p>
+</dd>
</dl>
</div>
+<h2>NOTES</h2>
+<div class="sectionbody">
+<p>Safekeep uses <tt>trickle</tt> to implement bandwidth throttling (see
+http://monkey.org/~marius/pages/?page=trickle for more information).
+You will need to install it separately to use this feature (most
+Linux distributions have it packaged as <tt>trickle</tt>).</p>
+<p>The bandwidth is calculated as an average over a 256KB window,
+and it is expressed as an integer number of kilo-bytes per second
+(e.g. 100, meaning 100KB/s). Bandwidth limits of zero are ignored.</p>
+<p>The bandwidth throtlling can be customized for both download and upload
+(see <tt>bandwidth.download</tt> and <tt>bandwidth.upload</tt>) as well as on a per-client
+basis (see <tt>safekeep.backup(5)</tt> for more information).</p>
+</div>
<h2>FILES</h2>
<div class="sectionbody">
<div class="literalblock">
@@ -384,11 +443,11 @@
</div>
<h2>SEE ALSO</h2>
<div class="sectionbody">
-<p>safekeep(1), safekeep.backup(5), rdiff-backup(1), lvcreate(8)</p>
+<p>safekeep(1), safekeep.backup(5), rdiff-backup(1), trickle(1), lvcreate(8)</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 26-Feb-2008 16:08:19 EDT
+Last updated 30-Mar-2009 02:31:48 EDT
</div>
</div>
</body>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
