void 0.22.0 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/dist/{account-cmd-CjyxcGkM.mjs → account-cmd-C84Ee8cO.mjs} +4 -4
- package/dist/{scan-ClYmX3sa.mjs → application-analysis-BVsVqc11.mjs} +135 -18
- package/dist/application-routing-B7QEjqSR.mjs +27 -0
- package/dist/{auth-CZuiVsFh.mjs → auth-CCjt0hcq.mjs} +1 -1
- package/dist/{auth-DLNN0D3Z.mjs → auth-CSkdO2Bb.mjs} +4 -47
- package/dist/{auth-link-BLO4ptzo.mjs → auth-link-CioEg6uY.mjs} +4 -4
- package/dist/{auth-router-ZUg9MF_U.mjs → auth-router-BsR981d4.mjs} +4 -4
- package/dist/{better-auth-shared-rsBGBvWJ.mjs → better-auth-shared-hy6RPh9W.mjs} +13 -2
- package/dist/{build-cmd-BxR5FROK.mjs → build-cmd-LzvNJORH.mjs} +17 -5
- package/dist/{cache-D0sWhgKI.mjs → cache-C4MvnrMH.mjs} +2 -2
- package/dist/{cancel-deploy-D4NUqFbi.mjs → cancel-deploy-abUxpP2n.mjs} +2 -2
- package/dist/{cf-build-output-BJ6yGEIS.mjs → cf-build-output-BPqOT964.mjs} +2 -1
- package/dist/cf-build-output-_0HNWysu.mjs +2 -0
- package/dist/cli/cli.mjs +80 -455
- package/dist/cli/{cf-compat.mjs → cloudflare-operation-process.mjs} +442 -421
- package/dist/cli/env-schema-probe.d.mts +2 -1
- package/dist/cli/env-schema-probe.mjs +3 -3
- package/dist/client-Cu7jWiF1.mjs +2 -0
- package/dist/{client-BTZ3XkrB.mjs → client-RV8NVeB8.mjs} +140 -21
- package/dist/{cloudflare-auth-DQkqoMYa.mjs → cloudflare-auth-Qdc7tw8F.mjs} +41 -38
- package/dist/{cloudflare-cmd-BKlfGHAy.mjs → cloudflare-cmd-BcrVyTmJ.mjs} +5 -5
- package/dist/cloudflare-config-Bktvwtpf.mjs +182 -0
- package/dist/{cloudflare-connect-Ctmrw579.mjs → cloudflare-connect-B8uPZ4nx.mjs} +3 -3
- package/dist/{cloudflare-operations-BT6OWFBk.mjs → cloudflare-operations-AiWashgg.mjs} +1 -1
- package/dist/{cloudflare-operations-B9tzgjmf.mjs → cloudflare-operations-fxHb-byx.mjs} +116 -172
- package/dist/{preset-UHj9ARyP.mjs → cloudflare-process-B-wekeR6.mjs} +93 -6
- package/dist/{config-VavjpDnp.d.mts → config-BMHb8RCj.d.mts} +1 -0
- package/dist/config-C_XRIPx2.mjs +89 -0
- package/dist/config-entry.d.mts +1 -1
- package/dist/{connect-Dg-WkW-C.mjs → connect-Bd4kJd9U.mjs} +5 -5
- package/dist/{create-project-DdoqwFLF.mjs → create-project-Boczwj5r.mjs} +1 -1
- package/dist/{create-project-l9J7pbtm.mjs → create-project-bMf6ffLZ.mjs} +2 -2
- package/dist/{db-gp2sCXyN.mjs → db-8uG64XLl.mjs} +21 -21
- package/dist/{delete-TTedbH6B.mjs → delete-NvbiyeJf.mjs} +2 -2
- package/dist/{deploy-CH-o2CaZ.mjs → deploy-DzAIwqNU.mjs} +908 -582
- package/dist/{deploy-B19L2Bra.mjs → deploy-bjXdFCtn.mjs} +1 -1
- package/dist/{domain-JRF59P_r.mjs → domain-y5Tvydvo.mjs} +3 -3
- package/dist/{email-Bo6G9LOZ.mjs → email-B3umsW75.mjs} +13 -28
- package/dist/{env-BYOrWQnv.mjs → env-BS6qYHDb.mjs} +4 -4
- package/dist/{env-public-BxU_0yTL.d.mts → env-public-BX_r8HR6.d.mts} +1 -1
- package/dist/{env-validation-BB4GkLxn.mjs → env-validation-BPn7vk-V.mjs} +18 -71
- package/dist/{env-validation-BXge7uyK.mjs → env-validation-DbTg7-ar.mjs} +1 -1
- package/dist/{fetch-CXDChK7B.mjs → fetch-BIZJh7vR.mjs} +2 -2
- package/dist/{fetch-stream-AOByI7Ki.mjs → fetch-stream-IvCYKyQL.mjs} +24 -4
- package/dist/{gen-sCtlCOdA.mjs → gen-B580--vC.mjs} +2 -2
- package/dist/gen-BVaUUumi.mjs +2 -0
- package/dist/{github-cmd-0-7PexDq.mjs → github-cmd-v45BdfKX.mjs} +2 -2
- package/dist/{handler-HEcZsaij.d.mts → handler-CZ4nAylQ.d.mts} +1 -1
- package/dist/help-DofyZuY7.mjs +2 -0
- package/dist/{help-GKtwl07I.mjs → help-daGKjXGk.mjs} +229 -747
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +288 -1502
- package/dist/info-B97bTX9N.mjs +113 -0
- package/dist/{init-FZx3Elvz.mjs → init-Bvy7zrBo.mjs} +46 -15
- package/dist/limits-Bq5LG8Id.d.mts +27 -0
- package/dist/limits-Cjuk2VPm.mjs +68 -0
- package/dist/{link-BrQfb_CU.mjs → link-CDqqCjFl.mjs} +3 -3
- package/dist/{list-D44jmIAM.mjs → list-CZj0dzKY.mjs} +3 -3
- package/dist/{live-CKJlvlNp.d.mts → live-Chw1eIMv.d.mts} +1 -1
- package/dist/{local-d1-Bg9OzEEO.mjs → local-d1-2CMnpuW_.mjs} +2 -2
- package/dist/login-DYt_An22.mjs +2 -0
- package/dist/{login-CAsAsQ-_.mjs → login-UZKFM_u7.mjs} +3 -3
- package/dist/{logs-BjKvFnVM.mjs → logs-CUZ6t9t3.mjs} +3 -3
- package/dist/migrate-8_2u55MD.mjs +2 -0
- package/dist/{migrate-BPITvDJN.mjs → migrate-DHul7PRV.mjs} +2 -1
- package/dist/{node-Dt7z256D.mjs → node-BkyRWRx8.mjs} +1 -1
- package/dist/operator-args-CLgKGlwU.mjs +690 -0
- package/dist/{operator-cmd-BK5CCiT9.mjs → operator-cmd-DBA6dl0m.mjs} +68 -22
- package/dist/pages/client.d.mts +34 -2
- package/dist/pages/client.mjs +59 -3
- package/dist/pages/index.d.mts +1 -1
- package/dist/pages/index.mjs +1 -1
- package/dist/pages/islands-plugin.mjs +1 -1
- package/dist/pages/protocol.d.mts +2 -2
- package/dist/pages/protocol.mjs +2 -308
- package/dist/{parse-filename-DioPHiR9.mjs → parse-filename-CUbj-1MP.mjs} +35 -1
- package/dist/plan-D1Q5rf-r.mjs +2 -0
- package/dist/plan-NPpwZ_kc.mjs +58 -0
- package/dist/platform-args-BJdRtlLq.mjs +506 -0
- package/dist/platform-args-D3RXyR6h.mjs +2 -0
- package/dist/{platform-auth-config-BlN8xTdD.mjs → platform-auth-config-B56E9YP1.mjs} +3 -3
- package/dist/{platform-auth-protection-7d5aV2Jg.mjs → platform-auth-protection-BDWO_aER.mjs} +2 -2
- package/dist/{platform-auth-recovery-Dxij8ZbR.mjs → platform-auth-recovery-1gg4CSRe.mjs} +3 -3
- package/dist/{platform-cmd-E0FuL212.mjs → platform-cmd-Bt-1w6pY.mjs} +1 -1
- package/dist/{platform-cmd-B3hwKrFK.mjs → platform-cmd-DMcQStSc.mjs} +24 -3
- package/dist/{platform-domain-D6Xcy9ZX.mjs → platform-domain-BNkcz0OB.mjs} +2 -2
- package/dist/{platform-lifecycle-k0E0xoxx.mjs → platform-lifecycle-9OyBALhH.mjs} +327 -215
- package/dist/{platform-lifecycle-DMh_qrry.mjs → platform-lifecycle-BE6C_jxh.mjs} +1 -1
- package/dist/{platform-management-Brz_BDiT.mjs → platform-management-CjwLVQwN.mjs} +6 -3
- package/dist/{platform-management-DOtss0BN.mjs → platform-management-CnyTdcWX.mjs} +1 -1
- package/dist/platform-plans-config-BNGKGr4P.mjs +359 -0
- package/dist/{platform-recovery-BvtcXON5.mjs → platform-recovery-D6KSpuFm.mjs} +2 -2
- package/dist/{plugin-inference-BMfKRSqE.mjs → plugin-inference-CXWnn79A.mjs} +174 -64
- package/dist/{prepare-C-6YZyyg.mjs → prepare-B5Mkic5u.mjs} +1 -1
- package/dist/{prepare-CRhJbVrG.mjs → prepare-DOsL0CC9.mjs} +4 -20
- package/dist/prepare-cgvDMtSb.mjs +2 -0
- package/dist/{project-cmd-BZLCqOqw.mjs → project-cmd-CNzrqvBv.mjs} +16 -16
- package/dist/{project-team-BvgM0WoX.mjs → project-team-DQOWPfQT.mjs} +2 -2
- package/dist/{project-token-l5DqK6Az.mjs → project-token-CTDYU0Cc.mjs} +2 -2
- package/dist/{project-zero-trust-v6Mvpp8y.mjs → project-zero-trust-BNAkW-_0.mjs} +2 -2
- package/dist/{protocol-BBa6cstI.d.mts → protocol-CjF_iI9X.d.mts} +2 -2
- package/dist/protocol-U7bfjHmA.mjs +331 -0
- package/dist/{provision-Fr9pRqce.mjs → provision-C4ORE7G7.mjs} +1 -1
- package/dist/{provision-C4IGqkBf.mjs → provision-CJFgTZY8.mjs} +89 -198
- package/dist/{requests-DN-BbNiM.mjs → requests-MhxYnau8.mjs} +2 -2
- package/dist/resource-name-C7LVpcRm.mjs +11 -0
- package/dist/{rollback-D7rzSaZM.mjs → rollback-CJ6iSDoU.mjs} +3 -3
- package/dist/route-url-CG7U-cRN.mjs +15 -0
- package/dist/{runner-B8wXwWlo.mjs → runner-CXA9Fh8h.mjs} +1 -1
- package/dist/{runner-p-dMs2UN.mjs → runner-Ol0TNjk6.mjs} +2 -2
- package/dist/runtime/ai.d.mts +12 -8
- package/dist/runtime/ai.mjs +84 -17
- package/dist/runtime/better-auth-mysql.mjs +1 -1
- package/dist/runtime/better-auth-pg.mjs +1 -1
- package/dist/runtime/better-auth.mjs +1 -1
- package/dist/runtime/client-react.mjs +2 -2
- package/dist/runtime/client-solid.mjs +2 -2
- package/dist/runtime/client-svelte.mjs +2 -2
- package/dist/runtime/client-vue.mjs +2 -2
- package/dist/runtime/client.mjs +2 -2
- package/dist/runtime/durable.d.mts +3 -1
- package/dist/runtime/durable.mjs +4 -1
- package/dist/runtime/email/testing.mjs +1 -1
- package/dist/runtime/env-public.d.mts +1 -1
- package/dist/runtime/fetch-stream.mjs +1 -1
- package/dist/runtime/fetch.mjs +1 -1
- package/dist/runtime/handler.d.mts +1 -1
- package/dist/runtime/kv.mjs +0 -1
- package/dist/runtime/limits.d.mts +2 -0
- package/dist/runtime/limits.mjs +2 -0
- package/dist/runtime/live-client.d.mts +1 -1
- package/dist/runtime/live-server.mjs +25 -16
- package/dist/runtime/live.d.mts +1 -1
- package/dist/runtime/migration-handler.mjs +62 -42
- package/dist/runtime/route-url.d.mts +4 -0
- package/dist/runtime/route-url.mjs +2 -0
- package/dist/runtime/routing.d.mts +180 -0
- package/dist/runtime/routing.mjs +1082 -0
- package/dist/runtime/sandbox-container.d.mts +1 -1
- package/dist/runtime/sandbox-container.mjs +1 -1
- package/dist/runtime/sandbox.d.mts +3 -3
- package/dist/runtime/sandbox.mjs +75 -45
- package/dist/runtime/sse.mjs +1 -1
- package/dist/runtime/validator.d.mts +1 -1
- package/dist/runtime/ws-server.d.mts +4 -2
- package/dist/runtime/ws-server.mjs +27 -2
- package/dist/runtime/ws.d.mts +2 -2
- package/dist/runtime/ws.mjs +8 -6
- package/dist/{sandbox-qpNBT8a3.d.mts → sandbox-XZAqzFlG.d.mts} +11 -8
- package/dist/{sandbox-container-DdNEBfCc.d.mts → sandbox-container-Bo0eiFKz.d.mts} +2 -1
- package/dist/{sandbox-container-4fdqLnyb.mjs → sandbox-container-C6ItmVuN.mjs} +4 -2
- package/dist/{scan-4tfN-PSn.mjs → scan-C7okrLyM.mjs} +4 -35
- package/dist/{secret-BOtOl_cb.mjs → secret-Dli5fP0B.mjs} +4 -4
- package/dist/{sse-BaC1jXko.mjs → sse-CQNaDFFV.mjs} +6 -3
- package/dist/validate-Dq_L3s0S.mjs +2 -0
- package/dist/{validate-CIUwFpjB.mjs → validate-ctOrgiS3.mjs} +2 -1
- package/dist/{wrangler-DQF1vKyf.mjs → wrangler-7K-bW_DL.mjs} +8 -239
- package/dist/{ws-BoY7vQML.d.mts → ws-CL1w7GXU.d.mts} +13 -2
- package/package.json +15 -8
- package/skills/migrate-vite-cloudflare-to-void/SKILL.md +34 -157
- package/skills/void/SKILL.md +50 -135
- package/skills/void/docs/guide/ai.md +94 -84
- package/skills/void/docs/guide/app-types.md +3 -32
- package/skills/void/docs/guide/auth.md +12 -116
- package/skills/void/docs/guide/database/d1.md +9 -54
- package/skills/void/docs/guide/database/mysql.md +1 -1
- package/skills/void/docs/guide/database/postgresql.md +5 -26
- package/skills/void/docs/guide/database.md +23 -75
- package/skills/void/docs/guide/deployment.md +27 -113
- package/skills/void/docs/guide/durable-state.md +43 -18
- package/skills/void/docs/guide/edge/headers.md +3 -47
- package/skills/void/docs/guide/edge/prerendering.md +5 -20
- package/skills/void/docs/guide/edge/redirects.md +11 -64
- package/skills/void/docs/guide/edge/revalidation.md +5 -18
- package/skills/void/docs/guide/edge/rewrites.md +56 -284
- package/skills/void/docs/guide/edge/static-assets.md +22 -72
- package/skills/void/docs/guide/email/domains.md +112 -0
- package/skills/void/docs/guide/email/receiving.md +139 -0
- package/skills/void/docs/guide/email/sending.md +231 -0
- package/skills/void/docs/guide/email.md +13 -619
- package/skills/void/docs/guide/env-migration.md +11 -11
- package/skills/void/docs/guide/env-vars.md +9 -29
- package/skills/void/docs/guide/index.md +0 -15
- package/skills/void/docs/guide/jobs.md +3 -18
- package/skills/void/docs/guide/kv.md +5 -11
- package/skills/void/docs/guide/live.md +5 -56
- package/skills/void/docs/guide/pages-routing/actions-and-forms.md +78 -125
- package/skills/void/docs/guide/pages-routing/head.md +10 -10
- package/skills/void/docs/guide/pages-routing/islands.md +6 -36
- package/skills/void/docs/guide/pages-routing/layouts.md +6 -128
- package/skills/void/docs/guide/pages-routing/loaders.md +3 -19
- package/skills/void/docs/guide/pages-routing/markdown.md +13 -171
- package/skills/void/docs/guide/pages-routing/overview.md +7 -17
- package/skills/void/docs/guide/pages-routing/view-transitions.md +1 -1
- package/skills/void/docs/guide/platform/administration/access.md +1 -4
- package/skills/void/docs/guide/platform/administration/email.md +35 -8
- package/skills/void/docs/guide/platform/administration/operations.md +26 -4
- package/skills/void/docs/guide/platform/administration/plans.md +126 -0
- package/skills/void/docs/guide/platform/administration/projects.md +5 -2
- package/skills/void/docs/guide/platform/administration/zero-trust.md +23 -152
- package/skills/void/docs/guide/platform/development/runtime.md +3 -13
- package/skills/void/docs/guide/platform/development/schema-ci.md +0 -58
- package/skills/void/docs/guide/platform/installation/credentials.md +6 -4
- package/skills/void/docs/guide/platform/installation/domains.md +30 -2
- package/skills/void/docs/guide/platform/installation/first-deployment.md +2 -0
- package/skills/void/docs/guide/platform/installation/maintenance.md +3 -1
- package/skills/void/docs/guide/platform/installation/prerequisites.md +20 -15
- package/skills/void/docs/guide/platform/installation/setup.md +9 -5
- package/skills/void/docs/guide/platform-administration.md +1 -0
- package/skills/void/docs/guide/queues.md +7 -9
- package/skills/void/docs/guide/quickstart.md +38 -37
- package/skills/void/docs/guide/remote-dev.md +4 -9
- package/skills/void/docs/guide/sandboxes.md +29 -21
- package/skills/void/docs/guide/server-routing.md +9 -72
- package/skills/void/docs/guide/sse.md +4 -18
- package/skills/void/docs/guide/ssg.md +3 -15
- package/skills/void/docs/guide/ssr.md +14 -62
- package/skills/void/docs/guide/storage.md +9 -4
- package/skills/void/docs/guide/type-safety.md +3 -14
- package/skills/void/docs/guide/typed-fetch.md +3 -7
- package/skills/void/docs/guide/websockets.md +68 -40
- package/skills/void/docs/integrations/agents.md +3 -3
- package/skills/void/docs/integrations/cloudflare.md +85 -316
- package/skills/void/docs/integrations/frameworks/analog.md +5 -64
- package/skills/void/docs/integrations/frameworks/astro.md +4 -73
- package/skills/void/docs/integrations/frameworks/nuxt.md +5 -62
- package/skills/void/docs/integrations/frameworks/overview.md +11 -54
- package/skills/void/docs/integrations/frameworks/react-router.md +5 -60
- package/skills/void/docs/integrations/frameworks/sveltekit.md +6 -65
- package/skills/void/docs/integrations/frameworks/tanstack-start.md +4 -62
- package/skills/void/docs/integrations/nodejs-bun-deno.md +5 -69
- package/skills/void/docs/reference/api/auth.md +156 -0
- package/skills/void/docs/reference/api/client.md +87 -0
- package/skills/void/docs/reference/api/database.md +95 -0
- package/skills/void/docs/reference/api/durable.md +46 -0
- package/skills/void/docs/reference/api/env.md +50 -0
- package/skills/void/docs/reference/api/handlers.md +254 -0
- package/skills/void/docs/reference/api/pages.md +241 -0
- package/skills/void/docs/reference/api/plugin.md +39 -0
- package/skills/void/docs/reference/api/resources.md +109 -0
- package/skills/void/docs/reference/api/rewrites.md +76 -0
- package/skills/void/docs/reference/api/types.md +92 -0
- package/skills/void/docs/reference/api.md +56 -1218
- package/skills/void/docs/reference/cli/auth.md +88 -0
- package/skills/void/docs/reference/cli/database.md +128 -0
- package/skills/void/docs/reference/cli/deploy.md +85 -0
- package/skills/void/docs/reference/cli/domains.md +41 -0
- package/skills/void/docs/reference/cli/email.md +129 -0
- package/skills/void/docs/reference/cli/generate.md +116 -0
- package/skills/void/docs/reference/cli/github.md +189 -0
- package/skills/void/docs/reference/cli/platform-config.md +92 -0
- package/skills/void/docs/reference/cli/platform-email.md +81 -0
- package/skills/void/docs/reference/cli/platform-installation.md +127 -0
- package/skills/void/docs/reference/cli/platform-operations.md +90 -0
- package/skills/void/docs/reference/cli/platform-users.md +89 -0
- package/skills/void/docs/reference/cli/platform-zero-trust.md +45 -0
- package/skills/void/docs/reference/cli/platform.md +70 -0
- package/skills/void/docs/reference/cli/project.md +214 -0
- package/skills/void/docs/reference/cli/secrets.md +76 -0
- package/skills/void/docs/reference/cli/setup.md +70 -0
- package/skills/void/docs/reference/cli.md +32 -1682
- package/skills/void/docs/reference/config.md +12 -18
- package/skills/void/docs/reference/resource-inference.md +3 -58
- package/skills/void/docs/reference/structure.md +14 -41
- package/dist/canonical-json-DuDiiUsQ.mjs +0 -13
- package/dist/client-Czz8o5jP.mjs +0 -2
- package/dist/gen-CNJ62MM7.mjs +0 -2
- package/dist/help-CmZzxUba.mjs +0 -2
- package/dist/login-CGcRKEoi.mjs +0 -2
- package/dist/migrate-CYfbKkXh.mjs +0 -2
- package/dist/plan-BEZ8VJW0.mjs +0 -256
- package/dist/plan-DpuOr14e.mjs +0 -2
- package/dist/prepare-Bm3iq-u4.mjs +0 -2
- package/dist/validate-EKmJWxmy.mjs +0 -2
- /package/dist/cli/{cf-compat.d.mts → cloudflare-operation-process.d.mts} +0 -0
|
@@ -51,6 +51,30 @@ Following waits for the final logs before stopping, including diagnostics writte
|
|
|
51
51
|
|
|
52
52
|
## Checking the Platform
|
|
53
53
|
|
|
54
|
+
### Migrating older deployment assets
|
|
55
|
+
|
|
56
|
+
After upgrading the platform, inspect every page of its asset inventory:
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
void platform system asset-migrations --page 1 --limit 100
|
|
60
|
+
void platform deployment migrate-assets <deployment-id> --plan
|
|
61
|
+
void platform deployment migrate-assets <deployment-id> --yes
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Migrate every deployment with a nonzero `needsMigration` count, including retained
|
|
65
|
+
rollback targets and stored Worker bundles. Investigate entries marked `invalid`
|
|
66
|
+
before continuing. The command verifies each copied asset, preserves originals,
|
|
67
|
+
and applies successive batches. If interrupted, inspect the result and resume
|
|
68
|
+
with the last successful `nextCursor` using `--cursor`; restarting without a
|
|
69
|
+
cursor also verifies and reuses completed copies.
|
|
70
|
+
|
|
71
|
+
Run the inventory again across all pages when finished. Existing applications
|
|
72
|
+
continue serving during this migration, and the provider asset mirror remains.
|
|
73
|
+
Legacy reads remain available while older platform runtimes and cached manifests
|
|
74
|
+
can still reference original assets.
|
|
75
|
+
|
|
76
|
+
### Health checks
|
|
77
|
+
|
|
54
78
|
Use the overview to see recent activity, or run a health check to test the platform's services and database:
|
|
55
79
|
|
|
56
80
|
```sh
|
|
@@ -60,7 +84,7 @@ void platform system health
|
|
|
60
84
|
|
|
61
85
|
Health checks use the services configured for the selected platform. An unhealthy result exits with a nonzero status, so the same command can be used in a script.
|
|
62
86
|
|
|
63
|
-
The
|
|
87
|
+
The dashboard’s **System Status** page refreshes health checks every 30 seconds and shows errors beside the affected service.
|
|
64
88
|
|
|
65
89
|
Use `void platform upgrade`, `repair`, `disable`, and `enable` to maintain your platform. See [platform maintenance](/guide/platform/installation/maintenance#resume-repair-recover-and-upgrade).
|
|
66
90
|
|
|
@@ -92,6 +116,4 @@ unset VOID_OPERATOR_TOKEN
|
|
|
92
116
|
|
|
93
117
|
Disable shell tracing for the exchange and do not write either token to logs or plaintext files. A full API login session expires after 30 days and can be revoked sooner; renew it through the normal authenticated login flow and update the protected CI secret. A job that runs longer than one hour must repeat the exchange while its full API session is still valid. An expired operator token cannot refresh itself, and Void does not issue permanent service tokens for administrator automation.
|
|
94
118
|
|
|
95
|
-
`auth login --token-stdin` performs the same elevation and saves the one-hour operator token in the system keychain for interactive use. See [operator authentication](
|
|
96
|
-
|
|
97
|
-
An email zone has one connection and ingress Worker shared by its exact domain assignments. Removing one assignment preserves resources used by the others. The Email administration page can explicitly rotate that connection secret; ordinary synchronization does not rotate it. Setup and cleanup outcomes include operation IDs, and uncertain provider writes remain recorded until reconciled.
|
|
119
|
+
`auth login --token-stdin` performs the same elevation and saves the one-hour operator token in the system keychain for interactive use. See [operator authentication](../../../reference/cli/platform.md#operator-authentication) for the full command syntax.
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
---
|
|
2
|
+
outline: deep
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Plans and Limits
|
|
6
|
+
|
|
7
|
+
Plans define the resource limits you assign to accounts on your platform. They do not bill users or purchase Cloudflare services. Sign in with an administrator account and open **Plans** in the administration dashboard, or use the CLI:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
void platform auth login
|
|
11
|
+
void platform config plans
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Choose a plan to inspect or edit it, copy one into a new plan, or choose the default for new accounts. Existing installations keep their plans, limits, and default until you change them. After upgrading the platform to support plan configuration, these changes require no app or platform redeploy.
|
|
15
|
+
|
|
16
|
+
Inspection and previews are available immediately after a platform upgrade. Allow 15 minutes before applying changes.
|
|
17
|
+
|
|
18
|
+
## Use the Dashboard
|
|
19
|
+
|
|
20
|
+
Open **Plans** to see each plan's stable ID, account count, and signup default. Choose **Add plan** to copy an existing plan, or **Edit** to change its display name, limits, build size, and permission to use short project slugs.
|
|
21
|
+
|
|
22
|
+
Choose **Review changes** to compare the current and proposed settings and see how many accounts are affected. Review any quota warnings, then choose **Apply changes**. If someone changed the catalog while you were reviewing, open the plan again and create a fresh review.
|
|
23
|
+
|
|
24
|
+
The edit page also lets you choose the signup default, archive or restore assignments, reset a built-in plan, or remove a plan with an active replacement. Every action has a review step.
|
|
25
|
+
|
|
26
|
+
Account updates continue automatically on the result page. If you leave the page or an update pauses, open **Plans** and choose **Continue account updates**. Finish pending account updates before changing plans again. Recorded usage and billing periods are preserved.
|
|
27
|
+
|
|
28
|
+
## Add a Plan
|
|
29
|
+
|
|
30
|
+
Each plan has a stable ID and an editable display name. Copying a plan copies its limits, build instance size, and permission to use short project slugs:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
void platform config plans add team --copy pro --name "Team" --plan
|
|
34
|
+
void platform config plans add team --copy pro --name "Team" --yes
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Assign it to an existing account or make it the default for new accounts:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
void platform user plan <user-id> team --yes
|
|
41
|
+
void platform config plans default team --yes
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Changing the default does not move existing accounts. Renaming a plan does not change its ID or assignments.
|
|
45
|
+
|
|
46
|
+
## Edit Limits
|
|
47
|
+
|
|
48
|
+
The interactive menu lets you change one limit at a time. For scripts or several changes, create a JSON file:
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"name": "Team",
|
|
53
|
+
"limits": {
|
|
54
|
+
"requestsPerMonth": 10000000,
|
|
55
|
+
"concurrentBuilds": 3,
|
|
56
|
+
"buildTimeoutMinutes": 15
|
|
57
|
+
},
|
|
58
|
+
"buildInstanceType": "standard-4"
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Omitted settings keep their current values. Preview, then apply:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
void platform config plans set team --file team-plan.json --plan
|
|
66
|
+
void platform config plans set team --file team-plan.json --yes
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Limits are nonnegative whole numbers; `0` means unlimited by the plan. Build timeouts always have a platform maximum of 60 minutes; `0` uses that maximum. You can configure:
|
|
70
|
+
|
|
71
|
+
| Setting | Limit |
|
|
72
|
+
| ------------------------------- | ------------------------------------------------- |
|
|
73
|
+
| `requestsPerMonth` | Application requests per account billing month |
|
|
74
|
+
| `cpuMsPerRequest` | Default CPU milliseconds per application request |
|
|
75
|
+
| `maxCpuMsPerRequest` | Highest CPU limit an application can request |
|
|
76
|
+
| `subRequestsPerInvocation` | Subrequests per invocation |
|
|
77
|
+
| `deploysPerDay` | Deployments per day |
|
|
78
|
+
| `aiNeuronsPerMonth` | AI neurons per account billing month |
|
|
79
|
+
| `retainedDeployments` | Retained Worker deployments |
|
|
80
|
+
| `sandboxRuntimeSecondsPerMonth` | Sandbox runtime seconds per account billing month |
|
|
81
|
+
| `sandboxMaxConcurrentInstances` | Simultaneous Sandbox instances |
|
|
82
|
+
| `concurrentBuilds` | Simultaneous builds |
|
|
83
|
+
| `buildTimeoutMinutes` | Build timeout in minutes |
|
|
84
|
+
|
|
85
|
+
`cpuMsPerRequest` cannot exceed `maxCpuMsPerRequest`. An unlimited default CPU limit requires an unlimited ceiling. Build instance sizes are `standard-3` (2 vCPU, 8 GiB) and `standard-4` (4 vCPU, 12 GiB). New builds use the new size and timeout; running builds keep their recorded settings.
|
|
86
|
+
|
|
87
|
+
Advanced files can also set `"allowShortSlugs": true` to permit project slugs of five characters or fewer, or `false` to require longer slugs for future changes. Existing project URLs are preserved. Copying a plan inherits this setting; the built-in `free` plan disables it and the other built-in plans enable it.
|
|
88
|
+
|
|
89
|
+
Storage figures shown for D1, R2, and KV are informational and cannot be edited as enforced quotas. Static deployments keep their existing retention policy.
|
|
90
|
+
|
|
91
|
+
The preview shows the affected account count and checks a sample for accounts already above a proposed quota. Lowering a quota can restrict existing apps, including accounts outside that sample. Usage history and billing periods are preserved, so a plan change does not reset usage. Manual administrator suspensions remain in effect.
|
|
92
|
+
|
|
93
|
+
After the initial platform upgrade, request quota accounting includes unlimited plans too. For an account that was unlimited before that upgrade, its quota counter may not include earlier requests in the current billing period. Historical analytics remain available. When introducing its first cap, allow for the remaining period or wait until its next billing period.
|
|
94
|
+
|
|
95
|
+
## Archive or Remove a Plan
|
|
96
|
+
|
|
97
|
+
Archive a plan to stop assigning it to new accounts while preserving its current accounts:
|
|
98
|
+
|
|
99
|
+
```sh
|
|
100
|
+
void platform config plans archive team --yes
|
|
101
|
+
void platform config plans restore team --yes
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Choose another default before archiving the current default. To remove a plan with accounts, choose a replacement and review the changes first:
|
|
105
|
+
|
|
106
|
+
```sh
|
|
107
|
+
void platform config plans remove team --replacement pro --plan
|
|
108
|
+
void platform config plans remove team --replacement pro --yes
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Removing the default also requires a replacement. An unused plan that is not the default can be removed without one. Accounts keep their usage when moved to a replacement plan. Restore the original limits and build size of a built-in plan with `void platform config plans reset <plan-id>`; custom plans have no built-in reset values.
|
|
112
|
+
|
|
113
|
+
The removal review shows the replacement plan and any changes to its limits, build size, and short-slug permission before you confirm.
|
|
114
|
+
|
|
115
|
+
## Complete Pending Updates
|
|
116
|
+
|
|
117
|
+
After applying a change, the CLI continues account updates until complete. If an update fails or stops making progress, the configuration remains saved, the result reports pending work, and the command exits with a nonzero status. Inspect the catalog, then continue:
|
|
118
|
+
|
|
119
|
+
```sh
|
|
120
|
+
void platform config plans show
|
|
121
|
+
void platform config plans sync --yes
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
`sync` continues the saved policy's account updates until completion. Finish pending updates before editing the catalog again. If a request loses its connection, inspect the catalog and [operator events](/guide/platform/administration/operations) before retrying it.
|
|
125
|
+
|
|
126
|
+
All commands accept `--connection <registered-id-or-url>` and `--json`. Scripted changes require `--yes`; use `--plan` for a read-only preview.
|
|
@@ -21,7 +21,7 @@ void platform project list --user <user-id>
|
|
|
21
21
|
void platform project show <project-id>
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Project details include resources, domains, and recent builds and deployments. The [command reference](
|
|
24
|
+
Project details include resources, domains, and recent builds and deployments. The [command reference](../../../reference/cli/platform.md#operator-commands) also covers suspending and restoring users, deleting projects, and removing accounts.
|
|
25
25
|
|
|
26
26
|
In the admin dashboard, open a project to view its team. Search for a platform user and choose a role to add them immediately; an email address is not required. You can also change or remove existing members. Pending invitations created through other project workflows remain visible until accepted or revoked. If email is unavailable for a pending invitation, share its ID so the user can accept it with `void project team accept <invitation-id>`. The owner cannot be removed from the team; transfer ownership first.
|
|
27
27
|
|
|
@@ -38,13 +38,16 @@ The preview shows both owners, their plans and suspension state, blockers, and t
|
|
|
38
38
|
|
|
39
39
|
After the transfer, the former owner becomes a project administrator. Existing project-scoped CI deploy credentials are revoked; create replacements as the new owner. The new owner's plan and limits apply immediately. Usage before the transfer remains charged to the former owner; later usage is charged to the new owner. If an apply reports partial convergence, inspect the project and operator event log before repeating it.
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
By default, new users on a self-hosted installation start with the `custom` profile, which
|
|
42
42
|
does not cap application requests, AI usage, deployment frequency, or retained
|
|
43
43
|
Worker deployments. Named profiles such as `pro` apply the platform's quota and
|
|
44
44
|
retention policies; they do not purchase Cloudflare services or bill your users.
|
|
45
45
|
Storage figures are not a hard storage-quota boundary. Set an operating budget
|
|
46
46
|
and retention policy before opening signup beyond your invited team.
|
|
47
47
|
|
|
48
|
+
Use [Plans and Limits](/guide/platform/administration/plans) to define your own
|
|
49
|
+
plans, change limits, or choose a different default for new accounts.
|
|
50
|
+
|
|
48
51
|
The last active administrator cannot be deleted or suspended, including through
|
|
49
52
|
the browser admin UI. Another administrator must still have access. Automatic
|
|
50
53
|
usage limits do not remove administrator access and do not count as a manual
|
|
@@ -8,8 +8,6 @@ Project Zero Trust puts Cloudflare Access in front of the hostnames of projects
|
|
|
8
8
|
|
|
9
9
|
This is separate from the Access login and protection for the platform API. Projects deployed directly to Cloudflare are not affected.
|
|
10
10
|
|
|
11
|
-
The steps below set it up. [How Protection Works](#how-protection-works) explains what visitors see, which Access applications Void creates, and what happens while settings change.
|
|
12
|
-
|
|
13
11
|
## Requirements
|
|
14
12
|
|
|
15
13
|
- A Cloudflare Zero Trust organization in the account that hosts the platform, with the identity providers and reusable Access policies you want to use. Select at least one Allow policy that matches people by identity. Void rejects Bypass and Service Auth policies, and rules that allow Everyone or any service token.
|
|
@@ -71,26 +69,11 @@ void platform zero-trust disable
|
|
|
71
69
|
|
|
72
70
|
This removes the Access applications Void created and makes all projects public. On large installations it runs in steps; run it again, or check `void platform zero-trust status`, until Zero Trust shows as disabled with no operation running.
|
|
73
71
|
|
|
74
|
-
|
|
72
|
+
Disable Zero Trust and wait for its applications to be removed before [uninstalling the platform](/guide/platform/installation/uninstall). If project deletion stopped partway, retry `void project delete` for that project.
|
|
75
73
|
|
|
76
74
|
## How Protection Works
|
|
77
75
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
```text
|
|
81
|
-
Visitor
|
|
82
|
-
│
|
|
83
|
-
▼
|
|
84
|
-
Cloudflare Access ─── not signed in ─────────▶ sign-in page
|
|
85
|
-
│ signed in and allowed by your policies
|
|
86
|
-
▼
|
|
87
|
-
Void checks the Access token ─── rejected ───▶ 403 page
|
|
88
|
-
│ token is valid for this hostname
|
|
89
|
-
▼
|
|
90
|
-
Your project: routes, pages, assets, WebSockets
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
A public project skips both. Access lets every visitor through, and Void does not look for a token.
|
|
76
|
+
Cloudflare Access handles sign-in and applies your policies. Void also verifies the token before serving a protected project. Public projects allow visitors without sign-in.
|
|
94
77
|
|
|
95
78
|
### What Visitors See
|
|
96
79
|
|
|
@@ -108,7 +91,7 @@ Void only covers the `workers.dev` testing URLs of this installation. Other Work
|
|
|
108
91
|
|
|
109
92
|
#### The 403 Page
|
|
110
93
|
|
|
111
|
-
|
|
94
|
+
A request without a valid token receives `403 Cloudflare Access authentication required`. Page requests show an HTML error; API and asset requests receive plain text. These responses are never cached.
|
|
112
95
|
|
|
113
96
|
Visitors who went through the sign-in page normally never see it. They can see it:
|
|
114
97
|
|
|
@@ -122,29 +105,13 @@ Protection applies to the whole hostname. There are no path exceptions. `/api/*`
|
|
|
122
105
|
|
|
123
106
|
#### Webhooks and Other Non-Browser Clients
|
|
124
107
|
|
|
125
|
-
|
|
108
|
+
Project protection requires a person’s identity. Webhooks, CI jobs, uptime checks, and unauthenticated `curl` calls receive the sign-in page or a 403.
|
|
126
109
|
|
|
127
110
|
If a project must accept such requests:
|
|
128
111
|
|
|
129
112
|
- make the project public with `void project zero-trust public` and check callers in your own code, or
|
|
130
113
|
- move the endpoints that machines call into a separate project, and make only that project public.
|
|
131
114
|
|
|
132
|
-
### Two Checks on Every Request
|
|
133
|
-
|
|
134
|
-
Cloudflare Access is the first check. It runs at Cloudflare's edge, shows the sign-in page, and applies your policies. Only visitors your policies allow get an Access token for the project.
|
|
135
|
-
|
|
136
|
-
Void is the second check. Before a protected project runs, Void confirms that the request carries an Access token that:
|
|
137
|
-
|
|
138
|
-
- was issued by your Zero Trust team;
|
|
139
|
-
- belongs to one of the Access applications Void created for this project's hostname;
|
|
140
|
-
- has not expired.
|
|
141
|
-
|
|
142
|
-
If any of this fails, the visitor gets the [403 page](#the-403-page). Your routes, assets, and caches are never reached.
|
|
143
|
-
|
|
144
|
-
This gives you one guarantee: **deleting a Void-managed Access application, or changing its hostnames, cannot make a protected project public.** If someone deletes Void's application, or points it at other hostnames, visitors are refused instead of let in. Loosening the policies of Void's application in the dashboard does widen who can sign in, until the next update puts Void's policies back.
|
|
145
|
-
|
|
146
|
-
The second check does not look at your policies again. Who may sign in is decided only by the policies in Cloudflare Access. If you loosen a selected policy, the change applies to every protected project.
|
|
147
|
-
|
|
148
115
|
### Access Applications Void Creates
|
|
149
116
|
|
|
150
117
|
Void creates and owns these self-hosted applications in your Zero Trust organization:
|
|
@@ -168,147 +135,51 @@ Use 1 instead of 2 on an installation without a domain. For example, 40 projects
|
|
|
168
135
|
|
|
169
136
|
#### Recognizing Void's Applications
|
|
170
137
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
```text
|
|
174
|
-
void-<installation>-<code>-<random>-project-zero-trust shared project application
|
|
175
|
-
void-<installation>-<code>-<random>-public-<project-id> public exception
|
|
176
|
-
void-<installation>-<code>-<random>-protected-<project-id> custom domain application
|
|
177
|
-
void-<installation>-<code>-<random>-platform-health health check exception
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
- `<installation>` is the start of your installation ID, which begins with your installation name.
|
|
181
|
-
- `<code>` is 16 characters. It is the same for every application of one installation.
|
|
182
|
-
- `<random>` is 32 random characters.
|
|
183
|
-
- `<project-id>` is the project ID, such as `proj_abc123def456`. The project slug is not part of the name.
|
|
184
|
-
|
|
185
|
-
To see the exact names Void recorded, run `void platform zero-trust status` for the shared application and the health check exception, and `void platform zero-trust project-status <project-id>` for a project's applications. There, the public exception is listed as `bypass application name` and the custom domain application as `protected application name`.
|
|
138
|
+
Run `void platform zero-trust status` for the shared and health-check applications, or `void platform zero-trust project-status <project-id>` for a project's applications. These commands show their exact names and IDs.
|
|
186
139
|
|
|
187
140
|
### Editing Applications in the Dashboard
|
|
188
141
|
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
You can still edit the rules inside a selected reusable policy. Void's applications use your policies as they are. Void checks them again during `void platform zero-trust configure` and `void platform zero-trust reconcile`, which stop with an error, and during `status --check`, which reports `present: false`. A policy fails this check when it now allows Everyone or any service token, or uses a Bypass or Service Auth decision.
|
|
192
|
-
|
|
193
|
-
#### What Happens If You Do
|
|
194
|
-
|
|
195
|
-
Void writes an application when it updates it: during platform `configure` or `reconcile`, during a project's `protect`, `public`, or `reconcile`, when a custom domain is added to or removed from that project, and while it retries a project that is not settled. Scheduled maintenance does not look for dashboard changes on settled projects. Until one of these runs, your change stays in effect.
|
|
142
|
+
Manage Void’s applications through `void platform zero-trust configure` and the project commands. Editing or deleting them in Cloudflare can block access until you reconcile. Dashboard edits may be replaced the next time Void updates an application.
|
|
196
143
|
|
|
197
|
-
|
|
198
|
-
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
|
|
199
|
-
| Edit hostnames, policies, providers, or session length | Your change stays until the next update, which puts Void's settings back. | Run the reconcile command for that application |
|
|
200
|
-
| Delete the shared project application | Protected projects answer 403 on `<slug>.<your domain>` and `workers.dev` URLs. Their custom domains and public projects keep working. | `void platform zero-trust reconcile` |
|
|
201
|
-
| Delete a public exception | Visitors of that public project are asked to sign in, because the shared application now covers it. | `void project zero-trust reconcile` in that project |
|
|
202
|
-
| Delete a custom domain application | That protected project answers 403 on its custom domains. | `void project zero-trust reconcile` in that project |
|
|
203
|
-
| Delete the health check exception | Platform health checks fail with a redirect to sign-in, so the admin dashboard shows `dispatch` as unhealthy and `void platform upgrade` and `repair` stop at their health check. | `void platform zero-trust reconcile` |
|
|
204
|
-
| Rename an application | Void stops updating or deleting it. Reconcile fails with `The recorded Access application no longer has its Void-owned name.` For the shared application, platform status then shows `error`. | Rename it back to the recorded name, then reconcile |
|
|
205
|
-
| Copy an application with the same name | Void ignores the copy while the original exists, and `disable` does not remove it. If the original is later deleted, reconcile fails with `Multiple Cloudflare Access applications are named <name>.` | Delete the copy, then reconcile |
|
|
206
|
-
|
|
207
|
-
When Void recreates a deleted shared project application, the new application issues different Access tokens. Void then moves each protected project to it. On large installations this runs in steps, and protected projects answer 403 until Void reaches them.
|
|
208
|
-
|
|
209
|
-
#### Checking for Changes
|
|
144
|
+
You can edit a selected reusable policy’s rules in Cloudflare. Changes affect every project using that policy. Keep an identity-based Allow policy without Everyone or service tokens, then check it with:
|
|
210
145
|
|
|
211
146
|
```sh
|
|
212
147
|
void platform zero-trust status --check
|
|
213
148
|
```
|
|
214
149
|
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
```text
|
|
218
|
-
checked: true
|
|
219
|
-
live:
|
|
220
|
-
present: true
|
|
221
|
-
drifted: false
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
- `drifted: true` means the shared application or the health check exception no longer matches. Run `void platform zero-trust reconcile`.
|
|
225
|
-
- `present: false` means Void could not read it. The application may be deleted, a selected identity provider or policy may be gone or no longer allowed, or the token may not work. Check the token and selections, then run `void platform zero-trust reconcile`.
|
|
150
|
+
- `drifted: true`: run `void platform zero-trust reconcile`.
|
|
151
|
+
- `present: false`: check the token, application, identity providers, and policies, then reconcile.
|
|
226
152
|
|
|
227
|
-
|
|
153
|
+
This checks the shared and health-check applications. For a public exception or custom-domain application, use the project's reconcile command.
|
|
228
154
|
|
|
229
155
|
#### Repair Commands
|
|
230
156
|
|
|
231
|
-
| Command |
|
|
232
|
-
| --------------------------------------------------------- |
|
|
233
|
-
| `void platform zero-trust reconcile` |
|
|
234
|
-
| `void platform zero-trust project-reconcile <project-id>` | One project
|
|
235
|
-
| `void project zero-trust reconcile` |
|
|
157
|
+
| Command | Scope | Who can run it |
|
|
158
|
+
| --------------------------------------------------------- | ------------------------------------- | ---------------------------------------- |
|
|
159
|
+
| `void platform zero-trust reconcile` | Platform and all projects | Installation administrators |
|
|
160
|
+
| `void platform zero-trust project-reconcile <project-id>` | One project | Installation administrators |
|
|
161
|
+
| `void project zero-trust reconcile` | Linked project, or `--project <slug>` | Project owner and project administrators |
|
|
236
162
|
|
|
237
|
-
|
|
163
|
+
Project reconciliation requires platform status `ready`. Otherwise, reconcile the platform first.
|
|
238
164
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
Void orders every change so that a protected project never becomes public by mistake. If a step fails, the project keeps its protection, or refuses visitors with the 403 page, until the change can finish.
|
|
242
|
-
|
|
243
|
-
Void's router can keep a project's previous setting for up to about a minute. During that time, some visitors may see the 403 page instead of the sign-in page.
|
|
244
|
-
|
|
245
|
-
#### Protecting or Making a Project Public
|
|
246
|
-
|
|
247
|
-
`void project zero-trust protect` and `void project zero-trust public` usually finish before the command returns.
|
|
248
|
-
|
|
249
|
-
- **Protect.** Void covers the custom domains first, then turns on its own check, then removes the public exception. Visitors may see the 403 page for a moment before Access starts asking them to sign in.
|
|
250
|
-
- **Public.** Void adds the public exception first, then turns off its own check, then removes the custom domain application. Visitors may see the 403 page for a moment before the project opens.
|
|
251
|
-
|
|
252
|
-
If the command prints `Zero Trust update is still in progress`, run `void project zero-trust reconcile` to continue, or wait for the hourly maintenance. If it fails with `Cloudflare Access could not be updated. Protection remains fail closed.`, fix the cause, then run `void project zero-trust reconcile`. Until then, a project that was protected stays protected. A project you were protecting may already ask for sign-in, or answer with the 403 page, but it is never more open than before. A project you were making public may already be open on some hostnames.
|
|
253
|
-
|
|
254
|
-
Run `void project zero-trust status` to follow a change. `State:` shows `reconciling` while it runs, `error` when it needs attention, and `protected` or `public` when it is done. `Last error:` explains a failure.
|
|
255
|
-
|
|
256
|
-
#### Enabling and Disabling Zero Trust
|
|
257
|
-
|
|
258
|
-
Large changes run in steps. Platform status shows `configuring` or `disabling`, and project owners see `Available: no`. Scheduled maintenance continues within a few minutes.
|
|
259
|
-
|
|
260
|
-
When you **enable** Zero Trust:
|
|
261
|
-
|
|
262
|
-
1. Void adds the public exception for each project that stays public. These projects never ask visitors to sign in.
|
|
263
|
-
2. Void creates the health check exception, then the shared project application. From here, the `<slug>.<your domain>` and `workers.dev` URLs of protected projects require sign-in.
|
|
264
|
-
3. Void goes through the protected projects and covers their custom domains. A project's custom domains stay open until Void reaches it.
|
|
265
|
-
|
|
266
|
-
If Void cannot add a project's public exception, the project shows `error`, and its visitors are asked to sign in until the next retry succeeds. Void retries every hour, or run `void project zero-trust reconcile` once platform status is `ready`.
|
|
165
|
+
If an application was renamed, restore its recorded name before reconciling. Remove duplicate copies yourself. Deleting the shared application temporarily blocks protected projects; deleting the health-check exception can block upgrades and repair until it is restored.
|
|
267
166
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
1. Void turns off its own check for each protected project and removes its custom domain application. Custom domains open here.
|
|
271
|
-
2. Void deletes the shared project application, then the health check exception. `<slug>.<your domain>` and `workers.dev` URLs open here.
|
|
272
|
-
3. Void deletes the public exceptions. Public projects stay open the whole time.
|
|
273
|
-
|
|
274
|
-
#### Custom Domains
|
|
275
|
-
|
|
276
|
-
A custom domain on a protected project goes live only after Void adds it to the project's custom domain application. If Access cannot be updated, the domain stays pending and is not reachable. Void tries again each time it checks the domain.
|
|
277
|
-
|
|
278
|
-
When you remove a custom domain, Void removes it from the project first, then from the Access application. If the Access update fails, the project shows `reconciling` or `error` and Void retries every hour. A protected project can have up to 100 custom domains. Custom domains on public projects need no Access change.
|
|
279
|
-
|
|
280
|
-
#### New Projects
|
|
281
|
-
|
|
282
|
-
A new project starts protected or public based on the default for new projects. If Void cannot set up its protection, creating the project still succeeds with a warning. See [Recovery](#recovery).
|
|
283
|
-
|
|
284
|
-
#### Deploys and Rollbacks
|
|
167
|
+
### What Happens During Changes
|
|
285
168
|
|
|
286
|
-
|
|
169
|
+
Protection changes can temporarily return a 403. If a step fails, a protected project stays protected or refuses visitors until the change finishes.
|
|
287
170
|
|
|
288
|
-
|
|
289
|
-
- `The project public exception is still reconciling.`
|
|
290
|
-
- `Project Zero Trust is still reconciling.`
|
|
171
|
+
Protecting or making a project public usually finishes before the command returns. If it is still running or reports an error, inspect `void project zero-trust status`, fix the reported cause, and run `void project zero-trust reconcile`.
|
|
291
172
|
|
|
292
|
-
|
|
173
|
+
Platform-wide changes run in steps. During initial setup, custom domains stay public until Void reaches their project. During disable, hostnames can become public at different times. Follow progress with `void platform zero-trust status`.
|
|
293
174
|
|
|
294
|
-
A
|
|
175
|
+
A new custom domain becomes reachable only after its project’s protection is ready.
|
|
295
176
|
|
|
296
177
|
### Caching
|
|
297
178
|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
On a protected project, this means:
|
|
301
|
-
|
|
302
|
-
- pages render on every request, and ISR never serves a cached page;
|
|
303
|
-
- static files and hashed assets skip the edge cache;
|
|
304
|
-
- the project handles more requests and may respond more slowly than a public project.
|
|
305
|
-
|
|
306
|
-
Public projects keep using the shared caches as usual.
|
|
179
|
+
Requests carrying an Access token bypass [ISR](/guide/edge/revalidation#cache-bypass) and the [static asset edge cache](/guide/edge/static-assets#non-hashed-assets). Protected pages render on each request, which can increase latency and request usage. Public projects keep their shared caches.
|
|
307
180
|
|
|
308
181
|
## Recovery
|
|
309
182
|
|
|
310
|
-
A project never becomes public by mistake while a change is in progress. See [What Happens During Changes](#what-happens-during-changes).
|
|
311
|
-
|
|
312
183
|
- **Status stays `configuring` or `disabling`.** Large changes run in steps. Scheduled maintenance continues them within a few minutes, or run `void platform zero-trust reconcile`.
|
|
313
184
|
- **Status shows an error.** Fix the cause shown, such as token permissions or the application limit, then run `void platform zero-trust reconcile`. Otherwise Void retries every hour.
|
|
314
185
|
- **One project shows an error.** The rest of the change still finishes. Void retries the project every hour, or its owner or a project administrator can run `void project zero-trust reconcile`. Until then, a project that was already protected stays protected, and a project being newly protected is never more open than before.
|
|
@@ -52,12 +52,7 @@ If your fork has added managed GitHub builds and Cloudflare Access protects its
|
|
|
52
52
|
to `/webhooks/github`: GitHub does not present your Access credentials. Do not add
|
|
53
53
|
an Everyone or bypass policy to the API application.
|
|
54
54
|
|
|
55
|
-
|
|
56
|
-
It accepts only `POST /github`, validates GitHub's signature over the raw body,
|
|
57
|
-
and forwards one authenticated internal operation over an API service binding.
|
|
58
|
-
The API independently verifies both that internal proof and GitHub's signature
|
|
59
|
-
before running the normal webhook handler. Installations without perimeter
|
|
60
|
-
protection can continue using the API's direct `/webhooks/github` endpoint.
|
|
55
|
+
Deploy the optional webhook ingress at a separate public hostname. It accepts signed GitHub deliveries at `POST /github` and forwards them to your API through a service binding. Without Access protection, use the API’s `/webhooks/github` endpoint directly.
|
|
61
56
|
|
|
62
57
|
To deploy the optional ingress:
|
|
63
58
|
|
|
@@ -87,18 +82,13 @@ To deploy the optional ingress:
|
|
|
87
82
|
ingress URL ending in `/github`. Use GitHub's test delivery and confirm a 2xx
|
|
88
83
|
response before relying on push builds.
|
|
89
84
|
|
|
90
|
-
The ingress
|
|
91
|
-
forwarding route. It does not make the GitHub integration part of the core
|
|
92
|
-
installer, provision build executors, create a GitHub App, configure Cloudflare
|
|
93
|
-
Access, or manage either Worker's secrets. Its body limit is 25 MiB, based on
|
|
94
|
-
GitHub's [documented 25 MB webhook payload cap](https://docs.github.com/en/webhooks/webhook-events-and-payloads#payload-cap);
|
|
95
|
-
malformed or larger deliveries are rejected before event processing.
|
|
85
|
+
The ingress accepts payloads up to 25 MiB. See [GitHub’s payload limit](https://docs.github.com/en/webhooks/webhook-events-and-payloads#payload-cap).
|
|
96
86
|
|
|
97
87
|
## Deploying Source Builds from CI
|
|
98
88
|
|
|
99
89
|
Build `@void/platform` from your checkout and pass its runtime directory to `install`, `upgrade`, `repair`, `enable`, or `rollback` with `--runtime`. Custom runtimes get the same integrity, migration, health, and rollback checks as packaged releases.
|
|
100
90
|
|
|
101
|
-
|
|
91
|
+
Use a clean Git checkout or set `VOID_PLATFORM_SOURCE_REVISION` to identify the revision you deploy.
|
|
102
92
|
|
|
103
93
|
A fresh CI runner can discover the installation each time. Set `CLOUDFLARE_API_TOKEN` and `VOID_PLATFORM_DATABASE_URL` through its protected environment, then:
|
|
104
94
|
|
|
@@ -35,61 +35,3 @@ workflows that call platform CI must grant `deployments: read` alongside
|
|
|
35
35
|
`contents: read`.
|
|
36
36
|
|
|
37
37
|
The upstream repository also contains workflows for deploying Void Cloud and publishing the official npm packages. Forks should configure their own release workflow around the built CLI and `platform upgrade --runtime`; the [source-build CI example](/guide/platform/development/runtime#deploying-source-builds-from-ci) shows the required inputs. Keep production credentials in protected environments restricted to the appropriate release refs.
|
|
38
|
-
|
|
39
|
-
Public releases use matching versions for the CLI, scaffolder, adapters, and
|
|
40
|
-
packaged platform. The publish workflow rejects mismatched versions and previously
|
|
41
|
-
unpublished `void` versions that npm cannot reuse. Stable versions use `latest`;
|
|
42
|
-
prereleases use their named channel, such as `beta` or `rc`. Numeric prereleases
|
|
43
|
-
use `next`. The scaffolder installs its exact matching CLI version, so
|
|
44
|
-
`create-void@beta` cannot silently select the stable CLI. Packaged platform
|
|
45
|
-
runtimes record the release commit as their source revision.
|
|
46
|
-
|
|
47
|
-
The npm release job uses [trusted publishing](https://docs.npmjs.com/trusted-publishers/)
|
|
48
|
-
from GitHub-hosted runners, with `id-token: write` and no stored npm publishing
|
|
49
|
-
token. Configure a trusted publisher for each public package using this
|
|
50
|
-
repository, `publish.yml`, and the `Release` environment, allowing direct
|
|
51
|
-
`npm publish`. A brand-new package
|
|
52
|
-
needs an initial authenticated publication before its trusted publisher can be
|
|
53
|
-
configured; subsequent releases use OIDC.
|
|
54
|
-
|
|
55
|
-
The managed build fallback CLI also derives its version from
|
|
56
|
-
`packages/void/package.json`; there are no separate version pins to update.
|
|
57
|
-
Build its image from the repository root with
|
|
58
|
-
`docker build --file platform/packages/api/container/Dockerfile .`.
|
|
59
|
-
The root `.dockerignore` limits that build context to the agent, Dockerfile,
|
|
60
|
-
and public SDK manifest.
|
|
61
|
-
|
|
62
|
-
Publishing requires both SDK CI and platform CI, including the platform unit and
|
|
63
|
-
API integration suites. Release tags also run the Windows SDK checks; a passing
|
|
64
|
-
SDK-only build cannot publish a changed control plane.
|
|
65
|
-
|
|
66
|
-
### Retrying a Release
|
|
67
|
-
|
|
68
|
-
To retry a failed release without moving an existing tag, add `+retry.N` to a
|
|
69
|
-
new Git tag, with `N` starting at `1`. Keep the package versions unchanged:
|
|
70
|
-
|
|
71
|
-
| Git tag | Package version | npm channel |
|
|
72
|
-
| ------------------------ | --------------- | ----------- |
|
|
73
|
-
| `v0.21.0` | `0.21.0` | `latest` |
|
|
74
|
-
| `v0.21.0+retry.1` | `0.21.0` | `latest` |
|
|
75
|
-
| `v0.21.0-beta.1+retry.2` | `0.21.0-beta.1` | `beta` |
|
|
76
|
-
|
|
77
|
-
For example, when the packages are at `0.21.0`, commit the release fix and tag
|
|
78
|
-
that commit:
|
|
79
|
-
|
|
80
|
-
```sh
|
|
81
|
-
git tag -a 'v0.21.0+retry.1' -m 'Retry 0.21.0 publication.'
|
|
82
|
-
git push origin 'refs/tags/v0.21.0+retry.1'
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
The retry suffix belongs only in the Git tag, not in `package.json`. A `-1`
|
|
86
|
-
suffix is a distinct prerelease version, not a retry. Tag and package versions
|
|
87
|
-
are checked before dependency installation and the full CI jobs; retries still
|
|
88
|
-
run the normal release checks.
|
|
89
|
-
|
|
90
|
-
Retries publish only package versions that are still missing from npm. They
|
|
91
|
-
cannot replace an already-published version. If an earlier attempt partially
|
|
92
|
-
published the release and you changed its package contents, bump the version
|
|
93
|
-
instead of combining different contents under the same version.
|
|
94
|
-
|
|
95
|
-
For implementation history, use the design archive at `platform/meta/design-docs/README.md`. Its proposals explain earlier decisions; the source and current guides define the supported behavior.
|
|
@@ -12,11 +12,11 @@ For a domain installation, create two custom tokens using Cloudflare's [API toke
|
|
|
12
12
|
|
|
13
13
|
For workers.dev testing with the default API hostname, browser login can authorize installation: you only need to create the runtime token and R2 credentials below. Skip the zone permissions until you add a domain.
|
|
14
14
|
|
|
15
|
-
Browser login does not grant AI Gateway access.
|
|
15
|
+
Browser login does not grant AI Gateway access. Include **Account → AI Gateway → Edit** on the runtime token so Void can verify and create that resource.
|
|
16
16
|
|
|
17
17
|
The management token lets your CLI install and maintain the platform. The runtime token is stored as a Worker secret so the platform can deploy apps after you close your terminal. They are separate credentials.
|
|
18
18
|
|
|
19
|
-
The runtime-token link preselects
|
|
19
|
+
The installer’s runtime-token link preselects required account permissions. Compare the form with the checklist shown beside the link, and select the indicated zone for a domain installation.
|
|
20
20
|
|
|
21
21
|
::: details Permissions to select for each token
|
|
22
22
|
|
|
@@ -57,13 +57,15 @@ void platform upgrade your-installation-id
|
|
|
57
57
|
|
|
58
58
|
Set the same two variables before `void platform install` to enable email during a new installation. Void records the pair for later upgrades; an ordinary upgrade cannot replace it.
|
|
59
59
|
|
|
60
|
+
Before installing, enable [Cloudflare Email Routing](https://developers.cloudflare.com/email-service/get-started/route-emails/) for the exact shared sender domain and confirm that its MX records point to Cloudflare. For a subdomain, add that name under the zone's **Email Routing → Settings → Subdomains**. Cloudflare adds the required MX and SPF records. The installer's shared-mail bootstrap verifies those records; it does not add them. Keep existing mail-provider records on other domain names in place.
|
|
61
|
+
|
|
60
62
|
Enabling email lets administrators [register email domains for projects](/guide/platform/administration/email#registering-email-domains-for-projects) and lets projects register destination addresses through the runtime token. That needs **Email Routing Addresses: Edit** and **Email Sending: Edit** on the account, plus **Zone: Read**, **Zone Settings: Edit** and **Email Routing Rules: Edit** on the zones that will carry mail. The runtime-token link preselects them when email is enabled. Email Sending onboarding for arbitrary recipients needs Workers Paid.
|
|
61
63
|
|
|
62
|
-
The installer deploys the email gateway, prepares the shared mail route, and verifies inbound readiness before opening platform traffic. If setup fails, correct the reported permission,
|
|
64
|
+
The installer deploys the email gateway, prepares the shared mail route, and verifies inbound readiness before opening platform traffic. If setup fails, correct the reported permission, exact-domain MX records, or routing conflict, then rerun the same install or upgrade command. A fresh install resumes with `void platform install --resume --name <installation-id>`; it continues the recorded email operation after the configuration is corrected.
|
|
63
65
|
|
|
64
66
|
## R2 Upload Credentials
|
|
65
67
|
|
|
66
|
-
|
|
68
|
+
In the **R2 token creation** form opened by the installer, select **Object Read & Write** and **Apply to all buckets in this account (including newly created buckets)**. Create an account token, or a user token if your role requires it. Save its **Access Key ID** and **Secret Access Key** in your password manager. These differ from the management and runtime API tokens. See [R2’s token instructions](https://developers.cloudflare.com/r2/api/tokens/).
|
|
67
69
|
|
|
68
70
|
## Signing and Encryption Keys {#signing-and-encryption-keys}
|
|
69
71
|
|