Skip to content

All environment variables

Generated from every template’s .env*.example. Each variable links to its entry on the template’s Environment page, which has the default, the owning feature, the template’s own comment and full notes.

VariableTemplatesIn production
API_DOC_PASSWORDreact-appNot used in production.
API_DOC_URLreact-appNot used in production: only by yarn gen.
API_DOC_USERreact-appNot used in production.
APP_ENVnest-api, nest-monorepo, node-workerproduction.
APP_HOSTnest-api, nest-monorepo0.0.0.0 in a container.
APP_NAMEnest-api, nest-monorepoYour product's display name.
BASIC_AUTH_PASSnest-api, nest-monorepoA strong password, not the example's.
BASIC_AUTH_USERnest-api, nest-monorepoA new operator username.
BETTER_AUTH_SECRETnest-api, nest-monorepoA random 32-byte value: openssl rand -base64 32.
BETTER_AUTH_URLnest-api, nest-monorepoThe API's public URL, like SERVER_HOST.
COMPANY_NAMEnext-siteThe legal or trading name.
DATABASE_URLnest-api, nest-monorepo, next-site, node-workerpostgresql://<user>:<password>@<host>:5432/<db>?sslmode=require.
DB_HOSTpy-workerThe API's database host.
DB_NAMEpy-workerThe API's database name.
DB_PASSWORDpy-workerIts password.
DB_PORTpy-worker5432.
DB_USERpy-workerA database user with access to the tables this worker uses.
FRONTEND_HOSTnest-api, nest-monorepoThe front end's origin, e.g. https://app.example.com.
GROWTHBOOK_API_HOSTnest-api, nest-monorepohttps://cdn.growthbook.io or your GrowthBook's API host.
GROWTHBOOK_CLIENT_KEYnest-api, nest-monorepoAn SDK connection's client key (sdk-…).
HEALTH_DISK_PATHnest-api, nest-monorepoThe volume to watch: /, or where logs and uploads are written.
HEALTH_DISK_THRESHOLDnest-api, nest-monorepoThe fraction of the volume that may be used, e.g. 0.9.
HEALTH_HEAP_MAX_MBnest-api, nest-monorepoBelow the container's memory limit, e.g. 75% of it.
HEALTH_RSS_MAX_MBnest-api, nest-monorepoBelow the container's memory limit.
HOME_PATHpy-worker/app in the Docker image.
LOG_LEVELnest-api, nest-monorepo, node-workerinfo.
MAIL_FROM_ADDRESSnext-siteAn address on a domain your mail provider is allowed to send for.
MAIL_FROM_NAMEnext-siteThe business's name.
MEDIA_DIRnext-siteLeave unset in the Docker image (/app/media).
MISC_CORS_ORIGINSnest-api, nest-monorepoEvery other front-end origin, comma-separated; empty for a single front end.
NEXT_PUBLIC_OPENOBSERVE_CLIENT_TOKENnext-siteA RUM client token.
NEXT_PUBLIC_OPENOBSERVE_ORGnext-siteThe project's organization identifier.
NEXT_PUBLIC_OPENOBSERVE_URLnext-siteYour OpenObserve instance.
NEXT_PUBLIC_SERVER_URLnext-siteThe site's public origin, e.g. https://example.com.
OAUTH_GOOGLE_CLIENT_IDnest-api, nest-monorepoYour Google OAuth client id.
OAUTH_GOOGLE_CLIENT_SECRETnest-api, nest-monorepoThe client's secret.
OPENOBSERVE_ORGnest-api, nest-monorepo, next-site, node-worker, py-workerThe project's organization identifier.
OPENOBSERVE_TOKENnest-api, nest-monorepo, next-site, node-worker, py-workerThe organization's ingestion token (o2oi_…).
OPENOBSERVE_URLnest-api, nest-monorepo, next-site, node-worker, py-workerYour OpenObserve instance.
OTEL_SERVICE_NAMEnest-api, nest-monorepo, next-site, node-worker, py-workerA distinct name per service: shop-api, shop-worker, shop-py.
PAYLOAD_SECRETnext-siteA long random string, different per environment.
PORTnest-api, nest-monorepo, react-app, react-monorepoThe port the process listens on (nest-api: the container's exposed port).
PREVIEW_SECRETnext-siteA random string.
RATE_LIMIT_AUTH_MAXnest-api, nest-monorepoRequests per auth window per client IP (default 100).
RATE_LIMIT_AUTH_WINDOWnest-api, nest-monorepobetter-auth's window for /auth/*, in seconds (default 10).
RATE_LIMIT_ENABLEDnest-api, nest-monorepotrue.
RATE_LIMIT_IP_HEADERSnest-api, nest-monorepoThe header your reverse proxy sets to the client's IP (x-forwarded-for, cf-connecting-ip, …).
RATE_LIMIT_MAXnest-api, nest-monorepoRequests per window per client IP on app routes (default 120).
RATE_LIMIT_TTLnest-api, nest-monorepoThe window for app routes, in milliseconds (default 60000).
REDIS_HOSTnest-api, nest-monorepo, node-worker, py-workerYour Redis host; identical on the API and every worker.
REDIS_PASSWORDnest-api, nest-monorepo, node-worker, py-workerThe Redis password.
REDIS_PORTnest-api, nest-monorepo, node-worker, py-workerYour Redis port (6379).
REDIS_USERnest-api, nest-monorepo, node-worker, py-workerAn ACL user, if your Redis uses them.
S3_ACCESS_KEY_IDnest-api, nest-monorepoAn access key for the bucket.
S3_BUCKET_NAMEnest-api, nest-monorepoThe bucket.
S3_ENDPOINTnest-api, nest-monorepoThe endpoint URL, even on AWS: https://s3.<region>.amazonaws.com.
S3_REGIONnest-api, nest-monorepoThe bucket's region.
S3_SECRET_ACCESS_KEYnest-api, nest-monorepoIts secret.
SERVER_HOSTnest-api, nest-monorepoThe API's public URL, e.g. https://api.example.com.
SITE_NAMEnext-siteThe business's display name.
SMTP_FROMnest-api, nest-monorepoName <no-reply@your-domain>, on a domain with SPF, DKIM and DMARC.
SMTP_HOSTnest-api, nest-monorepo, next-siteYour mail provider's SMTP host.
SMTP_PASSnext-siteThe SMTP password.
SMTP_PASSWORDnest-api, nest-monorepoThe SMTP password or API key.
SMTP_PORTnest-api, nest-monorepo, next-site465 or 587.
SMTP_SECUREnest-api, nest-monorepotrue with 465, false with 587 (STARTTLS).
SMTP_SUPPORT_EMAILnest-api, nest-monorepoYour support address.
SMTP_USERnest-api, nest-monorepo, next-siteThe SMTP username.
SUPERUSER_EMAILnest-api, nest-monorepoThe first admin's address.
SUPERUSER_PASSWORDnest-api, nest-monorepoA strong password, changed after first sign-in.
TEMPORAL_ADDRESSnest-api, nest-monorepo, node-worker, py-workerYour Temporal frontend, e.g. temporal-grpc.example.com:7233.
TEMPORAL_NAMESPACEnest-api, nest-monorepo, node-worker, py-workerThe project's namespace, the same on the API and its workers.
TEMPORAL_TASK_QUEUEnest-api, nest-monorepo, node-worker, py-workerThe queue a worker polls.
TEMPORAL_TLS_CAnest-api, nest-monorepo, node-worker, py-workerThe CA that signed the server's certificate, as PEM; empty if it's publicly trusted.
TEMPORAL_TLS_CERTnest-api, nest-monorepo, node-worker, py-workerThe project's client certificate, as PEM.
TEMPORAL_TLS_KEYnest-api, nest-monorepo, node-worker, py-workerThe client certificate's private key, as PEM.
VITE_APP_ADMIN_HOSTreact-monorepoThe admin app's origin, e.g. https://admin.example.com.
VITE_APP_ALLOWED_HOSTSreact-appNot used in production.
VITE_APP_API_URLreact-app, react-monorepoThe API's public URL, as a build argument.
VITE_APP_AUTH_HOSTreact-monorepoThe auth app's origin, e.g. https://auth.example.com.
VITE_APP_CLIENT_HOSTreact-monorepoThe client app's origin, e.g. https://app.example.com.
VITE_APP_LANDINGreact-monorepoThe landing site's origin, e.g. https://example.com, as a build argument.
VITE_APP_SITE_URLreact-app, react-monorepoThe canonical public origin, as a build argument.
VITE_APP_SUPPORT_EMAILreact-app, react-monorepoA monitored security and support address, as a build argument.
VITE_OPENOBSERVE_CLIENT_TOKENreact-app, react-monorepoA RUM token, as a build argument.
VITE_OPENOBSERVE_ORGreact-app, react-monorepoThe project's organization identifier, as a build argument.
VITE_OPENOBSERVE_URLreact-app, react-monorepoYour OpenObserve instance, as a build argument.