.\"     Title: bbackupd.conf
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 03/09/2024
.\"    Manual: Box Backup
.\"    Source: Box Backup 0.11
.\"
.TH "BBACKUPD\.CONF" "5" "03/09/2024" "Box Backup 0\.11" "Box Backup"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
bbackupd.conf - Box Backup client daemon configuration file
.SH "SYNOPSIS"
.HP 23
\fB/etc/box/bbackupd\.conf\fR
.SH "DESCRIPTION"
.PP
\fIAccountNumber\fR
.RS 4
The account number of this client\. This is set by the admin of the store server\.
.RE
.PP
\fIUpdateStoreInterval\fR
.RS 4
Specifies the interval between scanning of the local discs\. To avoid cycles of load on the server, this time is randomly adjusted by a small percentage as the daemon runs\. Defaults to 1 hour\.
.RE
.PP
\fIMinimumFileAge\fR
.RS 4
Specifies how long since a file was last modified before it will be uploaded\. Defaults to 6 hours\.
.RE
.PP
\fIMaxUploadWait\fR
.RS 4
If a file is repeatedly modified it won\(aqt be uploaded immediately in case it\(aqs modified again\. However it should be uploaded eventually\. This is how long we should wait after first noticing a change\. Defaults to 1 day\.
.RE
.PP
\fIMaxFileTimeInFuture\fR
.RS 4
.RE
.PP
\fIAutomaticBackup\fR
.RS 4
.RE
.PP
\fISyncAllowScript\fR
.RS 4
Use this to temporarily stop bbackupd from syncronising or connecting to the store\. This specifies a program or script script which is run just before each sync, and ideally the full path to the interpreter\. It will be run as the same user bbackupd is running as, usually root\.
.sp
The script prints either "now" or a number to STDOUT (and a terminating newline, no quotes)\. If the result was "now", then the sync will happen\. If it\(aqs a number, then the script will be asked again in that number of seconds\.
.sp
For example, you could use this on a laptop to only backup when on a specific network\.
.RE
.PP
\fIMaximumDiffingTime\fR
.RS 4
How much time should be spent on diffing files\.
.RE
.PP
\fIDeleteRedundantLocationsAfter\fR
.RS 4
.RE
.PP
\fIFileTrackingSizeThreshold\fR
.RS 4
.RE
.PP
\fIDiffingUploadSizeThreshold\fR
.RS 4
.RE
.PP
\fIStoreHostname\fR
.RS 4
The hostname or IP address of the
\fBbbstored\fR(8)
server\.
.RE
.PP
\fIStorePort\fR
.RS 4
The port used by the server\. Defaults to 2201\.
.RE
.PP
\fIExtendedLogging\fR
.RS 4
Logs everything that happens between the client and server\. The
\fBbbackupd\fR(8)
client must also be started with
\fB\-V\fR\.
.RE
.PP
\fIExtendedLogFile\fR
.RS 4
.RE
.PP
\fILogAllFileAccess\fR
.RS 4
.RE
.PP
\fILogFile\fR
.RS 4
.RE
.PP
\fILogFileLevel\fR
.RS 4
.RE
.PP
\fICommandSocket\fR
.RS 4
Where the command socket is created in the filesystem\.
.RE
.PP
\fIKeepAliveTime\fR
.RS 4
.RE
.PP
\fIStoreObjectInfoFile\fR
.RS 4
.RE
.PP
\fINotifyScript\fR
.RS 4
The location of the script which runs at certain events\. This script is generated by
\fBbbackupd-config\fR(8)\. Defaults to
\fI/etc/box/bbackupd/NotifySysAdmin\.sh\fR\.
.RE
.PP
\fINotifyAlways\fR
.RS 4
.RE
.PP
\fICertificateFile\fR
.RS 4
The path to the client\(aqs public certificate\.
.RE
.PP
\fIPrivateKeyFile\fR
.RS 4
The path to the client\(aqs private key\. This should only be readable by root\.
.RE
.PP
\fITrustedCAsFile\fR
.RS 4
The Certificate Authority created by
\fBbbstored-certs\fR(8)\.
.RE
.PP
\fIKeysFile\fR
.RS 4
The data encryption key\. This
\fBmust\fR
be kept safe at all costs, your data is useless without it!
.RE
.PP
\fIDataDirectory\fR
.RS 4
A directory to keep temporary state files\. This is usually something like
\fI/var/bbackupd\fR\.
.RE
.PP
\fIServer\fR
.RS 4
This section relates to the running daemon\.
.PP
\fIPidFile\fR
.RS 4
The location of the process ID file\. Defaults to
\fI/var/run/bbackupd\.pid\fR\.
.RE
.RE
.PP
\fIBackupLocations\fR
.RS 4
This section defines each directory to be backed up\. Each entry must have at least a Path entry and, optionally, include and exclude directives\.
.sp
Multiple include and exclude directives may appear\.
.PP
\fIPath\fR
.RS 4
The path to back up\.
.RE
.PP
\fIExcludeFile\fR
.RS 4
Exclude a single file\.
.RE
.PP
\fIExcludeFilesRegex\fR
.RS 4
Exclude multiple files based on a regular expression\. See
\fBre_format\fR(7)\.
.RE
.PP
\fIExcludeDir\fR
.RS 4
Exclude a single directory\.
.RE
.PP
\fIExcludeDirsRegex\fR
.RS 4
Exclude multiple directories based on a regular expression\. See
\fBre_format\fR(7)\.
.RE
.PP
\fIAlwaysIncludeFile\fR
.RS 4
Include a single file from a directory which has been excluded\.
.RE
.PP
\fIAlwaysIncludeFilesRegex\fR
.RS 4
Include multiple files from an excluded directory, based on a regular expression\.
.RE
.PP
\fIAlwaysIncludeDir\fR
.RS 4
Include a single directory from a directory which has been excluded\.
.RE
.PP
\fIAlwaysIncludeDirsRegex\fR
.RS 4
Include multiple directories from an excluded directory, based on a regular expression\.
.RE
.RE
.SH "EXAMPLES"
.PP
The following is an example of a backup location:
.sp
.RS 4
.nf
home
{
   Path = /home
   ExcludeDir = /home/guest
   ExcludeDir = /home/[^/]+/tmp
   ExcludeFilesRegex = \.*\e\.(mp3|MP3)$
   AlwaysIncludeFile = /home/someuser/importantspeech\.mp3
}
.fi
.RE
.SH "FILES"
.PP
\fI/etc/box/bbackupd\.conf\fR
.SH "SEE ALSO"
.PP
\fBbbackupd\fR(8),
\fBbbackupd-config\fR(8),
\fBbbackupctl\fR(8)
.SH "AUTHORS"
.PP
Ben Summers
.PP
Per Thomsen
.PP
James O\(aqGorman