Environment variables

Vite embeds VITE_* values in the browser bundle. Set private keys on the intended Convex deployment.

Frontend build values

Variable	Purpose
`VITE_CONVEX_URL`	Convex client URL, such as `https://your-deployment.convex.cloud`; the static uploader supplies it with `--build`
`VITE_WORKOS_CLIENT_ID`	Public WorkOS client ID matching backend `WORKOS_CLIENT_ID`
`VITE_REDIRECT_URI`	Optional exact callback; defaults to the current origin plus `/callback`
`VITE_API_URL`	Optional HTTP/plugin URL for custom-domain setups

VITE_CONVEX_URL=https://your-deployment.convex.cloud
VITE_WORKOS_CLIENT_ID=client_your_client_id
VITE_REDIRECT_URI=http://localhost:5173/callback

For local development on either supported Vite port, omit VITE_REDIRECT_URI to derive the callback from the current origin. Use .env.local locally and .env.production.local for your production build. Rebuild and upload after changing a frontend value. Do not commit these local files.

Backend values

Select development or production in the Convex dashboard before setting values.

Variable	Purpose
`WORKOS_CLIENT_ID`	JWT validation for your WorkOS application
`WORKOS_API_KEY`	Private server-side WorkOS operations
`OPENAI_API_KEY`	Optional embeddings and semantic search
`SITE_URL`	Canonical frontend URL for app links
`RESEND_API_KEY`	Optional private app-email API key
`RESEND_WEBHOOK_SECRET`	Optional signature verification for `/resend-webhook`
`RESEND_FROM_EMAIL`	Verified sender for app email
`RESEND_TEST_MODE`	Keep `true` while configuring email; admin sends are blocked
`EMAIL_POSTAL_ADDRESS`	Mailing-address line used in email footers; edit here, not in templates

Never put API keys or webhook secrets into VITE_* variables. The current browser AuthKit integration does not use WORKOS_COOKIE_PASSWORD.

Custom-domain roles

Hosted OpenSync uses https://app.opensync.dev for its Convex client and https://api.opensync.dev for HTTP/plugin requests. The dashboard is https://www.opensync.dev. After verifying custom domains in Convex, its Override Environment Variables settings can make CONVEX_CLOUD_URL use the client domain and CONVEX_SITE_URL use the HTTP domain. Those are platform variables, not frontend build settings. Forks must use their own deployments and domains.

Getting Started

Dashboard

Plugins

API Reference

Search

Authentication

Hosting & Deploy

Fork & Self-Host

Troubleshooting

Environment variables

Environment variables

Frontend build values

Backend values

Custom-domain roles

​Environment variables

​Frontend build values

​Backend values

​Custom-domain roles

​Related

Environment variables

Frontend build values

Backend values

Custom-domain roles

Related