"Fossies" - the Fresh Open Source Software Archive

Member "safekeep-1.5.1/doc/safekeep.conf.txt" (16 Nov 2020, 6976 Bytes) of package /linux/misc/safekeep-1.5.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "safekeep.conf.txt": 1.5.0_vs_1.5.1.

    1 :man source: safekeep
    2 :man version: {revnumber}
    3 :man manual: SafeKeep Server Configuration
    4 
    5 safekeep.conf(5)
    6 ================
    7 
    8 NAME
    9 ----
   10 safekeep.conf - Configuration file for 'safekeep(1)'
   11 
   12 SYNOPSIS
   13 --------
   14 This file resides in `/etc/safekeep/`, or optionally in
   15 `~/.safekeep/` for non-root users, from where it
   16 will be automatically picked up by 'safekeep(1)'.
   17 
   18 DESCRIPTION
   19 -----------
   20 This configuration file holds safekeep global settings. 
   21 The format of the file is a simple key-value pair similar
   22 to Java properties files: lines starting with '#' are ignored
   23 as comments, keys are separated from values by '=', and
   24 leading and trailing spaces are ignored.
   25 
   26 PARAMETERS
   27 ----------
   28 
   29 backup.user::
   30 	The Unix user under which the server will run.
   31 	If not specified, `safekeep` will just run under the
   32 	current user.
   33 
   34 backup.tempdir::
   35 	Specifes a TEMPDIR for use with `rdiff-backup'.
   36 	This can be overridden by a commandline argument to `safekeep'.
   37 
   38 base.dir::
   39 	The base directory for date repository relative paths.
   40 	If not specified, it defaults to the home directory
   41 	of the backup user.
   42 
   43 client.user::
   44 	The default Unix user which will be used on the client.
   45 	This can be overridden on a host by host basis in the `.backup`
   46 	file.
   47 	If not specified, it defaults to `root`.
   48 
   49 email.format::
   50 	If specified generate multipart MIME email messages.
   51 	If not specified then a non-MIME message is created.
   52 	The format options are 'text' or 'html' to generate parts of
   53 	that type.
   54 	NB: The log of `safekeep` is always sent as 'text'.
   55 
   56 email.from::
   57 	The email address to be used as sender when sending the logs.
   58 	If not specified `safekeep` will use SafeKeep@<hostname fqdn>.
   59 
   60 email.to::
   61 	In addition to writing the session logs
   62 	on the standard output, `safekeep` can also send the
   63 	logs via email to a number of recipients.
   64 	This comma-separated list of emails designates
   65 	the recipients of the logs. If not specified,
   66 	`safekeep` will not attempt to email the logs.
   67 
   68 email.smtp.port::
   69 	Specifies the port to use to connect to the SMTP server.
   70 	If not specified, `safekeep` will use the system default
   71 	value, normally port 25/tcp.
   72 
   73 email.smtp.server::
   74 	Specifies the SMTP server used for sending mails 
   75 	if the `email.to` specifies any recipients.
   76 	If not specified, `safekeep` will just use
   77 	`/usr/sbin/sendmail` to deliver the mail.
   78 
   79 email.summary::
   80 	Generate a summary part at the start of the email.
   81 	Possible options are 'true', 'yes' or '1'.  Anything elses
   82 	as taken as 'false'.
   83 	NB: This requires 'email.format' set and currently only used
   84 	for 'server' and 'list' run types.
   85 
   86 nice.adjustment::
   87 	The default nice level adjustment for safekeep.
   88 	It specifies an integer to be added to the current nice 
   89 	level. Nicenesses range from -20 (most favorable scheduling) 
   90 	to 19 (least favorable).
   91 	To disable nice, set this value to 0.
   92 	If no nice level is specified, safekeep is niced at +10.
   93 
   94 nice.adjustment.server::
   95 	The nice level adjustment for safekeep, used on the server side.
   96 	It overrides the generic setting in nice.adjustment.
   97 
   98 nice.adjustment.client::
   99 	The default nice adjustment for the client. This settings is normally
  100 	not all that important, as most of the load is on the server side.
  101 	You can also set the remove nice level on a per-client basis in
  102 	the .backup file (see /backup/host/@nice).
  103 	NB: if you change this value, you will have to re-deploy the auth keys.
  104 
  105 ionice.adjustment::
  106 	The default IO nice level adjustment for safekeep.
  107 	It can be either 'none', 'idle', or an integer between 0-7
  108 	(with 0 being higher priority). See ionice(1) for more information.
  109 	This is currently being used only on the server side, where
  110 	IO load tends to be a problem.
  111 	NB: this depends on the availability of 'ionice(1)' on the
  112 	system where the server is running. If ionice cannot be found,
  113 	this setting is ignored.
  114 	If no level is specified, it defaults to 'idle'.
  115 
  116 bandwidth.overall::
  117 	This is the default bandwidth limit for both upload and
  118 	download for all the clients. It is an integer number of KB/s
  119 	(see NOTES section for more information). 
  120 	This value is optional.
  121 	
  122 bandwidth.download::
  123 	This is the default bandwidth limit for download across all clients.
  124 	If specified (with a value greater than 0) it will override
  125 	the value set in `bandwidth.overall` (refer to it for more
  126 	informatio). This value is optional.
  127 
  128 bandwidth.upload::
  129 	This is the default bandwidth limit for upload across all clients.
  130 	If specified (with a value greater than 0) it will override
  131 	the value set in `bandwidth.overall` (refer to it for more
  132 	information). This value is optional.
  133 
  134 snapshot.size::
  135 	This is the default size to be used for any snapshots without a
  136 	`size` value specified.
  137 	It is passed to 'lvcreate(8)' (LVM2), including the specification of
  138 	a percentage (`%`).  If not otherwise specified, the percentage is
  139 	based on unallocated space (i.e. LVM2 '%FREE'), which is different
  140 	to the interpretation within the `<snapshot>` option.
  141 	This value is optional, it defaults to '20%FREE'.
  142 
  143 ssh.keygen.type::
  144 	The SSH private key type to generate when 'safekeep --keys' is used.
  145 	This is passed to 'ssh-keygen(1)' and not all valid types may be
  146 	accepted on all systems.
  147 	Only SSH protocol version 2 keys are accepted.
  148 	This value is optional, it defaults to 'rsa'.
  149 
  150 ssh.keygen.bits::
  151 	Specifies the number of bits in the SSH private key to create.
  152 	This is passed to 'ssh-keygen(1)' and only certain sizes are
  153 	accepted, depending of the key type.
  154 	If no value is required, e.g. for 'ecdsa' key type, give this
  155 	option with no corresponding bit size.
  156 	This value is optional, it defaults to '4096'.
  157 
  158 ssh.strict_hostkey_checking::
  159 	Specifies if StrictHostKeyChecking should be performed by the ssh
  160 	client when connecting to the remote host.
  161 	This value is optional, it defaults to 'ask'.
  162 	Set to 'yes' if you sign host keys with a CA key or manage host keys
  163 	by other means (FreeIPA/sssd, Ansible,,,).
  164 	Setting this to 'no' is a bit unsafe as new hosts are automatically
  165 	added to known_hosts without any validation.
  166 
  167 NOTES
  168 -----
  169 Safekeep uses `trickle` to implement bandwidth throttling (see
  170 http://monkey.org/~marius/pages/?page=trickle for more information). 
  171 You  will need to install it separately to use this feature (most
  172 Linux distributions have it packaged as `trickle`).
  173 
  174 The bandwidth is calculated as an average over a 256KB window, 
  175 and it is  expressed as an integer number of kilo-bytes per second 
  176 (e.g. 100, meaning 100KB/s). Bandwidth limits of zero are ignored.
  177 
  178 The bandwidth throtlling can be customized for both download and upload
  179 (see `bandwidth.download` and `bandwidth.upload`) as well as on a per-client
  180 basis (see `safekeep.backup(5)` for more information).
  181 
  182 FILES
  183 -----
  184     /etc/safekeep/safekeep.conf
  185     ~/.safekeep/safekeep.conf
  186 
  187 SEE ALSO
  188 --------
  189 safekeep(1), safekeep.backup(5), rdiff-backup(1), trickle(1), lvcreate(8),
  190 ssh-keygen(1)
  191 
  192 AUTHOR
  193 ------
  194 This man page was originally written by Dimi Paun <dimi@lattica.com>.
  195