| 1 | <?xml version="1.0" encoding="UTF-8"?> |
|---|
| 2 | <refentry version="5.0" xmlns="http://docbook.org/ns/docbook" |
|---|
| 3 | xmlns:xlink="http://www.w3.org/1999/xlink" |
|---|
| 4 | xmlns:xi="http://www.w3.org/2001/XInclude" |
|---|
| 5 | xmlns:svg="http://www.w3.org/2000/svg" |
|---|
| 6 | xmlns:m="http://www.w3.org/1998/Math/MathML" |
|---|
| 7 | xmlns:html="http://www.w3.org/1999/xhtml" |
|---|
| 8 | xmlns:db="http://docbook.org/ns/docbook"> |
|---|
| 9 | <refmeta> |
|---|
| 10 | <refentrytitle>bbackupd.conf</refentrytitle> |
|---|
| 11 | |
|---|
| 12 | <manvolnum>5</manvolnum> |
|---|
| 13 | |
|---|
| 14 | <refmiscinfo class="manual">Box Backup</refmiscinfo> |
|---|
| 15 | |
|---|
| 16 | <refmiscinfo class="source">Box Backup</refmiscinfo> |
|---|
| 17 | |
|---|
| 18 | <refmiscinfo class="version">0.11</refmiscinfo> |
|---|
| 19 | </refmeta> |
|---|
| 20 | |
|---|
| 21 | <refnamediv> |
|---|
| 22 | <refname>bbackupd.conf</refname> |
|---|
| 23 | |
|---|
| 24 | <refpurpose>Box Backup client daemon configuration file</refpurpose> |
|---|
| 25 | </refnamediv> |
|---|
| 26 | |
|---|
| 27 | <refsynopsisdiv> |
|---|
| 28 | <cmdsynopsis> |
|---|
| 29 | <command>/etc/box/bbackupd.conf</command> |
|---|
| 30 | </cmdsynopsis> |
|---|
| 31 | </refsynopsisdiv> |
|---|
| 32 | |
|---|
| 33 | <refsection> |
|---|
| 34 | <title>Description</title> |
|---|
| 35 | |
|---|
| 36 | <variablelist> |
|---|
| 37 | <varlistentry> |
|---|
| 38 | <term><varname>AccountNumber</varname></term> |
|---|
| 39 | |
|---|
| 40 | <listitem> |
|---|
| 41 | <para>The account number of this client. This is set by the admin of |
|---|
| 42 | the store server.</para> |
|---|
| 43 | </listitem> |
|---|
| 44 | </varlistentry> |
|---|
| 45 | |
|---|
| 46 | <varlistentry> |
|---|
| 47 | <term><varname>UpdateStoreInterval</varname></term> |
|---|
| 48 | |
|---|
| 49 | <listitem> |
|---|
| 50 | <para>Specifies the interval between scanning of the local discs. To |
|---|
| 51 | avoid cycles of load on the server, this time is randomly adjusted |
|---|
| 52 | by a small percentage as the daemon runs. Defaults to 1 hour.</para> |
|---|
| 53 | </listitem> |
|---|
| 54 | </varlistentry> |
|---|
| 55 | |
|---|
| 56 | <varlistentry> |
|---|
| 57 | <term><varname>MinimumFileAge</varname></term> |
|---|
| 58 | |
|---|
| 59 | <listitem> |
|---|
| 60 | <para>Specifies how long since a file was last modified before it |
|---|
| 61 | will be uploaded. Defaults to 6 hours.</para> |
|---|
| 62 | </listitem> |
|---|
| 63 | </varlistentry> |
|---|
| 64 | |
|---|
| 65 | <varlistentry> |
|---|
| 66 | <term><varname>MaxUploadWait</varname></term> |
|---|
| 67 | |
|---|
| 68 | <listitem> |
|---|
| 69 | <para>If a file is repeatedly modified it won't be uploaded |
|---|
| 70 | immediately in case it's modified again. However it should be |
|---|
| 71 | uploaded eventually. This is how long we should wait after first |
|---|
| 72 | noticing a change. Defaults to 1 day.</para> |
|---|
| 73 | </listitem> |
|---|
| 74 | </varlistentry> |
|---|
| 75 | |
|---|
| 76 | <varlistentry> |
|---|
| 77 | <term><varname>MaxFileTimeInFuture</varname></term> |
|---|
| 78 | |
|---|
| 79 | <listitem> |
|---|
| 80 | <para></para> |
|---|
| 81 | </listitem> |
|---|
| 82 | </varlistentry> |
|---|
| 83 | |
|---|
| 84 | <varlistentry> |
|---|
| 85 | <term><varname>AutomaticBackup</varname></term> |
|---|
| 86 | |
|---|
| 87 | <listitem> |
|---|
| 88 | <para></para> |
|---|
| 89 | </listitem> |
|---|
| 90 | </varlistentry> |
|---|
| 91 | |
|---|
| 92 | <varlistentry> |
|---|
| 93 | <term><varname>SyncAllowScript</varname></term> |
|---|
| 94 | |
|---|
| 95 | <listitem> |
|---|
| 96 | <para>Use this to temporarily stop bbackupd from syncronising or |
|---|
| 97 | connecting to the store. This specifies a program or script script |
|---|
| 98 | which is run just before each sync, and ideally the full path to the |
|---|
| 99 | interpreter. It will be run as the same user bbackupd is running as, |
|---|
| 100 | usually root.</para> |
|---|
| 101 | |
|---|
| 102 | <para>The script prints either "now" or a number to STDOUT (and a |
|---|
| 103 | terminating newline, no quotes). If the result was "now", then the |
|---|
| 104 | sync will happen. If it's a number, then the script will be asked |
|---|
| 105 | again in that number of seconds.</para> |
|---|
| 106 | |
|---|
| 107 | <para>For example, you could use this on a laptop to only backup |
|---|
| 108 | when on a specific network. </para> |
|---|
| 109 | </listitem> |
|---|
| 110 | </varlistentry> |
|---|
| 111 | |
|---|
| 112 | <varlistentry> |
|---|
| 113 | <term><varname>MaximumDiffingTime</varname></term> |
|---|
| 114 | |
|---|
| 115 | <listitem> |
|---|
| 116 | <para>How much time should be spent on diffing files.</para> |
|---|
| 117 | </listitem> |
|---|
| 118 | </varlistentry> |
|---|
| 119 | |
|---|
| 120 | <varlistentry> |
|---|
| 121 | <term><varname>DeleteRedundantLocationsAfter</varname></term> |
|---|
| 122 | |
|---|
| 123 | <listitem> |
|---|
| 124 | <para></para> |
|---|
| 125 | </listitem> |
|---|
| 126 | </varlistentry> |
|---|
| 127 | |
|---|
| 128 | <varlistentry> |
|---|
| 129 | <term><varname>FileTrackingSizeThreshold</varname></term> |
|---|
| 130 | |
|---|
| 131 | <listitem> |
|---|
| 132 | <para></para> |
|---|
| 133 | </listitem> |
|---|
| 134 | </varlistentry> |
|---|
| 135 | |
|---|
| 136 | <varlistentry> |
|---|
| 137 | <term><varname>DiffingUploadSizeThreshold</varname></term> |
|---|
| 138 | |
|---|
| 139 | <listitem> |
|---|
| 140 | <para></para> |
|---|
| 141 | </listitem> |
|---|
| 142 | </varlistentry> |
|---|
| 143 | |
|---|
| 144 | <varlistentry> |
|---|
| 145 | <term><varname>StoreHostname</varname></term> |
|---|
| 146 | |
|---|
| 147 | <listitem> |
|---|
| 148 | <para>The hostname or IP address of the <citerefentry> |
|---|
| 149 | <refentrytitle>bbstored</refentrytitle> |
|---|
| 150 | |
|---|
| 151 | <manvolnum>8</manvolnum> |
|---|
| 152 | </citerefentry> server.</para> |
|---|
| 153 | </listitem> |
|---|
| 154 | </varlistentry> |
|---|
| 155 | |
|---|
| 156 | <varlistentry> |
|---|
| 157 | <term><varname>StorePort</varname></term> |
|---|
| 158 | |
|---|
| 159 | <listitem> |
|---|
| 160 | <para>The port used by the server. Defaults to 2201.</para> |
|---|
| 161 | </listitem> |
|---|
| 162 | </varlistentry> |
|---|
| 163 | |
|---|
| 164 | <varlistentry> |
|---|
| 165 | <term><varname>ExtendedLogging</varname></term> |
|---|
| 166 | |
|---|
| 167 | <listitem> |
|---|
| 168 | <para>Logs everything that happens between the client and server. |
|---|
| 169 | The <citerefentry> |
|---|
| 170 | <refentrytitle>bbackupd</refentrytitle> |
|---|
| 171 | |
|---|
| 172 | <manvolnum>8</manvolnum> |
|---|
| 173 | </citerefentry> client must also be started with |
|---|
| 174 | <option>-V</option>.</para> |
|---|
| 175 | </listitem> |
|---|
| 176 | </varlistentry> |
|---|
| 177 | |
|---|
| 178 | <varlistentry> |
|---|
| 179 | <term><varname>ExtendedLogFile</varname></term> |
|---|
| 180 | |
|---|
| 181 | <listitem> |
|---|
| 182 | <para></para> |
|---|
| 183 | </listitem> |
|---|
| 184 | </varlistentry> |
|---|
| 185 | |
|---|
| 186 | <varlistentry> |
|---|
| 187 | <term><varname>LogAllFileAccess</varname></term> |
|---|
| 188 | |
|---|
| 189 | <listitem> |
|---|
| 190 | <para></para> |
|---|
| 191 | </listitem> |
|---|
| 192 | </varlistentry> |
|---|
| 193 | |
|---|
| 194 | <varlistentry> |
|---|
| 195 | <term><varname>LogFile</varname></term> |
|---|
| 196 | |
|---|
| 197 | <listitem> |
|---|
| 198 | <para></para> |
|---|
| 199 | </listitem> |
|---|
| 200 | </varlistentry> |
|---|
| 201 | |
|---|
| 202 | <varlistentry> |
|---|
| 203 | <term><varname>LogFileLevel</varname></term> |
|---|
| 204 | |
|---|
| 205 | <listitem> |
|---|
| 206 | <para></para> |
|---|
| 207 | </listitem> |
|---|
| 208 | </varlistentry> |
|---|
| 209 | |
|---|
| 210 | <varlistentry> |
|---|
| 211 | <term><varname>CommandSocket</varname></term> |
|---|
| 212 | |
|---|
| 213 | <listitem> |
|---|
| 214 | <para>Where the command socket is created in the filesystem.</para> |
|---|
| 215 | </listitem> |
|---|
| 216 | </varlistentry> |
|---|
| 217 | |
|---|
| 218 | <varlistentry> |
|---|
| 219 | <term><varname>KeepAliveTime</varname></term> |
|---|
| 220 | |
|---|
| 221 | <listitem> |
|---|
| 222 | <para></para> |
|---|
| 223 | </listitem> |
|---|
| 224 | </varlistentry> |
|---|
| 225 | |
|---|
| 226 | <varlistentry> |
|---|
| 227 | <term><varname>StoreObjectInfoFile</varname></term> |
|---|
| 228 | |
|---|
| 229 | <listitem> |
|---|
| 230 | <para></para> |
|---|
| 231 | </listitem> |
|---|
| 232 | </varlistentry> |
|---|
| 233 | |
|---|
| 234 | <varlistentry> |
|---|
| 235 | <term><varname>NotifyScript</varname></term> |
|---|
| 236 | |
|---|
| 237 | <listitem> |
|---|
| 238 | <para>The location of the script which runs at certain events. This |
|---|
| 239 | script is generated by <citerefentry> |
|---|
| 240 | <refentrytitle>bbackupd-config</refentrytitle> |
|---|
| 241 | |
|---|
| 242 | <manvolnum>8</manvolnum> |
|---|
| 243 | </citerefentry>. Defaults to |
|---|
| 244 | <filename>/etc/box/bbackupd/NotifySysAdmin.sh</filename>.</para> |
|---|
| 245 | </listitem> |
|---|
| 246 | </varlistentry> |
|---|
| 247 | |
|---|
| 248 | <varlistentry> |
|---|
| 249 | <term><varname>NotifyAlways</varname></term> |
|---|
| 250 | |
|---|
| 251 | <listitem> |
|---|
| 252 | <para></para> |
|---|
| 253 | </listitem> |
|---|
| 254 | </varlistentry> |
|---|
| 255 | |
|---|
| 256 | <varlistentry> |
|---|
| 257 | <term><varname>CertificateFile</varname></term> |
|---|
| 258 | |
|---|
| 259 | <listitem> |
|---|
| 260 | <para>The path to the client's public certificate.</para> |
|---|
| 261 | </listitem> |
|---|
| 262 | </varlistentry> |
|---|
| 263 | |
|---|
| 264 | <varlistentry> |
|---|
| 265 | <term><varname>PrivateKeyFile</varname></term> |
|---|
| 266 | |
|---|
| 267 | <listitem> |
|---|
| 268 | <para>The path to the client's private key. This should only be |
|---|
| 269 | readable by root.</para> |
|---|
| 270 | </listitem> |
|---|
| 271 | </varlistentry> |
|---|
| 272 | |
|---|
| 273 | <varlistentry> |
|---|
| 274 | <term><varname>TrustedCAsFile</varname></term> |
|---|
| 275 | |
|---|
| 276 | <listitem> |
|---|
| 277 | <para>The Certificate Authority created by <citerefentry> |
|---|
| 278 | <refentrytitle>bbstored-certs</refentrytitle> |
|---|
| 279 | |
|---|
| 280 | <manvolnum>8</manvolnum> |
|---|
| 281 | </citerefentry>.</para> |
|---|
| 282 | </listitem> |
|---|
| 283 | </varlistentry> |
|---|
| 284 | |
|---|
| 285 | <varlistentry> |
|---|
| 286 | <term><varname>KeysFile</varname></term> |
|---|
| 287 | |
|---|
| 288 | <listitem> |
|---|
| 289 | <para>The data encryption key. This <emphasis |
|---|
| 290 | role="bold">must</emphasis> be kept safe at all costs, your data is |
|---|
| 291 | useless without it!</para> |
|---|
| 292 | </listitem> |
|---|
| 293 | </varlistentry> |
|---|
| 294 | |
|---|
| 295 | <varlistentry> |
|---|
| 296 | <term><varname>DataDirectory</varname></term> |
|---|
| 297 | |
|---|
| 298 | <listitem> |
|---|
| 299 | <para>A directory to keep temporary state files. This is usually |
|---|
| 300 | something like <filename>/var/bbackupd</filename>.</para> |
|---|
| 301 | </listitem> |
|---|
| 302 | </varlistentry> |
|---|
| 303 | |
|---|
| 304 | <varlistentry> |
|---|
| 305 | <term><varname>Server</varname></term> |
|---|
| 306 | |
|---|
| 307 | <listitem> |
|---|
| 308 | <para>This section relates to the running daemon.</para> |
|---|
| 309 | |
|---|
| 310 | <para><variablelist> |
|---|
| 311 | <varlistentry> |
|---|
| 312 | <term><varname>PidFile</varname></term> |
|---|
| 313 | |
|---|
| 314 | <listitem> |
|---|
| 315 | <para>The location of the process ID file. Defaults to |
|---|
| 316 | <filename>/var/run/bbackupd.pid</filename>.</para> |
|---|
| 317 | </listitem> |
|---|
| 318 | </varlistentry> |
|---|
| 319 | </variablelist></para> |
|---|
| 320 | </listitem> |
|---|
| 321 | </varlistentry> |
|---|
| 322 | |
|---|
| 323 | <varlistentry> |
|---|
| 324 | <term><varname>BackupLocations</varname></term> |
|---|
| 325 | |
|---|
| 326 | <listitem> |
|---|
| 327 | <para>This section defines each directory to be backed up. Each |
|---|
| 328 | entry must have at least a Path entry and, optionally, include and |
|---|
| 329 | exclude directives.</para> |
|---|
| 330 | |
|---|
| 331 | <para>Multiple include and exclude directives may appear.</para> |
|---|
| 332 | |
|---|
| 333 | <para><variablelist> |
|---|
| 334 | <varlistentry> |
|---|
| 335 | <term><varname>Path</varname></term> |
|---|
| 336 | |
|---|
| 337 | <listitem> |
|---|
| 338 | <para>The path to back up.</para> |
|---|
| 339 | </listitem> |
|---|
| 340 | </varlistentry> |
|---|
| 341 | |
|---|
| 342 | <varlistentry> |
|---|
| 343 | <term><varname>ExcludeFile</varname></term> |
|---|
| 344 | |
|---|
| 345 | <listitem> |
|---|
| 346 | <para>Exclude a single file.</para> |
|---|
| 347 | </listitem> |
|---|
| 348 | </varlistentry> |
|---|
| 349 | |
|---|
| 350 | <varlistentry> |
|---|
| 351 | <term><varname>ExcludeFilesRegex</varname></term> |
|---|
| 352 | |
|---|
| 353 | <listitem> |
|---|
| 354 | <para>Exclude multiple files based on a regular expression. |
|---|
| 355 | See <citerefentry> |
|---|
| 356 | <refentrytitle>re_format</refentrytitle> |
|---|
| 357 | |
|---|
| 358 | <manvolnum>7</manvolnum> |
|---|
| 359 | </citerefentry>.</para> |
|---|
| 360 | </listitem> |
|---|
| 361 | </varlistentry> |
|---|
| 362 | |
|---|
| 363 | <varlistentry> |
|---|
| 364 | <term><varname>ExcludeDir</varname></term> |
|---|
| 365 | |
|---|
| 366 | <listitem> |
|---|
| 367 | <para>Exclude a single directory.</para> |
|---|
| 368 | </listitem> |
|---|
| 369 | </varlistentry> |
|---|
| 370 | |
|---|
| 371 | <varlistentry> |
|---|
| 372 | <term><varname>ExcludeDirsRegex</varname></term> |
|---|
| 373 | |
|---|
| 374 | <listitem> |
|---|
| 375 | <para>Exclude multiple directories based on a regular |
|---|
| 376 | expression. See <citerefentry> |
|---|
| 377 | <refentrytitle>re_format</refentrytitle> |
|---|
| 378 | |
|---|
| 379 | <manvolnum>7</manvolnum> |
|---|
| 380 | </citerefentry>.</para> |
|---|
| 381 | </listitem> |
|---|
| 382 | </varlistentry> |
|---|
| 383 | |
|---|
| 384 | <varlistentry> |
|---|
| 385 | <term><varname>AlwaysIncludeFile</varname></term> |
|---|
| 386 | |
|---|
| 387 | <listitem> |
|---|
| 388 | <para>Include a single file from a directory which has been |
|---|
| 389 | excluded.</para> |
|---|
| 390 | </listitem> |
|---|
| 391 | </varlistentry> |
|---|
| 392 | |
|---|
| 393 | <varlistentry> |
|---|
| 394 | <term><varname>AlwaysIncludeFilesRegex</varname></term> |
|---|
| 395 | |
|---|
| 396 | <listitem> |
|---|
| 397 | <para>Include multiple files from an excluded directory, |
|---|
| 398 | based on a regular expression.</para> |
|---|
| 399 | </listitem> |
|---|
| 400 | </varlistentry> |
|---|
| 401 | |
|---|
| 402 | <varlistentry> |
|---|
| 403 | <term><varname>AlwaysIncludeDir</varname></term> |
|---|
| 404 | |
|---|
| 405 | <listitem> |
|---|
| 406 | <para>Include a single directory from a directory which has |
|---|
| 407 | been excluded.</para> |
|---|
| 408 | </listitem> |
|---|
| 409 | </varlistentry> |
|---|
| 410 | |
|---|
| 411 | <varlistentry> |
|---|
| 412 | <term><varname>AlwaysIncludeDirsRegex</varname></term> |
|---|
| 413 | |
|---|
| 414 | <listitem> |
|---|
| 415 | <para>Include multiple directories from an excluded |
|---|
| 416 | directory, based on a regular expression.</para> |
|---|
| 417 | </listitem> |
|---|
| 418 | </varlistentry> |
|---|
| 419 | </variablelist></para> |
|---|
| 420 | </listitem> |
|---|
| 421 | </varlistentry> |
|---|
| 422 | </variablelist> |
|---|
| 423 | </refsection> |
|---|
| 424 | |
|---|
| 425 | <refsection> |
|---|
| 426 | <title>Examples</title> |
|---|
| 427 | |
|---|
| 428 | <para>The following is an example of a backup location:</para> |
|---|
| 429 | |
|---|
| 430 | <programlisting>home |
|---|
| 431 | { |
|---|
| 432 | Path = /home |
|---|
| 433 | ExcludeDir = /home/guest |
|---|
| 434 | ExcludeDir = /home/[^/]+/tmp |
|---|
| 435 | ExcludeFilesRegex = .*\.(mp3|MP3)$ |
|---|
| 436 | AlwaysIncludeFile = /home/someuser/importantspeech.mp3 |
|---|
| 437 | }</programlisting> |
|---|
| 438 | </refsection> |
|---|
| 439 | |
|---|
| 440 | <refsection> |
|---|
| 441 | <title>Files</title> |
|---|
| 442 | |
|---|
| 443 | <para><filename>/etc/box/bbackupd.conf</filename></para> |
|---|
| 444 | </refsection> |
|---|
| 445 | |
|---|
| 446 | <refsection> |
|---|
| 447 | <title>See Also</title> |
|---|
| 448 | |
|---|
| 449 | <para><citerefentry> |
|---|
| 450 | <refentrytitle>bbackupd</refentrytitle> |
|---|
| 451 | |
|---|
| 452 | <manvolnum>8</manvolnum> |
|---|
| 453 | </citerefentry>, <citerefentry> |
|---|
| 454 | <refentrytitle>bbackupd-config</refentrytitle> |
|---|
| 455 | |
|---|
| 456 | <manvolnum>8</manvolnum> |
|---|
| 457 | </citerefentry>, <citerefentry> |
|---|
| 458 | <refentrytitle>bbackupctl</refentrytitle> |
|---|
| 459 | |
|---|
| 460 | <manvolnum>8</manvolnum> |
|---|
| 461 | </citerefentry></para> |
|---|
| 462 | </refsection> |
|---|
| 463 | |
|---|
| 464 | <refsection> |
|---|
| 465 | <title>Authors</title> |
|---|
| 466 | |
|---|
| 467 | <para><author> |
|---|
| 468 | <personname>Ben Summers</personname> |
|---|
| 469 | </author></para> |
|---|
| 470 | |
|---|
| 471 | <para><author> |
|---|
| 472 | <personname>Per Thomsen</personname> |
|---|
| 473 | </author></para> |
|---|
| 474 | |
|---|
| 475 | <para><author> |
|---|
| 476 | <personname>James O'Gorman</personname> |
|---|
| 477 | </author></para> |
|---|
| 478 | </refsection> |
|---|
| 479 | </refentry> |
|---|
