BBACKUPD.CONF(5)

🎀 BBACKUPD.CONF 💅

okay bestie, gather round, because this is the config file for the Box Backup client daemon and honestly? it's giving "the blueprint of your whole backup life". every single knob in here matters, so let's go ✨

---

🌸 NAME 🌸

bbackupd.conf — the configuration file for the Box Backup client daemon. yes ma'am, this is the file. 💖

---

🦋 SYNOPSIS 🦋

/etc/box/bbackupd.conf

that's it. that's the whole vibe. one path. iconic. 👑

---

✨ DESCRIPTION ✨

okay so here's every single setting you can put in this file. no skipping, no skimming, we're doing all of them. periodt. 💜

• AccountNumber — the account number of this client. your store server admin is the one who sets this for you, so don't be out here inventing your own, bestie.
• UpdateStoreInterval — how long between scans of your local discs. and listen, to avoid cycles of load on the server, this time gets randomly adjusted by a small percentage as the daemon runs. defaults to 1 hour. so organized fr fr.
• MinimumFileAge — how long a file has to sit there since it was last modified before it gets uploaded. defaults to 6 hours. let it marinate 🍓
• MaxUploadWait — so if a file keeps getting modified, it won't be uploaded immediately, in case it gets modified again. but like… it should get uploaded eventually, right? so this is how long we wait after first noticing a change. defaults to 1 day.
• MaxFileTimeInFuture — (no description given in the original page, it's just out here being mysterious 🙈)
• AutomaticBackup — (also no description in the original, lowkey a ghost 👻)
• SyncAllowScript — use this to temporarily stop bbackupd from syncronising or connecting to the store. it specifies a program or 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. main character laptop energy 💻✨

• MaximumDiffingTime — how much time should be spent on diffing files. that's it, that's the whole sentence.
• DeleteRedundantLocationsAfter — (no description in the original, we simply don't know 🌫️)
• FileTrackingSizeThreshold — (no description, but the name is doing a lot of heavy lifting 💀)
• DiffingUploadSizeThreshold — (also undescribed in the original 🫶)
• StoreHostname — the hostname or IP address of the bbstored(8) server. where your stuff goes. 🏠
• StorePort — the port used by the server. defaults to 2201.
• ExtendedLogging — logs everything that happens between the client and server. and heads up, the bbackupd(8) client must also be started with -V. both things. not one, not the other, both.
• ExtendedLogFile — (no description given in the original 🙈)
• LogAllFileAccess — (no description given, just vibes)
• LogFile — (no description given in the original 🌸)
• LogFileLevel — (no description given either, the mystery continues)
• CommandSocket — where the command socket is created in the filesystem.
• KeepAliveTime — (no description in the original, alas 😭)
• StoreObjectInfoFile — (no description in the original)
• NotifyScript — the location of the script which runs at certain events. this script is generated by bbackupd-config(8). defaults to /etc/box/bbackupd/NotifySysAdmin.sh.
• NotifyAlways — (no description given in the original 🦋)
• CertificateFile — the path to the client's public certificate.
• PrivateKeyFile — the path to the client's private key. > this one should only be readable by root. seriously. lock it down. 🔒
• TrustedCAsFile — the Certificate Authority created by bbstored-certs(8).
• KeysFile — the data encryption key. > this must be kept safe at all costs, your data is useless without it! like, actually useless. no cap. 😭
• DataDirectory — a directory to keep temporary state files. this is usually something like /var/bbackupd.
• Server — this section relates to the running daemon.

🌈 Server

• PidFile — the location of the process ID file. defaults to /var/run/bbackupd.pid.

• BackupLocations — this 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. stack 'em up, bestie. 💅

💖 BackupLocations

• Path — the path to back up.
• ExcludeFile — exclude a single file.
• ExcludeFilesRegex — exclude multiple files based on a regular expression. see re_format(7).
• ExcludeDir — exclude a single directory.
• ExcludeDirsRegex — exclude multiple directories based on a regular expression. see re_format(7).
• AlwaysIncludeFile — include a single file from a directory which has been excluded.
• AlwaysIncludeFilesRegex — include multiple files from an excluded directory, based on a regular expression.
• AlwaysIncludeDir — include a single directory from a directory which has been excluded.
• AlwaysIncludeDirsRegex — include multiple directories from an excluded directory, based on a regular expression.

---

🔥 EXAMPLES 🔥

the following is an example of a backup location:

home
{
   Path = /home
   ExcludeDir = /home/guest
   ExcludeDir = /home/[^/]+/tmp
   ExcludeFilesRegex = .*\.(mp3|MP3)$
   AlwaysIncludeFile = /home/someuser/importantspeech.mp3
}

see how it excludes the mp3s but always keeps the important speech? that's the energy. protecting what matters while skipping the noise. ✨🎧

---

🧚 FILES 🧚

/etc/box/bbackupd.conf

---

👑 SEE ALSO 👑

bbackupd(8), bbackupd-config(8), bbackupctl(8)

go read those too, iykyk 🫶

---

💜 AUTHORS 💜

• Ben Summers
• Per Thomsen
• James O'Gorman

absolute legends, all three of them. thank you for your service. 🌟

---

and that's the whole page bestie!! this was Box Backup 0.11, dated 06/06/2024 — go forth and configure your backups responsibly 💖✨🎀