PHPackages magento/module-upward-connector - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. magento/module-upward-connector ActiveMagento2-module[API Development](/categories/api) magento/module-upward-connector =============================== Magento module used for routing all frontend requests through UPWARD-PHP. 2.1.6(6mo ago)24410.3k↑35.3%23[19 issues](https://github.com/magento/magento2-upward-connector/issues)[1 PRs](https://github.com/magento/magento2-upward-connector/pulls)1OSL-3.0PHPPHP ~8.2.0||~8.3.0||~8.4.0 Since Feb 20Pushed 3mo ago12 watchersCompare [ Source](https://github.com/magento/magento2-upward-connector)[ Packagist](https://packagist.org/packages/magento/module-upward-connector)[ RSS](/packages/magento-module-upward-connector/feed)WikiDiscussions develop Synced 1mo ago READMEChangelog (7)Dependencies (10)Versions (23)Used By (1) Magento 2 UPWARD connector module ================================= [](#magento-2-upward-connector-module) The Magento 2 UPWARD connector is a module for routing requests to [UPWARD-PHP](https://github.com/magento/upward-php). This module replaces the default Magento frontend theme with a PWA Studio storefront application. PWA Studio storefront deployments in the Magento Commerce Cloud use this module to keep Magento and storefront code on the same server. Installation ------------ [](#installation) The Magento 2 UPWARD connector module is part of the [Magento Cloud deployment](http://pwastudio.io/tutorials/cloud-deploy/) steps in the official PWA Studio docs. Configuration ------------- [](#configuration) The Magento 2 UPWARD connector has additional settings that can be configured in the admin area under: **Stores > Configuration > General > Web > UPWARD PWA Configuration**. ### General configuration [](#general-configuration) These are the configurations for the UPWARD process itself. #### UPWARD Config File [](#upward-config-file) This configuration is the location of the UPWARD configuration file for the UPWARD-PHP server. This module adds a new directive to the env.php to securely set the path to the upward.yaml file. ``` // ... 'downloadable_domains' => [ // ... ], # New configuration point 'pwa_path' => [ 'default' => [ 'default' => '/var/www/html/pwa/dist/upward.yml' ], 'website' => [ '' => '/var/www/html/anotherpwa/dist/upward.yml' # Can point a website to a different installation ], 'store' => [ '' => '' # Blank string (or false) to serve default Magento storefront ] ] ``` For ease of use, this module provides a new command for setting the path ``` # Set the default scope to an empty string (will serve base Magento store front) bin/magento pwa:upward:set # Set the website with code to /var/www/html/pwa/dist/upward.yml bin/magento pwa:upward:set --path /var/www/html/pwa/dist/upward.yml --scopeType website --scopeCode # Set the website with code to an empty string (will serve base Magento store front) bin/magento pwa:upward:set --scopeType website --scopeCode # Set the website with code to /var/www/html/pwa/dist/upward.yml bin/magento pwa:upward:set --path /var/www/html/pwa/dist/upward.yml --scopeType store --scopeCode ``` *You can use `bin/magento store:list` or `bin/magento store:website:list` to easily get the store/website code for configuration.* *You may use a path relative to your web root or an absolute path for the value of this configuration.* - Relative: `pwa/dist/upward.yml` - Absolute: `/var/www/html/pwa/dist/upward.yml` If you have previously configured the UPWARD yaml path using the `config:set` command or environment variables, it will continue to work as a fallback, so long as no default has been set as per the example above. The configuration works the same way normal store configurations work. It falls back from store view > website > global (default), trying to serve the more specific available scope first. #### Front Name Allowlist [](#front-name-allowlist) This configuration allows you to specify a line-separated list of routes to forward to the default Magento theme. Example: ``` contact privacy-policy-cookie-restriction-mode ``` With this example, when a visitor navigates to either `/contact` or `/privacy-policy-cookie-restriction-mode`, they will land on a page rendered by Magento instead of the storefront application. ### Prerender.io Configuration [](#prerenderio-configuration) [Prerender.io](https://docs.prerender.io/) support in the upward-connector module allows your site to send prerendered static html to search bots. A middleware layer checks each request to see if it comes from a crawler and if allowed, sends it to the prerender service. These configuration entries let you configure which pages to send to Prerender.io to serve the static HTML versions of that page. If a page is not configured for prerendering, the request continues using the normal server routes. ConfigurationDescriptionExampleEnable Prerender For Search BotsThis enables prerender functionality for this store view.Prerender URLUrl of the prerender service.Prerender.io TokenToken to use for the prenderer.io hosted serviceCrawler User AgentsLine break separated list of keywords to detect the crawler in the user-agent request headerBlocked ListResources that will not be sent for prerendering. Use `*` as a wildcard character.`.js` `*/cart`Allowed ListExplicitly allowed resources to be sent for prerendering. If empty, all resources are allowed.#### Testing prerendered pages [](#testing-prerendered-pages) To see how a crawler sees a prerendered page, set your browser's User Agent to `Googlebot` and visit your URL. You can also run this on the command line and change the sample URL to your storefront's URL: ``` curl -A Googlebot https://www.example.com/ > page.html ``` To configure prerender locally for testing purposes, see . #### Troubleshooting partial rendered pages [](#troubleshooting-partial-rendered-pages) There is no way to tell when a PWA page fully loads. For prerendering it is possible to force prerender to wait for a predefined timeout before setting the `window.prerenderReady` flag. Add the following to the runtime script: ``` window.prerenderReady = false; setTimeout(function () { window.prerenderReady = true; }, 1000 * 15); ``` For more information, see . Service Worker Note ------------------- [](#service-worker-note) Avoid sharing the same hostname between your PWA Studio storefront and the Magento 2 admin backend. This causes the storefront Service Worker to intercept backend requests when you have both the storefront and admin tabs open at the same time on your browser. If you cannot avoid sharing the hostname, access one service at a time or use a private browsing session per service. ### Health Score 60 — FairBetter than 99% of packages Maintenance60 Regular maintenance activity Popularity48 Moderate usage in the ecosystem Community27 Small or concentrated contributor base Maturity87 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~144 days Recently: every ~150 days Total 18 Last Release 187d ago Major Versions 1.3.1 → 2.0.02022-01-25 PHP version history (7 changes)1.0.0PHP ~7.1.3||~7.2.0 1.0.1PHP ~7.1.3||~7.2.0||~7.3.0 1.1.2PHP ~7.3.0||~7.4.0 2.0.1PHP ~7.4.0||~8.1.0 2.0.2PHP ~8.1.0||~8.2.0 2.0.4PHP ~8.1.0||~8.2.0||~8.3.0 2.0.5PHP ~8.2.0||~8.3.0||~8.4.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/dbcf615f9bf1c6b766e11376c5e76245da3b22bfc132da6a85c1e185f31ddd26?d=identicon)[mage2-team](/maintainers/mage2-team) --- Top Contributors [![tjwiebell](https://avatars.githubusercontent.com/u/462953?v=4)](https://github.com/tjwiebell "tjwiebell (23 commits)")[![glo82145](https://avatars.githubusercontent.com/u/97873570?v=4)](https://github.com/glo82145 "glo82145 (7 commits)")[![bbatsche](https://avatars.githubusercontent.com/u/500909?v=4)](https://github.com/bbatsche "bbatsche (3 commits)")[![jcalcaben](https://avatars.githubusercontent.com/u/4692281?v=4)](https://github.com/jcalcaben "jcalcaben (3 commits)")[![justinconabree](https://avatars.githubusercontent.com/u/68294336?v=4)](https://github.com/justinconabree "justinconabree (3 commits)")[![devpatil7](https://avatars.githubusercontent.com/u/40405790?v=4)](https://github.com/devpatil7 "devpatil7 (3 commits)")[![del22123](https://avatars.githubusercontent.com/u/181333204?v=4)](https://github.com/del22123 "del22123 (2 commits)")[![glo11372](https://avatars.githubusercontent.com/u/143005735?v=4)](https://github.com/glo11372 "glo11372 (2 commits)")[![eug123](https://avatars.githubusercontent.com/u/8600171?v=4)](https://github.com/eug123 "eug123 (1 commits)")[![mikhaelbois](https://avatars.githubusercontent.com/u/1170507?v=4)](https://github.com/mikhaelbois "mikhaelbois (1 commits)")[![supernova-at](https://avatars.githubusercontent.com/u/13182778?v=4)](https://github.com/supernova-at "supernova-at (1 commits)")[![del15881](https://avatars.githubusercontent.com/u/182603557?v=4)](https://github.com/del15881 "del15881 (1 commits)") ### Embed Badge ![Health badge](/badges/magento-module-upward-connector/health.svg) ``` [![Health](https://phpackages.com/badges/magento-module-upward-connector/health.svg)](https://phpackages.com/packages/magento-module-upward-connector) ``` ### Alternatives [smile/elasticsuite Magento 2 merchandising and search engine built on ElasticSearch 8044.5M33](/packages/smile-elasticsuite)[mollie/magento2 Mollie Payment Module for Magento 2 1121.6M10](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension Dotdigital for Magento 2 50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[swissup/module-search-mysql-legacy Legacy mysql search for magento 2.4 10483.0k](/packages/swissup-module-search-mysql-legacy)[lizardmedia/module-varnish-warmer Varnish Cache Warmer Magento2 module by Lizard Media 6276.8k](/packages/lizardmedia-module-varnish-warmer)[mage-os/module-inventory-reservations-grid Add a grid with the list of inventory reservations. 126.8k](/packages/mage-os-module-inventory-reservations-grid) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)