Skip to content

Architecture

Sink runs the dashboard, API, and short-link redirects on Cloudflare Workers or Pages.

  1. A visitor opens a short link on your domain
  2. Sink looks up the link and redirects (or shows a password/warning page)
  3. You manage links in the dashboard or via the API (both require login)
  4. If analytics is enabled, visits show up in reports and logs

Cloudflare services Sink uses

Binding nameProductRequired?Plain meaning
DBD1YesMain database — the real home of your links
KVKVYesFast cache for redirects + one-time setup flag
ANALYTICSAnalytics EngineRecommendedVisit events for charts and logs
R2R2OptionalFile storage for backups and social images
AIWorkers AIOptionalSuggests short codes and titles

D1 is where links are really stored. KV is a fast copy used for redirects. After you save a link, Sink updates the cache; if the cache is wrong, it is dropped and reloaded from D1.

After the first deploy, open Dashboard → Links once so Sink can finish storage setup. Until then, most link APIs fail with “storage not ready” (HTTP 423). See storage setup / migration.

R2 and AI are optional extras. Start with Getting Started.