doofinder/doofinder-magento2 0.9.8

Doofinder module for Magento 2

doofinder-magento2

IMPORTANT: If you are in trouble with the module, please contact Doofinder Support from the Doofinder website.

Docker Environment

To use the docker environment clone this repo inside a folder structure like this:

some_directory <- Name is not important
  |- package <- This repo code inside that folder
  |- src <- An empty folder to be used in the automatic installation process

And copy this repo's docker-compose.yml & build.sh & .env files to the root of the base directory (some_directory in the example).

NOTE: If you are in Windows or WSL, probably you'll have to fix CONTROL-M (^M) carriage return characters in build.sh file. Run this command to get rid of this characters:

dos2unix build.sh

So you'll have:

some_directory <- Name is not important
  |- package <- This repo code inside that folder
  |- src <- An empty folder to be used in the automatic installation process
  |- docker-compose.yml
  |- build.sh
  |- .env

Edit the copy of .env and set your tokens in the COMPOSER_AUTH environment variable. You can also set the version of Magento you wish to install.

Then run the environment by executing:

$ docker-compose up

from the base directory where the copy of docker-compose.yml is located. The installation process will take some minutes to be finished. You can follow the status logging with:

docker logs setup -f

Finally, Magento 2 with the module installed will be running at http://localhost:80.

The admin panel will be available at http://localhost:80/admin. Admin credentials are easy:

User: admin
Pass: admin123

To install sample data, with the containers running, you can simply execute:

$ ./data_loader.sh

In order to make this script work, the only thing you'll need to do is to fill the username and password fields in the auth_json file, with the same values used previously in the .env file.

OR if you'd rather load the data manually, you can also:

$ docker exec -it web bash
[email protected]:~# cd /app
[email protected]:/app# php -d memory_limit=-1 bin/magento sampledata:deploy
[email protected]:/app# bin/magento setup:upgrade
[email protected]:/app# bin/magento setup:di:compile
[email protected]:/app# bin/magento setup:static-content:deploy -f

Note: After you run the bin/magento sampledata:deploy command you will be prompted for authentication: Authentication required (repo.magento.com):. You will have to use simply the same Magento repository tokens that you used in the .env file:

COMPOSER_AUTH_USERNAME & COMPOSER_AUTH_PASSWORD

Using the module

In order to be able to create an account or login to an existing Doofinder account during the module initial setup, you will have to expose your local webserver to internet (to receive a callback).

To do so, you can use, for example; the utility Ngrok: https://dashboard.ngrok.com/get-started/setup

And once you have the external ip created (and before running the docker-compose up) simply edit the .env file and set the MAGENTO_BASE_URL=ip (for example: MAGENTO_BASE_URL=7dd5-80-26-218-151.ngrok.io)

So, when the installation process finished, instead of accessing to http://localhost:80 you will use: http://ip:80 (for example: https://7dd5-80-26-218-151.ngrok.io).

Xdebug ready to use

If you wish to debug your new Magento installation, just simply set the correct values in .env and configure your IDE attending to the remote PHP docker container web. You should also bind your local source path: ./src to the docker one: /app

PhpMyAdmin ready to use

Once the installation has finished, you can also access to a ready to use phpMyAdmin local server listening in port 8080: http://localhost:8080. Here you will see all the Magento 2 tables in the database specified in the file .env (by default: magentobase)

Uninstall the module

You can remove the Doofinder module using this straightforward method:

$ docker exec -it web bash
[email protected]:~# cd /app
[email protected]:/app# bin/magento module:uninstall Doofinder_Feed --remove-data

Last notes

Please, take care when you change in .env the MAGENTO_VERSION parameter since you'll have to change probably the PHP_VERSION & COMPOSER_VERSION ones in order to maintain the compatibility. For example, if you wish the Magento 2.4.3 version you should have:

PHP_VERSION=7.4
COMPOSER_VERSION=2.0.14
MAGENTO_EDITION=community
MAGENTO_VERSION=2.4.3

but if you want to test, let's say, the 2.3.1 version you should have something like this:

PHP_VERSION=7.2
COMPOSER_VERSION=1.4.3
MAGENTO_EDITION=community
MAGENTO_VERSION=2.3.1

And please, don't forget to copy in .env your Magento repository tokens filling the parameters:

COMPOSER_AUTH_USERNAME=
COMPOSER_AUTH_PASSWORD=