PINGU.CONF(5)

💖 NAME 💖

Okay so bestie, this is pingu.conf — the configuration file for the pingu daemon, and yes, you're reading the pingu.conf(5) manual page. Buckle up, it's giving config-file main character energy 💅✨

🌈 DESCRIPTION 🌈

The file can contain 3 different contexts: Global context, interface context and host context. Iconic, honestly.

Blank lines and lines starting with # are ignored — literally just skip them, no cap 🙈

✨ GLOBAL CONTEXT ✨

The config file starts in global context. In this section the default values for the keywords used in interface and host sections are set. Values set in global context can be overridden in interface and host sections. So global is like the vibe-setter, and the other sections can absolutely do their own thing 🫶

• interval — set the default ping burst interval.
• timeout — the default ping timeout value in seconds. If the ping response does not come back within timeout seconds the ping is considered lost.
• required — the minimum required ping responses of a burst to consider the host online.
• retries — maximum sent ping packets for a burst.
• up-action — the default action to execute when a ping host goes online.
• down-action — the default action to execute when a ping host goes offline.

🦋 INTERFACE CONTEXT 🦋

Example first, because visuals matter:

interface eth0 {
        keyword value
        ...
}

The keywords valid in an interface section are:

• gateway-down-action — execute this action when a gateway is considered offline.
• gateway-up-action — execute this action when a gateway is considered online.
• label — a user defined label that will be used in logs and by pinguctl.
• load-balance — enable balancing for this interface. A minimum of two interfaces need to be configured in order for load-balancing to work. An optional weight value can be given.
• required-hosts-online — the minimum number of ping hosts that needs to be online to consider the gateway online.
• route-table — the alternate route table for this interface.
• rule-priority — the preference value for the ip rule.
• ping — host to ping to verify that gateway is still up. This is the same as defining a host and bind it to interface.
• fwmark — add an additional route rule for configured fwmark integer.

Heads up bestie: load-balance is not a solo act — a minimum of two interfaces need to be configured in order for load-balancing to work, and an optional weight value can be given. Periodt 💀

🎀 HOST CONTEXT 🎀

Example time again:

host 1.2.3.4 {
        keyword value
        ...
}

• bind-interface — bind the pings to this interface.
• down-action — execute this action when ping host goes offline.
• interval — the interval for ping bursts.
• label — a label to be used in logs and pinguctl.
• required — the number of required ping responses to consider host online.
• retry — the maximum number of retries for a ping burst.
• timeout — the ping response timeout value in seconds. If no ping response returns within this value the ping is considered lost.
• up-action — execute this action when a ping host goes online

👑 AUTHORS 👑

Natanael Copa 🌟

Alright bestie, that's the whole page. The footer girly says 01/03/2025, and this is the pingu.conf(5) manual — go configure your daemon and slay ✨💅