For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
      • Getting Started
        • Overview
          • Overview
          • Vercel
    • Archive
    • Closed Beta Programs
Dev Portal
LogoLogo
On this page
  • Environment Variables
DocsStorefrontCatalystDeployment

Deploying a Catalyst storefront

Was this page helpful?
Previous

Caching

Next

Vercel

Built with

The Catalyst engineering team tests Catalyst against Vercel in normal development, but Catalyst is a standard Next.js application which can be hosted on most infrastructure providers that support Next.js. Consider the Next.js documentation or your hosting provider’s documentation for guidance on how to deploy to your provider of choice.

Catalyst depends on the following Next.js features which must be supported by your hosting provider:

  • Incremental Static Regeneration (ISR)
  • Data Cache
  • Partial Prerendering (PPR)
  • Middleware

Environment Variables

Regardless of where or how you deploy your Catalyst application, you’ll need to get an updated set of environment variables to use. Assuming you’ve already run your application locally (follow the Local Development guide for details), you can use the majority of the environment variables defined in your env.local file.

However, there are a couple of environment variables that need to be updated. Make sure to check the documentation for each one on how to update them accordingly.

  • AUTH_SECRET
  • BIGCOMMERCE_STOREFRONT_TOKEN
  • MAKESWIFT_SITE_API_KEY
  • TURBO_REMOTE_CACHE_SIGNATURE_KEY

For a full list of environment variables, refer to the environment variables documentation.