Skip to main content

Herald documentation

Herald watches local folders, notices when a release has finished arriving, and announces it in your hub's main chat. One process serves any number of hubs, each with its own connection, its own rules and its own announce history.

There are two front ends over one engine. The desktop app is where you set things up, and the headless runner is what you leave running on a server. Both read the same data/ folder, and the engine imports no Qt, so a server needs neither a desktop nor PySide6.

What your hub needs​

Herald announces by sending an ordinary chat command, +addrel by default, so the hub has to understand it. In practice that means ptx_freshstuff on luadch or luadch-ng. The command is configurable per rule, so another plugin works as long as it takes the same shape.

Beyond that:

  • A registered account. The announce command needs the rights that come with one.
  • TLS. Herald connects over adcs:// only and has no plaintext path. Pin the hub's keyprint; without a pin the log says so on every connect.

Where to go next​

  • Installation covers the Windows build, running from source, and the optional dependencies.
  • Running headless covers Docker and systemd, and the one setting that catches people out when the machine that configures is not the machine that runs.
  • Configuration is the field-by-field reference, kept in step with the Herald repository.