RAIDFILE-CONFIG(8)

📦
version 0.13~~git20231028.g3dd5194 · 7 versions
, in debian trixie, ubuntu questing

🎀 RAIDFILE-CONFIG(8) — the raidfile-config page, bestie edition 🎀

okay so you found the manual page for raidfile-config from the Box Backup suite (that's the 8 section, aka admin/system commands, iykyk). Sit down, grab a strawberry 🍓, and let's get you set up.

✨ NAME ✨

raidfile-config</purl> — configure Box Backup's RAID files 💅

✨ SYNOPSIS ✨

raidfile-config config-dir blocksize dir1 [dir2 [dir3]]

that's the whole vibe. Three required things, two optional ones, and she's off. 🦋

✨ DESCRIPTION ✨

So basically raidfile-config creates a raidfile.conf file for Box Backup. Iconic, honestly. That file is where all the info about the directories used to store backups lives.

Box Backup supports userland RAID, in a restricted RAID5 configuration, where 3 and only 3 'drives' are supported. No more, no less, that's the limit, periodt. If you wanna read more about RAID5 (and other RAID levels), there's a link down in the NOTES, bestie. 📚

🌸 Parameters 🌸

Here's the rundown of every parameter, one by one, no skipping:

  • config-dir — the directory path where configuration files are located. Usually this is /etc/box. The raidfile.conf file will be written in this directory. 🏠
  • blocksize — the block size used for file storage in the system, in bytes. Using a multiple of the file system block size is a good strategy. Depending on the size of the files you will be backing up, this multiple varies. And of course 💁 it also depends on the native block size of your file system.
  • dir1 — the first directory in the built-in RAID array. 📁
  • dir2 — the second directory in the built-in RAID array. If you are not using the built-in RAID functionality, this field should be ignored. You should not use the built-in RAID if you have a hardware RAID solution, or if you're using another type of software RAID (like md on Linux). Pick a lane, bestie.
  • dir3 — the third directory in the built-in RAID array. The same notes that apply to dir2 also apply to dir3. 🫶
⚠️ Heads up: there is currently no way to add multiple disk sets to the raidfile.conf file using command line tools, etc. If you wanna know how to add more disks, go read raidfile.conf(5). The lore is in there.

💀 BUGS 💀

If you find a bug in Box Backup, and you want to let the devs know about it, join the mailing list (link in the NOTES, bestie ✨) and send a description of the problem there.

To report a bug, give them at least the following information — don't make them guess, that's not the vibe:

  • The version of Box Backup you are running
  • The platform you are running on (hardware and OS), for both client and server
  • If possible, attach your config files (bbstored.conf, bbackupd.conf) to the bug report
  • Also attach any log file output that helps shed light on the problem you are seeing
  • And last but certainly not least, a description of what you are seeing, in as much detail as possible 🙈
fr fr, the more detail the better. Devs love a well-fed bug report. 🐛💖

📁 FILES 📁

raidfile-config generates the raidfile.conf(5) file. That's the whole point of her. ✨

🌈 SEE ALSO 🌈

👑 AUTHORS 👑

Shoutout to the legends who made this happen:

  • Ben Summers
  • Per Thomsen
  • James O'Gorman

absolute icons, all three of them 🎀

⭐ NOTES ⭐

  1. here — http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5
  2. mailing list — http://lists.warhead.org.uk/mailman/listinfo/boxbackup

and that's the page, bestie!! 💖 This was Box Backup 0.11, dated 06/06/2024 — RAIDFILE-CONFIG(8), that's the girl. Go configure your RAID, slay, and remember: three drives. Only three. 🦋✨💅

📦 where this page comes from