Fugu
Generic OpenBSD-style daemon utilities for Perl.
Fugu gives a Perl daemon the plumbing that OpenBSD daemons share: daemonize, privilege drop, signal handling, logging, process control, PID files, state files, and pledge(2)/unveil(2).
It adds an event loop, a caching HTTP proxy, SSH and MQTT clients, a native
mdnsd(8) control client, and signify(1) signature verification. The distribution
ships Protocol::Imsg, a sans-IO codec for the imsg(3) frame.
Fugu needs core Perl only (v5.36). Every CPAN module it can use is an optional feature, loaded lazily. OpenBSD is the production platform; Linux and Darwin serve development and CI.
Quick start
make deps-test
make check
doas make install
make install puts the modules and their .pod sidecars under the site_perl
tree. Or install the latest release tarball with cpanm:
cpanm --notest https://github.com/FuguBSD/Fugu/releases/latest/download/Fugu.tar.gz
See INSTALL.md for full instructions.
Documentation
The specification in spec/ states the design. Each module
documents its API in a .pod sidecar. Start with:
perldoc Fugu::Daemon— daemonize a processperldoc Fugu::Log— the unified loggerperldoc Fugu::EventLoop— one IO::Select loop for a single-process daemon
Commands
make check # lint + format + test + spec-coverage + spec-check + ste-lint + gitleaks
make test # prove -l over every test tier
prove -l t/fugu/foo.t # one test file
make format-fix # auto-fix the Perl, Markdown, JSON and YAML formatting
make dist # build the release tarball
make check runs the Markdown format gate, and prettier runs through bunx. The
operator installs bun, for example from Homebrew. The manifest does not provide
it, because the format gate needs bunx before a target can run.
make deps installs gitleaks, the tool of the secret gate. It installs the
tool environment before every other environment, so the gate tool is present
for each chain. deps/SHA256.txt records the sha256 digest of each versioned
download, and make deps compares the downloaded bytes against it. The CI gate
installs gitleaks with make deps, so one pin serves the operator gate and the
CI gate.
gitleaks publishes no OpenBSD build, and the ports tree holds no port for it. An operator on OpenBSD installs it by hand.
Releases
Push a v<MAJOR>.<MINOR>.<PATCH> tag, and the release workflow publishes the
tarball to GitHub Releases and to PAUSE. The rules are in
spec/release.md.
Commit scopes
control, file, imsg, keydir, lib, log, mdnsd, mqtt, openpgp,
privdrop, process, proxy, repl, signify, ssh, spec, deps, ci.
Use lib for a change that adds or reshapes more than one module. Use the
module scope for a change inside one module.
License
ISC. See LICENSE.