Skip to content

First Run

The first run should establish three things: the registry location, the sidecar health state, and whether PortBay can safely route hostnames on this machine.

PortBay services and sidecar health

Expected State

AreaExpected result
RegistryCreated under ~/Library/Application Support/PortBay/registry.json when the first project is saved.
Runtime fileWritten under ~/Library/Application Support/PortBay/runtime.json once Process Compose and Caddy have live ports.
SidecarsProcess Compose and Caddy should report reachable once started.
HostnamesProject hostnames are routed through Caddy. Exact hostnames resolve via the privileged /etc/hosts helper; wildcard *.test resolution is handled by the bundled dnsmasq sidecar, which ships with PortBay and needs no separate install.

What To Check

  1. Launch PortBay (the installed app, or pnpm tauri dev from a source checkout).
  2. Open Settings and confirm the UI theme, density, and sidecar status controls render.
  3. Open the Services view and confirm sidecar rows are visible.
  4. Open Projects and confirm the empty state renders without errors.

Data Directory

PortBay stores user data in the platform application support directory. On macOS, the active paths are:

PathPurpose
~/Library/Application Support/PortBay/registry.jsonProject registry
~/Library/Application Support/PortBay/runtime.jsonLive sidecar port assignments
~/Library/Application Support/PortBay/certs/<project-id>/mkcert-issued project certificates
~/Library/Application Support/PortBay/logs/<project-id>.logProject logs
~/Library/Application Support/PortBay/process-compose.yamlGenerated Process Compose config
~/Library/Application Support/PortBay/caddy/autosave.jsonCaddy-managed autosave

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