MODULEPROPAGATIONMONITOR.CONF(5)

๐Ÿ“ฆ
version 26.05.1 ยท 2 versions
, in alpine 3.24, debian trixie, fedora 43, fedora 44, ubuntu questing, ubuntu resolute, ubuntu stonking

๐Ÿ’– MODULEPROPAGATIONMONITOR.CONF โ€” the manual, but make it make sense ๐Ÿ’–

okay bestie, this is ModulePropagationMonitor.conf(5) from the File Formats section of the manual, and it's literally the config file for the SvxLink server's PropagationMonitor module. yes it's a mouthful. no we're not renaming it. let's go ๐Ÿฆ‹


โœจ NAME โœจ

ModulePropagationMonitor.conf โ€” it's the configuration file for the SvxLink server PropagationMonitor module. that's it, that's the name, slay ๐Ÿ’…


๐ŸŒธ DESCRIPTION ๐ŸŒธ

svxlink is a general purpose voice service system for ham radio use. iconic behavior honestly. and this man-page? it describes the SvxLink server configuration for the PropagationMonitor module.

so what does PropagationMonitor actually do? it announces propagation alerts that come in from vhfdx.info or gooddx.net. ๐Ÿ‘‘

โš ๏ธ big important thing: the whole process of receiving those emails is outside of this module. it is not this module's job. you have to arrange that separately, yourself, no cap.

here's the deal โ€” this module expects to find new emails under the spool directory. and the vibes have to be specific:

  • messages from VHFDX go in a vhfdx subdirectory
  • messages from GoodDX go in a dxrobot subdirectory

and listen โ€” this module must have write access to the subdirectories under the spool directory, because it moves processed messages into an archive directory. so if you don't give it write permission it's just gonna sit there like ๐Ÿ™ˆ and not do its job. give the girl her permissions. periodt.


๐ŸŽ€ CONFIGURATION VARIABLES ๐ŸŽ€

there are a couple of configuration variables that are common to all modules โ€” the docs for those live over in the svxlink.conf(5) manual page, go check her out.

and here's the full rundown of all the module specific configuration variables that the SvxLink PropagationMonitor module understands. every single one. we don't skip. ๐Ÿ’–

๐ŸŒˆ ModulePropagationMonitor

  • SPOOL_DIR โ€” tell it which directory to read incoming emails from. the default is /var/spool/svxlink/propagation_monitor. that's the one it'll use if you don't say otherwise, bestie.

๐Ÿ’Œ RECEIVING THE ALERT EMAILS ๐Ÿ’Œ

okay so setting up the flow of alert emails is a whole little journey and step one is: actually get those emails to the computer running SvxLink, and on that computer, to the user that SvxLink runs as. and there are two ways to do it, pick your fighter:

  1. forward emails directly via SMTP to the computer โ€” this one's for you if you have that possibility. fancy. ๐Ÿ’…
  2. fetch alert emails using POP from some email account โ€” this is propably the more common case (their spelling, not mine, love that for them). you can do this with the fetchmail(1) utility, for example.

step two: store those incoming emails in files under the propagation monitor spool directory. this is done using the procmail(1) utility. here's how it works โ€” when an incoming email arrives, the mail server calls procmail, which goes looking for a configuration file in the destination user's home directory.

for SvxLink, that home directory should be set to /etc/svxlink. and in that directory a procmail configuration file, .procmailrc, is installed by default. โœจ the syntax is a bit cryptic ngl, but the file has some helpful comments in it to help you understand what's going on. for more details go read the procmailrc(5) and procmailex(5) manual pages.

step three: and of course, obviously, you need to actually register with the vhfdx.info and/or gooddx.net site, and set up what geographic area and which bands you want to receive alert emails for. no registration, no emails, no alerts. the math is mathing. ๐Ÿงฎ


๐Ÿ›ก๏ธ SELINUX ๐Ÿ›ก๏ธ

some Linux distributions have the SELinux security framework enabled. this is true for RedHat based distributions, like Fedora for example.

and here's the thing โ€” SELinux will by default deny procmail to write the mail files in the propagation monitor spool directory. ๐Ÿ’€ so to fix this, run the following commands:

semanage fcontext -a -t user_home_t \
         "/var/spool/svxlink/propagation_monitor(/.*)?"
restorecon -r /var/spool/svxlink/propagation_monitor

and that's the fix, you're welcome, go touch grass ๐ŸŒฑ


๐Ÿ“ FILES ๐Ÿ“

  • /etc/svxlink/svxlink.conf (or deprecated /etc/svxlink.conf) โ€” the system wide configuration file.
  • ~/.svxlink/svxlink.conf โ€” per user configuration file.
  • /etc/svxlink/svxlink.d/ModulePropagationMonitor.conf โ€” global modularized configuration file. depends on the CFG_DIR configuration variable setting.
  • ~/.svxlink/svxlink.d/ModulePropagationMonitor.conf โ€” per user modularized configuration file. depends on the CFG_DIR configuration variable setting.
  • /var/spool/svxlink/propagation_monitor โ€” spool directory for alert mails. this is the default path. what path is actually used is determined by the SPOOL_DIR configuration variable.
  • /etc/svxlink/.procmailrc โ€” the configuration file for procmail. procmail is used to write incoming alert emails into files in the spool directory.

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

Tobias Blomberg (SM0SVX) <sm0svx at svxlink dot org>


๐Ÿ› REPORTING BUGS ๐Ÿ›

found a bug? bestie, report it using the issue tracker at: https://github.com/sm0svx/svxlink

๐Ÿ™…โ€โ™€๏ธ but listen โ€” questions about SvxLink should NOT be asked using the issue tracker. that's not what it's for, don't do it, i'm begging. instead use the group set up for this purpose at groups.io: https://groups.io/g/svxlink

๐Ÿ”— SEE ALSO ๐Ÿ”—

svxlink.conf(5), procmail(1), procmailrc(5), procmailex(5), fetchmail(1)


and that's the whole page, bestie ๐Ÿซถ this one came from the Linux manual, APRIL 2021 edition, filed under MODULEPROPAGATIONMONITOR.CONF(5). go set up your propagation alerts and live your main character ham radio era ๐ŸŒˆโœจ๐Ÿ’œ