Skip to content

[web]: clarify set up & credential exposures #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gomesdigital wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[web]: clarify set up & credential exposures #596

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions packages/web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.