|
From: <di...@us...> - 2008-11-19 20:42:42
|
Revision: 628
http://safekeep.svn.sourceforge.net/safekeep/?rev=628&view=rev
Author: dimi
Date: 2008-11-19 20:42:39 +0000 (Wed, 19 Nov 2008)
Log Message:
-----------
Document the new bandwidth limiting feature.
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.backup.txt
safekeep/trunk/doc/safekeep.conf.txt
safekeep/trunk/safekeep.conf
Modified: safekeep/trunk/doc/safekeep.backup.txt
===================================================================
--- safekeep/trunk/doc/safekeep.backup.txt 2008-11-19 19:33:33 UTC (rev 627)
+++ safekeep/trunk/doc/safekeep.backup.txt 2008-11-19 20:42:39 UTC (rev 628)
@@ -30,6 +30,10 @@
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"/>
@@ -118,6 +122,23 @@
is recommended.
Optional, defaults to `~/.ssh/safekeep-server-data-key`.
+/backup/bandwidth/@overall::
+ This is the client bandwidth limit for both upload and download.
+ It is an integer number of KB/s (see the NOTES section in
+ `safekeep.conf(5)` for more information).
+ Optional, overrides `bandwidth.overall` in `safekeep.conf(5)`
+ if specified.
+
+/backup/bandwidth/@download::
+ This is the client bandwidth limit for download (see
+ `/backup/bandwidth/@overall` for more information).
+ Optional, overrides `/backup/bandwidth/@overall` if specified.
+
+/backup/bandwidth/@upload::
+ This is the client bandwidth limit for upload (see
+ `/backup/bandwidth/@overall` for more information).
+ Optional, overrides `/backup/bandwidth/@overall` if specified.
+
/backup/repo/@path::
The path under which the backups will be stored. Relative
paths are based on the 'base.dir' setting from the 'safekeep.conf(5)'.
@@ -292,5 +313,5 @@
SEE ALSO
--------
-safekeep(1), rdiff-backup(1), lvcreate(8)
+safekeep(1), safekeep.conf(5), rdiff-backup(1), lvcreate(8)
Modified: safekeep/trunk/doc/safekeep.conf.txt
===================================================================
--- safekeep/trunk/doc/safekeep.conf.txt 2008-11-19 19:33:33 UTC (rev 627)
+++ safekeep/trunk/doc/safekeep.conf.txt 2008-11-19 20:42:39 UTC (rev 628)
@@ -53,11 +53,44 @@
to 19 (least favorable).
If no nice level is specified, safekeep is not niced.
+bandwidth.overall::
+ 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.
+
+bandwidth.download::
+ 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 `bandwidth.overall` (refer to it for more
+ informatio). This value is optional.
+
+bandwidth.upload::
+ 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 `bandwidth.overall` (refer to it for more
+ informatio). This value is optional.
+
+NOTES
+-----
+Safekeep uses `trickle` 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 `trickle`).
+
+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.
+
+The bandwidth throtlling can be customized for both download and upload
+(see `bandwidth.download` and `bandwidth.upload`) as well as on a per-client
+basis (see `safekeep.backup(5)` for more information).
+
FILES
-----
/etc/safekeep/safekeep.conf
SEE ALSO
--------
-safekeep(1), safekeep.backup(5), rdiff-backup(1), lvcreate(8)
+safekeep(1), safekeep.backup(5), rdiff-backup(1), trickle(1), lvcreate(8)
Modified: safekeep/trunk/safekeep.conf
===================================================================
--- safekeep/trunk/safekeep.conf 2008-11-19 19:33:33 UTC (rev 627)
+++ safekeep/trunk/safekeep.conf 2008-11-19 20:42:39 UTC (rev 628)
@@ -13,6 +13,15 @@
# by default, be nice to the server during backup
nice.adjustment = 10
+# A default bandwidth limit for both download/upload
+# bandwidth.overall=100
+
+# A default bandwidth limit for download
+# bandwidth.download=100
+
+# A default bandwidth limit for upload
+# bandwidth.upload=100
+
# a comma separated list of emails to receive the logs
# ema...@co...,ro...@co...
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|