Set up multiple websites or stores

Edit on GitHub
Log an Issue

You can configure Magento 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. The process to set up multiple stores depends on whether you choose to use unique domains or share the same domain.

Multiple stores with unique domains:

1
2

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

Multiple stores with the same domain:

1
2

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

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.

Configure local installation

To configure your local installation to use multiple stores, see Multiple websites or stores.

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 Magento Commerce
  2. Set up websites, stores, and store views—configure using the Magento Commerce Admin UI
  3. Modify Magento 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

Configure routes for separate domains

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

For Pro, you must create a Support ticket to set up routes in the Staging or Production environment.

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.

    1
2
3
4
5
6
7

    "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 the Set up websites, stores, and store views section.

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 allows 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 the same domain.

To configure a new web location:

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

    1
2
3
4
5
6
7
8
9

    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 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 pass is on line 21.

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

    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
          ...

  3. Continue to the Set up websites, stores, and store views section.

To configure a location with a different directory:

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

    1
2
3
4
5
6
7
8
9
10
11

    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 pass through for the index.php file.

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

    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
          ...

Set up websites, stores, and store views

In the Admin UI, set up your Magento Commerce Websites, Stores, and Store Views. See Set up multiple websites, stores, and store views in the Admin.

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 Magento variables

Instead of configuring an NGINX virtual host, pass the MAGE_RUN_CODE and MAGE_RUN_TYPE variables using the magento-vars.php file located 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 default magento-vars.php file should look like the following:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14

    <?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.

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

    <?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:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

    <?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:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

    <?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 Magento Commerce Cloud Integration environment and test your site.

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

    1

    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 Project Web Interface to push code across environments.

We recommend fully testing in the Staging environment prior to pushing to the Production environment. If you need to change code, make the changes in the Integration environment and begin the process to deploy across environments again.

© 2020 Magento. All rights reserved.