> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Magento

> Install and configure the Mention Me plugin for Magento 2, including referrer, referee, landing page, and dashboard tags.

For Magento stores serving multiple languages or currencies, we recommend the standard tag integration using [Google Tag Manager](/knowledge/tags/google-tag-manager).

The Magento plugin lets you install via GitHub and enable Mention Me tags from within your Magento account. You can choose from default tag positions or manually select where tags load, and preview how they appear.

<Note>The plugin is compatible with Magento 2.1.18, 2.2.9, 2.3.x</Note>

## Installing the module

### Via Composer (recommended)

Add the GitHub repository as a Composer source:

```bash theme={null}
composer config repositories.mentionme vcs https://github.com/mention-me/magento2-integration
```

Add the dependency:

```bash theme={null}
composer require mentionme/module-mention-me --no-update
```

Update dependencies:

```bash theme={null}
composer update mentionme/module-mention-me
```

Enable the module and refresh cache:

```bash theme={null}
php bin/magento module:enable MentionMe_MentionMe
php bin/magento setup:upgrade
php bin/magento cache:flush
```

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/GitHub_-_mention-me_magento2-integration__MentionME_extension_for_Magento2.jpg?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=0fefd65b69b8842caf8bd7704b86a5b0" alt="GitHub Magento2 Mention Me Integration" width="906" height="572" data-path="images/knowledge/GitHub_-_mention-me_magento2-integration__MentionME_extension_for_Magento2.jpg" />](https://github.com/mention-me/magento2-integration)

### Via FTP (manual)

<Steps>
  <Step title="Download the ZIP">
    From GitHub, click "clone or download" > "Download ZIP".
  </Step>

  <Step title="Copy files">
    Copy the `app` folder from the ZIP archive to your Magento root directory.
  </Step>

  <Step title="Enable the module and refresh cache">
    ```bash theme={null}
    php bin/magento module:enable MentionMe_MentionMe
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    ```
  </Step>
</Steps>

<Note>If you're running PHP OPcache that doesn't clear automatically, you must clear it for the new module to be available.</Note>

## Configuring the integration

Navigate to **Stores > Configuration > Mention Me** and add your Merchant Partner Code in the General configuration section.

<Frame caption="General configuration with Partner Code">
  <img src="https://mintcdn.com/mentionme/CnDLFo2wevUDbm0K/images/knowledge/integrations/ecommerce/360008603197.jpg?fit=max&auto=format&n=CnDLFo2wevUDbm0K&q=85&s=61e9ce6e50e5a70cd9567059d9958997" alt="Magento Mention Me general configuration with Partner Code" width="1094" height="380" data-path="images/knowledge/integrations/ecommerce/360008603197.jpg" />
</Frame>

### Referrer

Automatically enabled. Fields populated on order: firstname, surname, customer email, order\_number, order\_total (net), order\_currency, locale.

<Frame caption="Referrer tag configuration">
  <img src="https://mintcdn.com/mentionme/CnDLFo2wevUDbm0K/images/knowledge/integrations/ecommerce/360008681278.jpg?fit=max&auto=format&n=CnDLFo2wevUDbm0K&q=85&s=8296afc565bc28036e0c5e870562f9f1" alt="Magento referrer tag configuration" width="2040" height="371" data-path="images/knowledge/integrations/ecommerce/360008681278.jpg" />
</Frame>

### Referee

Automatically enabled. Select the tag position from the "Position on Page" dropdown, or choose manual placement for custom themes (insert the MM wrapper in your template).

<Frame caption="Referee tag configuration with position dropdown">
  <img src="https://mintcdn.com/mentionme/CnDLFo2wevUDbm0K/images/knowledge/integrations/ecommerce/360008603277.jpg?fit=max&auto=format&n=CnDLFo2wevUDbm0K&q=85&s=9161e4c47ce074d79588ecf4e4f22b59" alt="Magento referee tag configuration with position dropdown" width="2029" height="737" data-path="images/knowledge/integrations/ecommerce/360008603277.jpg" />
</Frame>

### Landing page

Automatically enabled as a Magento widget. Manage and place using Magento's widget system:

<Steps>
  <Step title="Open Widgets">
    Go to **Content > Widgets**.
  </Step>

  <Step title="Add Widget">
    Click **Add Widget**.
  </Step>

  <Step title="Select widget type">
    Select **MentionMe Landing Page** as the type and your theme. Click **Continue**.
  </Step>

  <Step title="Configure widget">
    Give the widget a title and select stores to trigger.
  </Step>

  <Step title="Set situation param">
    Under **Widget Options**, specify the situation param.
  </Step>

  <Step title="Choose layout">
    Use **Layout Update** to select the CMS page/container.
  </Step>

  <Step title="Share URL with Mention Me">
    Send the full landing page URL to your Mention Me Onboarding Manager.
  </Step>
</Steps>

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69818705-49245900-11f5-11ea-80dd-6a9c54cb4c52.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=95b11286de5bef4a86b656d4a759713d" alt="Landing page widget configuration" width="2074" height="262" data-path="images/knowledge/69818705-49245900-11f5-11ea-80dd-6a9c54cb4c52.png" />](/images/knowledge/69818705-49245900-11f5-11ea-80dd-6a9c54cb4c52.png)

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/74347960-d36a6b00-4da9-11ea-91a8-3ea285374da9.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=25b635039e776b50783f0a7d6a0b6b68" alt="Landing page example" width="1865" height="1025" data-path="images/knowledge/74347960-d36a6b00-4da9-11ea-91a8-3ea285374da9.png" />](/images/knowledge/74347960-d36a6b00-4da9-11ea-91a8-3ea285374da9.png)

### Dashboard

Automatically enabled.

<Frame caption="Dashboard tag configuration">
  <img src="https://mintcdn.com/mentionme/CnDLFo2wevUDbm0K/images/knowledge/integrations/ecommerce/360008603237.jpg?fit=max&auto=format&n=CnDLFo2wevUDbm0K&q=85&s=21fc022114e5e5d38484aedf95c96308" alt="Magento dashboard tag configuration" width="1093" height="264" data-path="images/knowledge/integrations/ecommerce/360008603237.jpg" />
</Frame>

### Conversion message (homepage and product)

Automatically enabled. Select the position, or manually place the tag for custom themes.

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69818706-49245900-11f5-11ea-9661-e27f199cd6fd.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=414dfd03ea814e7f2a04ebe0deba7cbb" alt="Conversion message tag options" width="2080" height="780" data-path="images/knowledge/69818706-49245900-11f5-11ea-9661-e27f199cd6fd.png" />](/images/knowledge/69818706-49245900-11f5-11ea-9661-e27f199cd6fd.png)

## Saving and viewing the configuration

After placing tags or widgets, save config and flush cache. Click **Customer View** to preview how tags look for your customers.

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69820790-d669ac80-11f9-11ea-94af-6f2ff5f35680.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=4ea03720592dde856d9918e63d1ef0f9" alt="Saving configuration" width="3040" height="1894" data-path="images/knowledge/69820790-d669ac80-11f9-11ea-94af-6f2ff5f35680.png" />](/images/knowledge/69820790-d669ac80-11f9-11ea-94af-6f2ff5f35680.png)

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69820789-d669ac80-11f9-11ea-8406-e0eba80af3ab.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=a3c22441af02f9bb4f57171c0e41bb5f" alt="Customer View preview" width="3042" height="1874" data-path="images/knowledge/69820789-d669ac80-11f9-11ea-8406-e0eba80af3ab.png" />](/images/knowledge/69820789-d669ac80-11f9-11ea-8406-e0eba80af3ab.png)

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69821094-97882680-11fa-11ea-9a2a-c58d19496506.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=ad2af3e00fdf027f80d0ec2ab1f1cb9f" alt="Live site preview" width="2790" height="334" data-path="images/knowledge/69821094-97882680-11fa-11ea-9a2a-c58d19496506.png" />](/images/knowledge/69821094-97882680-11fa-11ea-9a2a-c58d19496506.png)

[<img src="https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/images/knowledge/69821093-97882680-11fa-11ea-972a-5b54c24cefee.png?fit=max&auto=format&n=Dcv4Ct-ZIyuK4Pcd&q=85&s=fa817e7d16aa918cccf69fd88a8fc710" alt="Tag positions preview" width="2552" height="1946" data-path="images/knowledge/69821093-97882680-11fa-11ea-972a-5b54c24cefee.png" />](/images/knowledge/69821093-97882680-11fa-11ea-972a-5b54c24cefee.png)

## Upgrading the module

### Via Composer

```bash theme={null}
composer require mentionme/module-mention-me --no-update
composer update mentionme/module-mention-me
php bin/magento setup:upgrade
php bin/magento cache:flush
```

### Via FTP (manual)

<Steps>
  <Step title="Replace existing files">
    Download latest ZIP and remove existing `app/code/MentionMe` directory.
  </Step>

  <Step title="Copy new files">
    Copy new `app` folder to Magento root.
  </Step>

  <Step title="Upgrade module and flush cache">
    ```bash theme={null}
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    ```
  </Step>
</Steps>

## Removing the module

### Via Composer (recommended)

```bash theme={null}
composer remove mentionme/module-mention-me
php bin/magento setup:upgrade
php bin/magento cache:flush
```

### Via FTP (manual)

<Steps>
  <Step title="Delete module files">
    Delete `app/code/MentionMe` directory.
  </Step>

  <Step title="Flush config and cache">
    ```bash theme={null}
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    ```
  </Step>
</Steps>

<Warning>As with any new software install, always take backups and test in staging before deploying to production.</Warning>

[View these instructions on GitHub.](https://github.com/mention-me/magento2-integration#installing-the-module)
