bbackupd.conf — Box Backup client daemon configuration file
/etc/box/bbackupd.conf
AccountNumberThe account number of this client. This is set by the admin of the store server.
UpdateStoreIntervalSpecifies 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.
MinimumFileAgeSpecifies how long since a file was last modified before it will be uploaded. Defaults to 6 hours.
MaxUploadWaitIf a file is repeatedly modified it won't be uploaded immediately in case it's modified again. However it should be uploaded eventually. This is how long we should wait after first noticing a change. Defaults to 1 day.
MaxFileTimeInFutureAutomaticBackupSyncAllowScriptUse 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.
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's a number, then the script will be asked again in that number of seconds.
For example, you could use this on a laptop to only backup when on a specific network.
MaximumDiffingTimeHow much time should be spent on diffing files.
DeleteRedundantLocationsAfterFileTrackingSizeThresholdDiffingUploadSizeThresholdStoreHostnameThe hostname or IP address of the bbstored (8) server.
StorePortThe port used by the server. Defaults to 2201.
ExtendedLoggingLogs everything that happens between the client and server.
The
bbackupd
(8)
client must also be started with
-V.
ExtendedLogFileLogAllFileAccessLogFileLogFileLevelCommandSocketWhere the command socket is created in the filesystem.
KeepAliveTimeStoreObjectInfoFileNotifyScriptThe location of the script which runs at certain events. This
script is generated by
bbackupd-config
(8)
. Defaults to
/etc/box/bbackupd/NotifySysAdmin.sh.
NotifyAlwaysCertificateFileThe path to the client's public certificate.
PrivateKeyFileThe path to the client's private key. This should only be readable by root.
TrustedCAsFileThe Certificate Authority created by bbstored-certs (8) .
KeysFileThe data encryption key. This must be kept safe at all costs, your data is useless without it!
DataDirectoryA directory to keep temporary state files. This is usually
something like /var/bbackupd.
ServerThis section relates to the running daemon.
PidFileThe location of the process ID file. Defaults to
/var/run/bbackupd.pid.
BackupLocationsThis section defines each directory to be backed up. Each entry must have at least a Path entry and, optionally, include and exclude directives.
Multiple include and exclude directives may appear.
PathThe path to back up.
ExcludeFileExclude a single file.
ExcludeFilesRegexExclude multiple files based on a regular expression. See re_format (7) .
ExcludeDirExclude a single directory.
ExcludeDirsRegexExclude multiple directories based on a regular expression. See re_format (7) .
AlwaysIncludeFileInclude a single file from a directory which has been excluded.
AlwaysIncludeFilesRegexInclude multiple files from an excluded directory, based on a regular expression.
AlwaysIncludeDirInclude a single directory from a directory which has been excluded.
AlwaysIncludeDirsRegexInclude multiple directories from an excluded directory, based on a regular expression.