1SAFEKEEP.CONF(5) [FIXME: manual] SAFEKEEP.CONF(5)
2
6 safekeep.conf - Configuration file for 'safekeep(1)'
7
9 This file resides in /etc/safekeep/ from where it will be automatically
10 picked up by safekeep(1).
11
13 This configuration file holds safekeep global settings. The format of
14 the file is a simple key-value pair similar to Java properties files:
15 lines starting with # are ignored as comments, keys are separated from
16 values by =, and leading and trailing spaces are ignored.
17
19 backup.user
20 The Unix user under which the server will run. If not specified,
21 safekeep will just run under the current user.
22 base.dir
24 The base directory for date repository relative paths. If not
25 specified, it defaults to the home directory of the backup user.
26 email.from
28 The email address to be used as sender when sending the logs. If
29 not specified safekeep will use SafeKeep@<hostname fqdn>.
30 email.to
32 In addition to writing the session logs on the standard output,
33 safekeep can also send the logs via email to a number of
34 recipients. This comma-separated list of emails designates the
35 recipients of the logs. If not specified, safekeep will not attempt
36 to email the logs.
37 email.smtp.server
39 Specifies the SMTP server used for sending mails if the email.to
40 specifies any recipients. If not specified, safekeep will just use
41 /usr/sbin/sendmail to deliver the mail.
42 nice.adjustment
44 The default nice level adjustment for safekeep. It specifies an
45 integer to be added to the current nice level. Nicenesses range
46 from -20 (most favorable scheduling) to 19 (least favorable). To
47 disable nice, set this value to 0. If no nice level is specified,
48 safekeep is niced at +10.
49 nice.adjustment.server
51 The nice level adjustment for safekeep, used on the server side. It
52 overrides the generic setting in nice.adjustment.
53 nice.adjustment.client
55 The default nice adjustment for the client. This settings is
56 normally not all that important, as most of the load is on the
57 server side. You can also set the remove nice level on a per-client
58 basis in the .backup file (see /backup/host/@nice). NB: if you
59 change this value, you will have to re-deploy the auth keys.
60 ionice.adjustment
62 The default IO nice level adjustment for safekeep. It can be either
63 none, idle, or an integer between 0-7 (with 0 being higher
64 priority). See ionice(1) for more information. This is currently
65 being used only on the server side, where IO load tends to be a
66 problem. NB: this depends on the availability of ionice(1) on the
67 system where the server is running. If ionice cannot be found, this
68 setting is ignored. If no level is specified, it defaults to idle.
69 bandwidth.overall
71 This is the default bandwidth limit for both upload and download
72 for all the clients. It is an integer number of KB/s (see NOTES
73 section for more information). This value is optional.
74 bandwidth.download
76 This is the default bandwidth limit for download across all
77 clients. If specified (with a value greater than 0) it will
78 override the value set in bandwidth.overall (refer to it for more
79 informatio). This value is optional.
80 bandwidth.upload
82 This is the default bandwidth limit for upload across all clients.
83 If specified (with a value greater than 0) it will override the
84 value set in bandwidth.overall (refer to it for more informatio).
85 This value is optional.
86
88 Safekeep uses trickle to implement bandwidth throttling (see
89 http://monkey.org/~marius/pages/?page=trickle for more information).
90 You will need to install it separately to use this feature (most Linux
91 distributions have it packaged as trickle).
92 The bandwidth is calculated as an average over a 256KB window, and it
94 is expressed as an integer number of kilo-bytes per second (e.g. 100,
95 meaning 100KB/s). Bandwidth limits of zero are ignored.
96 The bandwidth throtlling can be customized for both download and upload
98 (see bandwidth.download and bandwidth.upload) as well as on a
99 per-client basis (see safekeep.backup(5) for more information).
100
102 /etc/safekeep/safekeep.conf
103
105 safekeep(1), safekeep.backup(5), rdiff-backup(1), trickle(1),
106 lvcreate(8)
107[FIXME: source] 11/27/2011 SAFEKEEP.CONF(5)