matrix.conf(5)

💖 matrix.conf — the config file for matrix.pl (matrix.conf(5)) 💖

okay bestie, gather round, because this is the File Formats Manual page for matrix.conf and it's genuinely so cute. it's the little setup file that feeds matrix.pl when you wanna slap an html frontend onto dbeacon's dumped xml file. and the way it works? every configuration variable is literally just a perl variable, used to dynamically modify the behavior of matrix.pl. no cap. 🦋

✨ NAME ✨

matrix.conf — matrix.pl configuration file 🎀

🌸 DESCRIPTION 🌸

matrix.conf is the setup configuration file for matrix.pl if you want to add an html frontend to dbeacon's dumped xml file. 💅

Configuration variables are perl variables, used to dynamically modify the behavior of matrix.pl. periodt. ✨

👑 CONFIGURATION VARIABLES 👑

every single one of them, bestie, no skipping, we're eating the whole plate 🍓

• $dumpfile = string; — Required variable. it's the path to dbeacon's xml dump file. you literally cannot skip this one, it's the main character. 💀
• $historydir = string; — this is where the history round robin database (rrd) will be stored. be sure to have enough place to store it — it's about 30Mb per tuple (source/destination). so like, clear some space first bestie 🙈
• $verbose = integer; — set it to 1 if you want a verbose output of the xml file parsing. it's giving "tell me everything" energy. 🔥
• $title = string; — the title of the generated html page. it can be anything, as long as it respects the html syntax. go feral, but stay valid. ✨
• $page_title = string; — the page title of the generated html page, that is the title which appears in the titlebar of your browser. yes, the little tab text. iconic. 🎀
• $default_hideinfo = integer; — whether you want or not to display the IPv4/IPv6 source info on the web page by default. your call, bestie. 🦋
• $default_what = string; — the default matrix view on the html page. different view are 'asmorssm'. 👑
• $history_enabled = integer; — whether you want or not to enable rrd history logging. heads up though: this option requires the RRDs perl module (lib-perl-rrds) in Debian. no module, no history, iykyk. 😭
• $css_file = string; — specify a CSS file to be used instead of the embedded default. glow-up unlocked 💅
• $dump_update_delay = integer; — the delay between each dbeacon xml dump. this is used to detect out of date data. stay fresh or get caught. ⭐
• $flag_url_format = string; — a format that specifies the base URL to be used for displaying flags. 🌈
• $default_ssm_group = string; — the default SSM joining channel used by dbeacon. 🫶
• $debug = integer; — used for debugging. that's it, that's the whole vibe. 🔍
• $matrix_link_title = integer; — displays a tooltip for each matrix cell that shows the current row/column crossing. heads up: this option is only available when $history_enabled is 1. 🔥
• $default_full_matrix = integer; — whether you want to have a condensed or a full view of the matrix by default. pick your fighter. 💜
• $faq_page = string; — the base URL for the Frequently Asked Questions page. so people can, y'know, read before they ask. 💖

💀 BUGS 💀

should be reported to the core developer Hugo Santos <hugo@fivebits.net>. don't be shy, that's literally what the address is for. 🙈

🌟 HISTORY 🌟

matrix.conf is the configuration file from matrix.pl and is a joint work of Hugo Santos, Sebastien Chaumontet and Mickael Hoerdt. 🫶

it has been done in the early days of the m6bone, when nobody knew if the SPTs or RPTs were being used between hosts — and also to evaluate the performance and deployment of SSM. literal lore, ngl. 📜✨

and that's the whole page, bestie — straight out of the User Manuals section of matrix.conf(5). go forth and configure responsibly, mwah 💋💖