From 23db22d5950ff3a6ff78d2d8f3415cc6a2e34c42 Mon Sep 17 00:00:00 2001 From: gomesdigital Date: Wed, 10 Dec 2025 12:40:41 +0200 Subject: [PATCH] [web]: clarify set up & credential exposures --- packages/web/README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/packages/web/README.md b/packages/web/README.md index 5bb2973e1..7c306b2f7 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -10,6 +10,20 @@ deploying it like any other NextJS app. For API calls to work, you'll need to pass the same environment variables to the NextJS app that are used by the Workflow CLI. See `npx workflow inspect --help` for more information on the available environment variables. -If you're deploying this to Vercel, setting `WORKFLOW_TARGET_WORLD` to `vercel` is enough -to infer your other project details. Note that observability will be scoped to the project + +If you're deploying to Vercel: +1. Set the project root directory to `packages/web` +1. Fill in environment variables in the Vercel UI +1. Ensure `WORKFLOW_TARGET_WORLD` is to `vercel` + +The UI will not connect to your backend by default. + +4. In the UI, go Settings -> Configuration -> Backend -> select `vercel`. + +Once the backend is set, the rest of the env vars will be inferred. + +> [!NOTE] +> Setting any of the fields via the UI's configuration tab will append them as query params in the URL, which risks exposing your credentials when operating over the internet. If your env vars are set, you **only** need to set the `Backend` field in the UI. + +Note that observability will be scoped to the project and environment you're deploying to.