@magento/pwa-buildpack

{ "sections": [ { "name": "Connecting to a Magento store", "variables": [ { "name": "MAGENTO_BACKEND_URL", "type": "url", "desc": "Connect to an instance of Magento by specifying its public domain name.", "example": "https://master-7rqtwti-c5v7sxvquxwl4.eu-4.magentosite.cloud/" } ] }, { "name": "Magento Store Edition", "variables": [ { "name": "MAGENTO_BACKEND_EDITION", "type": "str", "desc": "Specify the edition of the magento store (Adobe Commerce or Magento Open Source). Can be one of MOS or AC.", "example": "AC", "default": "AC" } ] }, { "name": "Magento Store View", "variables": [ { "name": "STORE_VIEW_CODE", "type": "str", "desc": "Specify the Magento store view code set in Stores > Settings > All Stores > Store View name", "default": "" }, { "name": "USE_STORE_CODE_IN_URL", "type": "bool", "desc": "Includes the store code in the store URLs if value is true.", "default": false } ] }, { "name": "Image Optimizing Origin", "variables": [ { "name": "IMAGE_OPTIMIZING_ORIGIN", "type": "str", "choices": ["backend", "onboard", "auto"], "desc": "Specify the origin to use for images in the UI. Set to `backend` when Fastly or another CDN is optimizing images, and the frontend will load images directly from the Magento instance at MAGENTO_BACKEND_URL. To force usage of the onboard image optimizer, set to `onboard`. Set to `auto` to autodetect whether the backend is using FastlyIO and optimize onboard only if it needs to.", "default": "auto" } ] }, { "name": "Default Country", "variables": [ { "name": "DEFAULT_COUNTRY_CODE", "type": "str", "desc": "Specify the default country to be selected in forms containing country field such as address books and shipping information forms.", "default": "US" } ] }, { "name": "Custom local origin", "variables": [ { "name": "CUSTOM_ORIGIN_ENABLED", "type": "bool", "desc": "Get or create a secure, unique hostname/port combination and a trusted SSL certificate for local development.", "default": true }, { "name": "CUSTOM_ORIGIN_ADD_UNIQUE_HASH", "type": "bool", "desc": "Add a unique hash string to the custom origin, based on filesystem location. This naturally separates domains when running multiple project folders on one developer machine.", "default": true }, { "name": "CUSTOM_ORIGIN_SUBDOMAIN", "type": "str", "desc": "Specify the subdomain prefix of the custom origin manually, instead of using the package name.", "default": "" }, { "name": "CUSTOM_ORIGIN_EXACT_DOMAIN", "type": "str", "desc": "Specify the exact domain of the custom origin manually.", "default": "" } ] }, { "name": "Development server", "variables": [ { "name": "DEV_SERVER_HOST", "type": "str", "desc": "Specify the hostname the dev server should bind to. If this is set, it overrides the host chosen by custom origin settings.", "default": "" }, { "name": "DEV_SERVER_PORT", "type": "num", "desc": "Specify the port the dev server should bind to. If this is set, it overrides the port chosen by custom origin settings.", "default": 0 }, { "name": "DEV_SERVER_SERVICE_WORKER_ENABLED", "type": "bool", "desc": "Use a service worker in developer mode (PWADevServer), which are disabled in dev mode normally to simplify cache. Good for debugging.", "default": false }, { "name": "DEV_SERVER_WATCH_OPTIONS_USE_POLLING", "type": "num", "desc": "Set to a number greater than 0 to denote a polling interval in milliseconds. If this is greater than 0, the dev server will use filesystem polling instead of native filesystem events to watch for changes. Can increase CPU usage, but sometimes is the best option for exotic filesystems (e.g. NFS).", "default": 0 } ] }, { "name": "Staging server", "variables": [ { "name": "STAGING_SERVER_HOST", "type": "str", "desc": "Specify the hostname the staging server should bind to. If this is set, it overrides the host chosen by custom origin settings.", "default": "" }, { "name": "STAGING_SERVER_PORT", "type": "num", "desc": "Specify the port the staging server should bind to. If this is set, it overrides the port chosen by custom origin settings.", "default": 0 }, { "name": "STAGING_BUILD_ID", "type": "str", "desc": "Specify the id which Buildpack will put in a comment above all generated bundle files and the index.html file", "default": "" } ] }, { "name": "Onboard image optimization service", "variables": [ { "name": "IMAGE_SERVICE_CACHE_EXPIRES", "type": "str", "desc": "Lifetime of images in the local cache of resized images. Format is \"[length] [unit]\", as in \"10 minutes\" or \"1 day\".", "example": "5 minutes", "default": "1 hour" }, { "name": "IMAGE_SERVICE_CACHE_DEBUG", "type": "bool", "desc": "Log image cache debug info to the console.", "default": false } ] }, { "name": "UPWARD server settings", "variables": [ { "name": "UPWARD_JS_UPWARD_PATH", "type": "str", "desc": "UPWARD configuration file to use for the PWADevServer and the \"stage:venia\" sample server.", "default": "upward.yml" }, { "name": "UPWARD_JS_BIND_LOCAL", "type": "bool", "desc": "Upon launching the staging server, automatically attach to a local port and listen.", "default": true }, { "name": "UPWARD_JS_LOG_URL", "type": "bool", "desc": "Log the bound URL to stdout once the sever is listening. Useful in testing and discovery scenarios, but may be disabled in production.", "default": true } ] }, { "name": "Checkout and payment settings", "variables": [ { "name": "CHECKOUT_BRAINTREE_TOKEN", "type": "str", "desc": "Specify a Braintree API token to direct the Venia storefront to communicate with your Braintree instance. You can find this value in Braintree's Control Panel under Settings > API Keys > Tokenization Keys.", "example": "sandbox_8yrzsvtm_s2bg8fs563crhqzk" } ] }, { "name": "BuildBus and targets", "variables": [ { "name": "BUILDBUS_DEPS_ADDITIONAL", "type": "str", "desc": "A list of resolvable NPM modules that BuildBus will scan for targets, in addition to those declared in project `dependencies` and `devDependencies`.", "default": "" } ] }, { "name": "Custom HTTPS certificates", "variables": [ { "name": "CUSTOM_HTTPS_KEY", "type": "str", "desc": "Absolute path to the custom HTTPS certificate key file.", "default": "" }, { "name": "CUSTOM_HTTPS_CERT", "type": "str", "desc": "Absolute path to the custom HTTPS certificate cert file.", "default": "" } ] }, { "name": "Express compression settings", "variables": [ { "name": "ENABLE_EXPRESS_SERVER_COMPRESSION", "type": "bool", "desc": "Specify if express server compression needs to be enabled. Defaults to false if not provided.", "default": false } ] } ], "changes": [] }