Deploy

Turboflare has two deploy paths: one-click deploy for quick setup, and manual Wrangler deploy for controlled environments.

If you want Turboflare to ask questions and fill the standard values without keeping a source checkout, use clone-free setup instead:

pnpm dlx create-turboflare

One-click deploy

Use the deploy button on the docs homepage or README.

The deploy flow runs the repository's root deploy script:

pnpm deploy

That script:

After deployment, add a Worker secret named TURBO_TOKEN in the Cloudflare dashboard.

Manual deploy

pnpm install
pnpm deploy

Expected output includes a Worker URL:

https://turboflare-cache-worker.<subdomain>.workers.dev

Use that URL as TURBO_API.

Worker-only deploy

If you already created the bucket:

pnpm --filter @turboflare/cache-worker deploy

This skips the root bucket-creation helper.

Bucket setup

Default bucket config:

{
  "r2_buckets": [
    {
      "binding": "ARTIFACTS",
      "bucket_name": "turboflare-artifacts",
    },
  ],
}

Manual bucket creation:

wrangler r2 bucket create turboflare-artifacts

If you change the bucket name in wrangler.jsonc, pnpm deploy will use the new name.

Required secret

wrangler secret put TURBO_TOKEN --config apps/cache-worker/wrangler.jsonc

For local testing, you can use any long random string. Use the same value in your Turbo client environment.

Optional admin secret

wrangler secret put INTERNAL_ADMIN_TOKEN --config apps/cache-worker/wrangler.jsonc

Only set this if you want /internal/* admin routes. These routes fail closed when the secret is missing.

Smoke checks

curl -i https://<worker>/management/health

Expected:

Authenticated status:

curl -H "Authorization: Bearer $TURBO_TOKEN" \
  "$TURBO_API/v8/artifacts/status"

Expected:

The Worker should accept the matching Turbo token with 200. Without auth, the same status route should return 401.

Deploy docs separately

The docs app is static and lives in apps/docs.

pnpm --filter @turboflare/docs build

Static output:

apps/docs/dist

Deploy it to Cloudflare Pages or any static host. Keep the cache Worker and docs app as separate deploy targets.