Public docs

Shiplet documentation

Learn how to publish static previews, share review links, collect feedback, and wire feedback back into your workflow.

Operations

Deployment

Cloudflare resources used by Shiplet.

Shiplet runs as a Cloudflare Worker.

Current bindings:

  • D1 stores users, sessions, organizations, teams, shiplets, invitations, API keys, and feedback.
  • R2 stores review screenshots when configured.
  • Workers for Platforms can deploy dynamic Worker-backed shiplets when a dispatch namespace is configured.
  • Static shiplets can run without Workers for Platforms through the D1 asset fallback.

Required secrets

  • WORKOS_CLIENT_ID
  • WORKOS_API_KEY
  • ACCOUNT_ID
  • DISPATCH_NAMESPACE_API_TOKEN

Important vars

  • SHIPLET_AUTH_MODE
  • SHIPLET_APP_URL
  • WORKOS_REDIRECT_URI
  • CUSTOM_DOMAIN
  • DISPATCH_NAMESPACE_NAME

Production checks

Before deploying:

npm run typecheck
npm test
node -e "JSON.parse(require('fs').readFileSync('docs.json', 'utf8')); JSON.parse(require('fs').readFileSync('openapi.json', 'utf8'))"