BACKUPNINJA.CONF(5)

💖 BACKUPNINJA.CONF — the general config file, bestie 💖

okay so you're here for backupninja.conf(5), the manual page for the config file of backupninja. pull up a chair, grab a strawberry 🍓, we're doing this.

---

✨ NAME ✨

BACKUPNINJA.CONF — the configuration file(s) for backupninja(1). yep that's the whole vibe. it's the conf, it's for backupninja, it's iconic. 👑

---

🌸 SYNOPSIS 🌸

/etc/backupninja.conf

that's the spot. that's where the main character lives. 🏠

---

🦋 DESCRIPTION 🦋

backupninja.conf is the general configuration file. this is where you set the log level and change the default directory locations. it's giving control room energy, fr fr.

and bestie, if you wanna be ✨different✨, you can force a totally different general config file with backupninja -f /path/to/conf. live your truth. 💅

---

💅 OPTIONS 💅

one bullet per option, no skipping, no summarising, we don't do that here:

• loglevel — how verbose the logs get to be. pick your fighter:
  • 5 = Debugging messages
  • 4 = Informational messages
  • 3 = Warnings
  • 2 = Errors
  • 1 = Fatal errors
• reportprom — produce prometheus metrics of backup status. heads up bestie, this one requires prometheus-node-exporter to be installed — no exporter, no metrics, no cap. 📊
• reportemail — send a summary of the backup status to this email address. slide into the inbox. 📧
• reportsuccess — if set to 'yes', a report email gets generated even if all modules reported success. yes, even when everything went fine. she's thorough like that.
• reportinfo — if set to 'yes', info messages from handlers get sent into the email. more tea in the inbox, if that's your thing. 🫖
• reportwarning — if set to 'yes', a report email gets generated even if there was no error. yes, an email for nothing going wrong. obsessed.
• reportspace — if set to 'yes', disk space usage gets included in the backup email report. so you always know how full the closet is. 👛
• reporthost — where to rsync the backupninja.log to be aggregated in a ninjareport. ninjareport. say it with me. ninjareport. 🥷
• reportuser — what user to connect to reporthost to sync the backupninja.log. who's logging in? it's this user.
• reportdirectory — where on the reporthost the report should go. drop it off right there. 📦
• reportwrap — number of columns the email report body should wrap to. aesthetics matter. 📐
• logfile — the path of the logfile. where the receipts live. 🧾
• configdirectory — the directory where all the backup action configuration files live. all of them. the whole squad.
• admingroup — the administration user group that is allowed to read/write configuration files in configdirectory. gatekeeping, but legally. 🚪
• scriptdirectory — where backupninja handler scripts are found. that's where the workers hang out.
• usecolors — if set to 'yes', use colors in the log file and debug output. 🌈 yes please obviously
• when — when to process each configuration file. the value used here gets applied to each configuration file. and yes, you can override this "when" in each individual configuration file — see also the "Scheduling" section in backup.d(5). 📅

for example:

when = sundays at 02:00
when = 30th at 22
when = 30 at 22:00
when = everyday at 01            <-- the default
when = Tuesday at 05:00

these values for 'when' are equivalent:

when = tuesday at 05:30
when = TUESDAYS at 05

and these values for 'when' are invalid — do not do this, i'm begging:

when = tuesday at 2am
when = tuesday at 2
when = tues at 02

---

🎀 DEFAULTS 🎀

the out-of-the-box fits, bestie. this is what you get if you change nothing:

loglevel = 4
reportemail = root
reportsuccess = yes
reportinfo = no
reportspace = no
reporthost =
reportuser = ninja
reportdirectory = /var/lib/backupninja/reports
reportwrap = 1000
logfile = /var/log/backupninja.log
configdirectory = /etc/backup.d
admingroup = root
scriptdirectory = /usr/share/backupninja
usecolors = yes
when = everyday at 01:00

look at that. reporthost is just vibes and empty space. reportuser = ninja. iykyk. 🥷✨

---

👀 SEE ALSO 👀

• backupninja(1)
• ninjahelper(1)
• backup.d(5)

go read them. they're the extended universe. 📚

---

💜 AUTHOR 💜

BACKUPNINJA was written by the riseup.net collective. absolute legends, we love them, no notes. 🫶

---

and that's a wrap on the backupninja package version of this page, dated November 19, 2005, brought to you by riseup. stan the riseup collective, go back up your stuff, and remember: the default is everyday at 01:00 so set an alarm or something. 💖✨🎀🦋🌸💅🫶