Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Every environment variable the Spree Next.js Storefront reads, with defaults and when to set it
.env.local (copy .env.example to start). Variables without a NEXT_PUBLIC_ prefix are server-side only and never reach the browser; NEXT_PUBLIC_ variables are inlined into the client bundle at build time, so only put non-secret values there.
| Variable | Description |
|---|---|
SPREE_API_URL | Your Spree API endpoint (e.g. http://localhost:3000 in dev, https://api.mystore.com in production) |
SPREE_PUBLISHABLE_KEY | Publishable API key from your Spree admin |
| Variable | Description | Default |
|---|---|---|
NEXT_PUBLIC_DEFAULT_COUNTRY | Default country ISO code — should match your store’s default_country_iso | us |
NEXT_PUBLIC_DEFAULT_LOCALE | Default locale code — should match your store’s default_locale | en |
NEXT_PUBLIC_SITE_URL | Public site URL, used for sitemap and robots.txt generation (e.g. https://mystore.com) | (required for sitemap) |
NEXT_PUBLIC_STORE_NAME | Store name used in metadata fallbacks | Spree Store |
NEXT_PUBLIC_STORE_DESCRIPTION | Store description used in metadata fallbacks | (sample text) |
| Variable | Description |
|---|---|
STORE_SEO_TITLE | Default <title> |
STORE_META_DESCRIPTION | Default meta description |
STORE_META_KEYWORDS | Default meta keywords |
STORE_TWITTER | Twitter/X handle or URL |
STORE_FACEBOOK | Facebook page URL |
STORE_INSTAGRAM | Instagram URL |
STORE_LOGO_URL | Logo URL for Organization JSON-LD |
STORE_SUPPORT_EMAIL | Customer support email |
| Variable | Description | Default |
|---|---|---|
SPREE_WHOLESALE_CHANNEL | Enable switch — the code of a gated Spree channel to bind the /wholesale surface to. Unset means DTC-only: every wholesale entry point is hidden and the routes 404 | (disabled) |
SPREE_WHOLESALE_PUBLISHABLE_KEY | Channel-scoped publishable key for the wholesale surface. Optional — the channel header selects the channel, so this falls back to SPREE_PUBLISHABLE_KEY | (falls back to SPREE_PUBLISHABLE_KEY) |
| Variable | Description | Default |
|---|---|---|
SPREE_WEBHOOK_SECRET | Webhook endpoint secret key that signs incoming Spree webhooks | (disabled) |
RESEND_API_KEY | Resend API key for sending emails in production | (dev: writes to disk) |
EMAIL_FROM | ”From” address for transactional emails (e.g. Store <orders@mystore.com>) | orders@example.com |
| Variable | Description |
|---|---|
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY | Stripe publishable key (pk_…) |
| Variable | Description | Default |
|---|---|---|
GTM_ID | Google Tag Manager container ID (e.g. GTM-XXXXXXX). Leave empty to disable | (disabled) |
| Variable | Description | Default |
|---|---|---|
SENTRY_DSN | Sentry DSN — set to enable error tracking (e.g. https://key@o0.ingest.sentry.io/0) | (disabled) |
SENTRY_ORG | Sentry organization slug (for source map uploads) | (none) |
SENTRY_PROJECT | Sentry project slug (for source map uploads) | (none) |
SENTRY_AUTH_TOKEN | Sentry auth token (for source map uploads in CI) | (none) |
SENTRY_SEND_DEFAULT_PII | Send PII (IP addresses, cookies, user data) to Sentry server-side | false |
NEXT_PUBLIC_SENTRY_SEND_DEFAULT_PII | Send PII to Sentry client-side | false |
SENTRY_SEND_DEFAULT_PII variables to true if you have appropriate user consent or a privacy policy covering this data.Was this page helpful?