Skip to main content
Overlay is a private workspace for models, knowledge, tools, and agents. These docs cover the web app / Overlay Server, Overlay Desktop on macOS, and self-hosting.

Web / server source

Next.js app, APIs, and self-hosting surface.

Overlay Desktop source

macOS Apple Silicon client (public source; signed downloads after Gate B).

Desktop download

Official macOS builds when Gate B is open.

Desktop docs

Install, permissions, security model, and troubleshooting.

​
Scope

Web / server
  • Next.js app under src/app
  • /api/v1 contracts and server orchestration
  • Convex / Postgres workflows that affect the product
  • Self-hosting and operations
Desktop
  • Electron macOS client (Apple Silicon)
  • Local vs cloud data flows and chat permissions
  • Build-from-source and (after Gate B) signed releases
Excluded
  • Mobile and Chrome extension deep internals
  • Internal audit reports and private security notes

​
Source of truth

The web API reference is generated from src/shared/schemas/api-boundary.ts. Desktop release notes live in the desktop repository changelog and GitHub Releases.