Cloudflare Inbox Docs

Waku + Cloudflare worker inbox

Browse docs

Documentation

Getting Started

Run the app locally, understand the key bindings, and know what is public versus protected.

View markdownEdit on GitHub
content/docs/getting-started.mdx

Local development

Use the normal Waku loop for UI work:

npm install
npm run dev

For Worker-local validation with Cloudflare bindings:

npm run preview:worker

Typecheck and build

The docs live in this repo and ship with the normal app build, so validation stays simple:

npm run typecheck
npm run build

Worker bindings

  • EMAIL for outbound replies
  • INBOX_R2 for stored message payloads and attachments
  • SUPPORT_ALIAS
  • SUPPORT_DISPLAY_NAME

Public and protected routes

  • / is public.
  • /docs is public.
  • /login is public.
  • /app is protected only when AUTH_PASSWORD or AUTH_TOKEN is configured.
  1. Configure the Cloudflare bindings first.
  2. Set AUTH_PASSWORD or AUTH_TOKEN as a Worker secret.
  3. Deploy the Worker.
  4. Verify /docs, /login, and /app.