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_IDWORKOS_API_KEYACCOUNT_IDDISPATCH_NAMESPACE_API_TOKEN
Important vars
SHIPLET_AUTH_MODESHIPLET_APP_URLWORKOS_REDIRECT_URICUSTOM_DOMAINDISPATCH_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'))"