APPFEED.CGI(1)

🎀 appfeed.cgi(1) from the General Commands Manual 🎀

okay bestie, this is the manual page for appfeed.cgi(1) and it has MAIN CHARACTER energy 💅 let's get into it ✨

✨ NAME ✨

appfeed.cgi - Xymon CGI feeder for Smartphone apps 📱 it's the thing that hands Xymon status data over to phone apps 🦋

✨ SYNOPSIS ✨

appfeed.cgi [options]

that's the whole synopsis, just the one line, no cap 🙈

✨ DESCRIPTION ✨

okay so appfeed.cgi gets invoked as a CGI script through the appfeed.sh CGI wrapper 🧚

it can optionally take a QUERY_STRING environment variable with the filter=FILTER parameter in it. FILTER is a filter for the xymondboard command that gets sent to the xymond(8) daemon 💖 these filters are explained in full detail in the xymon(1) manual, so go check that if you want the deep dive 🤓 usually the filter picks out hosts on one specific (sub)page. for example, filter=page=webservers makes appfeed.cgi only return the hosts that show up on the "webservers" page in Xymon 🌸

if you don't give it a filter, appfeed.cgi returns data for all the red, yellow or purple statuses. that's the same stuff you'd see on the "All non-green" page 🔥 but if you run it with the --critical option, it gives you data from the "Critical systems" page instead ⭐

the output is an XML document with the current status of whichever hosts and services got selected 🫶

✨ OPTIONS ✨

• --env=FILENAME — loads the environment from FILENAME before the CGI runs 🌈
• --critical[=FILENAME] — FILENAME is the "Critical Systems" configuration file, and if you don't pick one it defaults to critical.cfg 🎀 appfeed.cgi will only return the statuses that are currently on the "Critical Systems" view 👑
• --access=FILENAME — on top of whatever filtering the filter parameter or the --critical option is doing, this one limits the output to only the hosts the user has access to. that access comes from the Apache-compatible group-definitions in FILENAME. see xymon-webaccess(5) for more on that 🦋

⚠️ bestie, read this part! using --access means access to the appfeed.cgi tool has to be password-protected by whatever your webserver software offers. the login userid also has to be available through the REMOTE_USER environment variable. the good news is this is standard CGI behaviour, so every webserver should provide it if you're using its built-in authentication 💀

✨ SEE ALSO ✨

xymon(1), critical.cfg(5), xymon-webaccess(5) 💜

and that's a wrap, bestie 🫶 this page is from Xymon version 4.3.30, dated 4 Sep 2019, so it's giving vintage charm 🍓 periodt ✨💅