Gigya Job Openings

Magento 2 - Gigya Extension Installation Guide

Skip to end of metadata
Go to start of metadata

« Back to Gigya Extension for Magento 2.0 



This document will walk you through the installation process for the Gigya Extension for Magento 2.0.

Installing the Gigya Extension for the First Time


  • You need a Magento username and password to successfully complete this installation. If you do not yet have a Magento account, you can create one according to Magento documentation, e.g. here and here.
  • After running setup:upgrade, you may be prompted to run compilation mode. Compilation in Magento is not necessary when testing and configuring the site.

Step 1 - Get the Extension

To get the extension:

  1. Download the latest Magento 2 GConnector here: 

    Gigya Developer Downloads

  2. Extract the contents of the .zip file to a local folder outside your Magento installation. 

  3. Initialize the folder as a git repository by running the following from the command line:

    git init
  4. Add the extracted files to Git using the following command:

    git add *
  5. Commit the changes to Git using the following command:

    git commit -am "Initial Commit"
  6. Once both the Magento GConnector is hosted locally, Log in via SSH (if necessary) and navigate to the Magento installation root.
  7. Add the Gigya repositories by typing the following commands (replace "/folderPathTo" with the actual folder path of the extracted zip file from steps 2-6): 

    composer config repositories.gigya-im git /folderPathToMagentoIMLocalRepo

    These modifications will write to Magento's root composer.json file.

  8. Add the Gigya module and its dependencies and update: 

    composer require gigya/magento2-im
    composer update

    If you experience problems with this step, make sure your root composer.json file supports non-stable versions. For example, you may need to remove the line prefer-stable:true and set minimum-stablility to beta.
  9. Still connected to the server using SSH, enable the module by running: 

    bin/magento module:enable Gigya_GigyaIM
  10. Perform a Magento upgrade using the following command:

     php bin/magento setup:upgrade

    Don't forget to clear the Magento cache after this process as well as after carrying out any other change.

2. Create a Gigya Application Key and Application Secret

To keep your Gigya data secure, your Gigya Extension will connect to Gigya using a unique Application Key, used only by this extension.

See instructions for creating an Application Key.

Along with the Application Key, you will be assigned an Application Secret as a password.

3. Encrypt Your Application Secret


Generate a Key

Generate any random 32-character hexadecimal key. Any method to do so can be used. For example: 


date | md5sum


Save the generated key inside Magento's "var" directory, e.g. "var/enc.key". 

Encrypt the Secret

Use the generated key to encrypt your application secret. In Magento's root directory, run the following commands:


php vendor/gigya/magento2-im/Helper/CmsStarterKit/cli/encryption.php -e "(your_user_secret_key)" `cat var/enc.key`

Save the resulting string in the database by running the following SQL query :

insert into gigya_settings values(1, 'previously_generated_string', 1);



Disabling the Gigya Extension

To disable the Gigya extension, run the following command:

php bin/magento module:disable Gigya_GigyaIM --clear-static-content



  • No labels