Pebble / Docs
Documentation
New here? Start with the user guide: short sections, a TL;DR at the top of each, and a clear “done when” at the end. The reference pages below go deeper.
Start
User guideThe friendly, step-by-step Pebble guide: install a FreeBSD router from scratch, change it safely, everyday recipes, WireGuard, diagnostics and the web interface.Overview & statusWhat Pebble is and is not, project status, supported hardware, installation, applying changes and the command reference.InstallationInstall Pebble on FreeBSD 15.1: requirements, pebble bootstrap, the installer, offline packages, upgrading and uninstalling.ConfigurationEvery setting in pebble.yaml explained: system, network, DHCP, DNS, firewall, WireGuard, management, monitoring and recovery.
Networking
Networking & firewallInterfaces, NAT, PF firewall rules, port forwards, downloaded IP lists, static routes and per-device Internet access in Pebble.DNS & filteringPebble's recursive DNSSEC-validating Unbound resolver, local records and zones, and DNS-based ad and malware blocking with bounded memory.WireGuardRouted WireGuard site-to-site tunnels on FreeBSD wg(4), and VPN provider exits with a kill switch for chosen devices.
Operating
Rollback & recoveryHow pebble apply works as a transaction: snapshots, generations, confirmation, automatic rollback and boot-time recovery.Web interfacePebble's optional web interface: enabling it, accounts and roles, review-then-apply, and its security model.Flight recorderPebble's network flight recorder, health checks, pebble explain outage and the pebble top terminal dashboard.TroubleshootingDiagnose and fix Pebble router problems: no Internet, DNS failures, DHCP, WireGuard, lock-outs and rollbacks.Migrating from OPNsenseMove from OPNsense to Pebble with pebble import opnsense: export, translate, review the migration report and cut over.
Internals
ArchitecturePebble's compile pipeline, packages, the files it owns, boot ordering and deterministic output.SecurityPebble's threat model, trust boundaries, privileges, engineering controls and known limitations.BenchmarksMeasured Pebble resource figures: web interface and agent memory, and Unbound local-zone vs RPZ blocklist performance.Roadmap & releasesPebble release notes and roadmap: what changed in 0.2.0 and 0.1.1, and what remains before a stable release.