ÃÛ¶¹ÊÓƵ

DocumentationCommerceCommerce on Cloud Infrastructure Guide

Set up multiple websites or stores

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

You can configure ÃÛ¶¹ÊÓƵ Commerce to have multiple websites or stores, such as an English store, a French store, and a German store. See Understanding websites, stores, and store views.

WARNING
Catalog data expands as you increase the number of websites and stores. Depending on your project architecture, the additional stores can lead to a longer indexing process and slower response times for non-cached catalog pages. ÃÛ¶¹ÊÓƵ recommends that you monitor site performance closely.

The process to set up multiple stores depends on whether you choose to use unique or shared domains.

Multiple stores with unique domains:

https://first.store.com/
https://second.store.com/

Multiple stores with the same domain:

https://store.com/first/
https://store.com/second/
TIP
To add a store view to the site base URL, you do not have to create multiple directories. See Add the store code to the base URL in the Configuration Guide.

Add Domains

Custom domains can be added to Pro Staging and any Production environment; they cannot be added to integration environments.

The process to add a domain depends on the type of Cloud account:

Configure local installation

To configure your local installation to use multiple stores, see Multiple websites or stores in the Configuration Guide.

After successfully creating and testing the local installation to use multiple stores, you must prepare your integration environment:

  1. Configure routes or locations—specify how incoming URLs are handled by ÃÛ¶¹ÊÓƵ Commerce

  2. Set up websites, stores, and store views—configure using the ÃÛ¶¹ÊÓƵ Commerce Admin UI

  3. Modify variables—specify the values of the MAGE_RUN_TYPE and MAGE_RUN_CODE variables in the magento-vars.php file

  4. Deploy and test environments—deploy and test the integration branch

TIP
You can use a local environment to set up multiple websites or stores. See the Cloud Docker instructions to .

Configuration updates to Pro environments

WARNING
Some Pro projects require a support ticket to update the route configuration in the routes.yaml file and the cron configuration in the .magento.app.yaml file. ÃÛ¶¹ÊÓƵ recommends updating and testing YAML configuration files in an Integration environment, then deploying changes to the Staging environment. If your changes are not applied to Staging sites after you redeploy and there are no related error messages in the log, then you MUST Submit an ÃÛ¶¹ÊÓƵ Commerce Support ticket that describes the attempted configuration changes. Include any updated YAML configuration files in the ticket.

Configure routes for separate domains

Routes define how to process incoming URLs. Multiple stores with unique domains require you to define each domain in the routes.yaml file. The way you configure routes depends on how you want your site to operate.

To configure routes in an integration environment:

  1. On your local workstation, open the .magento/routes.yaml file in a text editor.

  2. Define the domain and subdomains. The mymagento upstream value is the same value as the name property in the .magento.app.yaml file.

    code language-yaml 
    "http://{default}/":
    type: upstream
    upstream: "mymagento:http"

"http://<second-site>.{default}/":
    type: upstream
    upstream: "mymagento:http"

  3. Save your changes to the routes.yaml file.

  4. Continue to Set up websites, stores, and store views.

Configure locations for shared domains

Where the routes configuration defines how the URLs are processed, the web property in the .magento.app.yaml file defines how your application is exposed to the web. Web locations allow more granularity for incoming requests. For example, if your domain is store.com, you can use /first (default site) and /second for requests to two different stores that share a domain.

To configure a new web location:

  1. Create an alias for the root (/). In this example, the alias is &app on line 3.

    code language-yaml 
    web:
    locations:
        "/": &app
            # The public directory of the app, relative to its root.
            root: "pub"
            passthru: "/index.php"
            index:
            - index.php
            ...

  2. Create a pass-through for the website (/website) and reference the root using the alias from the previous step.

    The alias allows website to access values from the root location. In this example, the website passthru is on line 21.

    code language-yaml 
    web:
    locations:
        "/": &app
            # The public directory of the app, relative to its root.
            root: "pub"
            passthru: "/index.php"
            index:
            - index.php
            ...
        "/media":
            root: "pub/media"
            ...
        "/static":
            root: "pub/static"
            allow: true
            scripts: false
            passthru: "/front-static.php"
            rules:
                ^/static/version\d+/(?<resource>.*)$:
                    passthru: "/static/$resource"
        "/<website>": *app
          ...

To configure a location with a different directory:

  1. Create an alias for the root (/) and for the static (/static) locations.

    code language-yaml 
    web:
    locations:
        "/": &root
            # The public directory of the app, relative to its root.
            root: "pub"
            passthru: "/index.php"
            index:
            - index.php
            ...
        "/static": &static
            root: "pub/static"

  2. Create a subdirectory for the website under the pub directory: pub/<website>

  3. Copy the pub/index.php file into the pub/<website> directory and update the bootstrap path (/../../app/bootstrap.php).

    code language-none 
    try {
    require __DIR__ . '/../../app/bootstrap.php';
} catch (\Exception $e) {

  4. Create a pass-through for the index.php file.

    code language-yaml 
    web:
    locations:
        "/": &root
            # The public directory of the app, relative to its root.
            root: "pub"
            passthru: "/index.php"
            index:
            - index.php
            ...
        "/media":
            root: "pub/media"
            ...
        "/static": &static
            root: "pub/static"
            allow: true
            scripts: false
            passthru: "/front-static.php"
            rules:
                ^/static/version\d+/(?<resource>.*)$:
                    passthru: "/static/$resource"
        "/<website>":
            <<: *root
            passthru: "<website>/index.php"
        "/<website>/static": *static
          ...

  5. Commit and push the changed files.

    • pub/<website>/index.php (If this file is in .gitignore, the push may require the force option.)
    • .magento.app.yaml

Set up websites, stores, and store views

In the Admin UI, set up your ÃÛ¶¹ÊÓƵ Commerce Websites, Stores, and Store Views. See Set up multiple websites, stores, and store views in the Admin in the Configuration Guide.

It is important to use the same name and Code of your websites, stores, and store views from your Admin when you set up your local installation. You need these values when you update the magento-vars.php file.

Modify variables

Instead of configuring an NGINX virtual host, pass the MAGE_RUN_CODE and MAGE_RUN_TYPE variables using the magento-vars.php file in your project root directory.

To pass variables using the magento-vars.php file:

  1. Open the magento-vars.php file in a text editor.

    The should look like the following:

    code language-php 
    <?php
// enable, adjust and copy this code for each store you run
// Store #0, default one
//if (isHttpHost("example.com")) {
//    $_SERVER["MAGE_RUN_CODE"] = "default";
//    $_SERVER["MAGE_RUN_TYPE"] = "store";
//}
function isHttpHost($host)
{
    if (!isset($_SERVER['HTTP_HOST'])) {
        return false;
    }
    return $_SERVER['HTTP_HOST'] === $host;
}

  2. Move the commented if block so that it is after the function block and no longer commented.

    code language-php 
    <?php
// enable, adjust and copy this code for each store you run
// Store #0, default one

function isHttpHost($host)
{
    if (!isset($_SERVER['HTTP_HOST'])) {
        return false;
    }
    return $_SERVER['HTTP_HOST'] ===  $host;
}

if (isHttpHost("example.com")) {
    $_SERVER["MAGE_RUN_CODE"] = "default";
    $_SERVER["MAGE_RUN_TYPE"] = "store";
}

  3. Replace the following values in the if (isHttpHost("example.com")) block:

    • example.com—with the base URL of your website

    • default—with the unique CODE for your website or store view

    • store—with one of the following values:

      • website—load the website in the storefront
      • store—load a store view in the storefront

    For multiple sites using unique domains:

    code language-php 
    <?php
function isHttpHost($host)
{
    if (!isset($_SERVER['HTTP_HOST'])) {
    return false;
    }
    return $_SERVER['HTTP_HOST'] ===  $host;
}

if (isHttpHost("second.store.com")) {
    $_SERVER["MAGE_RUN_CODE"] = "<second-site>";
    $_SERVER["MAGE_RUN_TYPE"] = "website";
}elseif (isHttpHost("store.com")){
    $_SERVER["MAGE_RUN_CODE"] = "base";
    $_SERVER["MAGE_RUN_TYPE"] = "website";
}

    For multiple sites with the same domain, you have to check the host and the URI:

    code language-php 
    <?php
function isHttpHost($host)
{
    if (!isset($_SERVER['HTTP_HOST'])) {
    return false;
    }
    return $_SERVER['HTTP_HOST'] ===  $host;
}

if (isHttpHost("store.com")) {
   $code = "base";
   $type = "website";

   $uri = explode('/', $_SERVER['REQUEST_URI']);
   if (isset($uri[1]) && $uri[1] == 'second') {
     $code = '<second-site>';
     $type = 'website';
   }
   $_SERVER["MAGE_RUN_CODE"] = $code;
   $_SERVER["MAGE_RUN_TYPE"] = $type;
}

  4. Save your changes to the magento-vars.php file.

Deploy and test on the integration server

Push your changes to your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure integration environment and test your site.

  1. Add, commit, and push code changes to the remote branch.

    code language-bash 
    git add -A && git commit -m "Implement multiple sites" && git push origin <branch-name>

  2. Wait for deployment to complete.

  3. After deployment, open your Store URL in a web browser.

    With a unique domain, use the format: http://<magento-run-code>.<site-URL>

    For example, http://french.master-name-projectID.us.magentosite.cloud/

    With a shared domain, use the format: http://<site-URL>/<magento-run-code>

    For example, http://master-name-projectID.us.magentosite.cloud/french/

  4. Test your site thoroughly and merge the code to the integration branch for further deployment.

Deploy to Staging and Production

Follow the deployment process for deploying to Staging and Production. For Starter and Pro environments, you use the Cloud Console to push code across environments.

ÃÛ¶¹ÊÓƵ recommends fully testing in the Staging environment before pushing to the Production environment. Make code changes in the integration environment and begin the process to deploy across environments again.

recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26