Skip to content
Sapporta

Environment variables

View as Markdown

Identity

Section titled “Identity”

Generated API env parser, Vite build environment, and Sapporta CLI runtime.

Contract

Section titled “Contract”
  • NODE_ENV=production requires verified email by default. Other values leave verification optional by default.
  • SAPPORTA_PUBLIC_APP_URL is the browser-facing origin used for auth links, callbacks, and default trust.
  • SAPPORTA_FRONTEND_ORIGINS adds exact credentialed browser origins.
  • SAPPORTA_REQUIRE_VERIFIED_EMAIL=true or false explicitly overrides the environment-based email-verification default. An empty or absent value uses the NODE_ENV policy.
  • SAPPORTA_HEALTH_POLICY configures health behavior.
  • SAPPORTA_OPENAPI_POLICY accepts public, authenticated, or disabled, and sets who may read the application contract at /api/openapi.json. An absent value means authenticated. The generated .env.development sets public, so sapporta endpoints list and endpoints show work against a local development server with no access token. Deployments leave it unset or set authenticated, and endpoint discovery there needs a token.
  • SAPPORTA_MAIL_TRANSPORT accepts stream, smtp, or disabled; SAPPORTA_MAIL_FROM supplies the sender.
  • SAPPORTA_ALLOW_SAMPLE_DATA_SEEDING=true permits pnpm seed to create the sample-data account named in packages/api/seed.ts, and it also requires NODE_ENV to be anything other than production. The generated .env.development sets it. The permission is granted rather than merely not withheld: an environment that never heard of the setting is refused, so a staging box, a systemd unit, or CI against a restored snapshot is not taken for a developer’s machine. The account’s password is written in the source, so no deployment carries this setting.
  • VITE_API_URL is public build-time configuration for a split API origin.
  • SAPPORTA_API_URL, SAPPORTA_API_TOKEN, and SAPPORTA_OUTPUT_FORMAT configure CLI calls.
  • SAPPORTA_API_PORT selects the API listener port. Hosting-platform PORT is accepted when it is absent; both values must match when set together. The API defaults to 3000 when neither is set.
  • SAPPORTA_FRONTEND_PORT selects the Vite development port.
  • sapporta init picks both development ports for the new project and writes them into .env.development, so that several Sapporta projects run on one machine without being reconfigured. A generated project’s development ports are therefore per-project, not the defaults above. pnpm dev prints both as URLs when it starts.

SAPPORTA_REQUIRE_VERIFIED_EMAIL accepts only the literal values true and false when set.

Section titled “Related documentation”