Skip to content

Guides

These guides cover day-to-day operations once PortBay is installed.

GuideUse it when
Overview DashboardYou want one place that answers "what have my agents been doing?" across every project.
WorkflowsYou want to automate something — agents, browsers, databases, connectors — as a graph you can run, schedule, or trigger from a webhook.
Multi-Device SyncYou use PortBay on more than one Mac and want the same projects, boards and workflows on both.
Screen CaptureYou want area/window/scrolling/GIF captures, a searchable capture library, and captures that feed cards and workflows.
Session RecordingsYou want a sanitized, replayable record of what was run on a remote host.
Networking & DNSA hostname won't resolve, dnsmasq or the hosts helper needs explaining, or you're diagnosing DNS under a VPN.
CertificatesThe local CA, per-project HTTPS, or a custom certificate needs explaining or troubleshooting.
DomainsYou want per-project routing knobs — path prefix, resolver mode, wildcard subdomains, expose-when-running.
Caddy and HTTPSA hostname does not route, certificates fail, or Caddy is out of sync.
PHP SetupA Laravel, WordPress, or plain PHP project needs PHP-FPM.
Custom Domain SuffixYou want hostnames under a suffix other than .test.
ServicesYou want to see or control every bundled sidecar (Process Compose, Caddy, dnsmasq, Mailpit, …) in one place.
IntegrationsYou want to curate your sidebar, launch a local editor/terminal, or connect an external tool (GitHub, Linear, Sentry, …).
Environment VariablesA project needs runtime variables or shared templates.
Project GroupsMultiple projects should start, stop, or restart together.
SSH TunnelsYou need to forward a remote database, VPS/cPanel host, cloud VM, bastion-only service, or ML cluster dashboard onto localhost.
Local AI (Ollama)You want local models running — for dictation, agents, or your own tools — without managing an Ollama server by hand.
Speech-to-TextYou'd rather speak a task card, commit message, or prompt than type it — and get clean text, on-device.
Text-to-SpeechYou want to hear text spoken in a natural voice, synthesized on-device.
Image GenerationYou want to generate images from a prompt on your Mac — a diffusion model or Apple Image Playground.
DumpsYou want a universal dump()/dd() viewer instead of an in-page dump.
CLI UsageYou want terminal parity with the app.
Was this helpful?
Feedback

PortBay is pre-MVP software. Use the docs as an operating guide, not a stability guarantee.