Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

herald

Git SSH hosting with email notifications. Provides a git push interface over SSH and sends email via SMTP/DKIM.

Domain: herald.dunkirk.sh · SSH Port: 2223 · HTTP Port: 8085

This is a custom module — it does not use mkService.

Options

OptionTypeDefaultDescription
enableboolfalseEnable herald
domainstringDomain for Caddy reverse proxy
hoststring"0.0.0.0"Listen address
sshPortport2223SSH listen port
externalSshPortport2223External SSH port (if behind NAT)
httpPortport8085HTTP API port
dataDirpath"/var/lib/herald"Data directory
allowAllKeysbooltrueAllow all SSH keys
secretsFilepathAgenix secrets (must contain SMTP_PASS)
packagepackagepkgs.heraldHerald package

SMTP

OptionTypeDefaultDescription
smtp.hoststringSMTP server hostname
smtp.portport587SMTP server port
smtp.userstringSMTP username
smtp.fromstringSender address

DKIM

OptionTypeDefaultDescription
smtp.dkim.selectorstring or nullnullDKIM selector
smtp.dkim.domainstring or nullnullDKIM signing domain
smtp.dkim.privateKeyFilepath or nullnullPath to DKIM private key