Doofinder

doofinder-prestashop

Plugin that allows to configure the Doofinder search service in a Prestashop 1.5 store with less effort than configuring it from scratch.

> [!IMPORTANT] > If you experience any issue with the module, please contact Doofinder Support from the Doofinder website.

How to install and configure Doofinder

Refer to Doofinder Support Documentation for Prestashop for the latest and up to date instructions.

Module Compatibility

PHP

The minimum php required for this module is php 5.4 The maximum php version tested is 8.4

PrestaShop

From 1.5.0.17 to latest version

For more compatibility details check the following documentation

• Prestashop 1.x system requirements.
• Prestashop 8 system requirements.
• Prestashop 9 system requirements.

Docker Environment

Configure ngrok

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 the internet (to receive a callback).

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

Once the external URL is created, simply set the <code>BASE_URL</code> environment variable (see Environment Variables).

So, when the installation process finished, instead of accessing to <code>https://localhost:4011</code> you will use your url, for example, <code>https://forcibly-ethical-apple.ngrok-free.app</code>). Notice that you'll need to specify the 4011 port when executing ngrok.

Environment variables

> [!TIP] > You can create an <code>.env.local</code> file to override the environment variables defined in <code>.env</code> such as PrestaShop installation data to fit your needs.

For example, below is a base <code>.env.local</code> file:

#PrestaShop setup configuration data

BASE_URL=your-url.ngrok-free.app PS_ENV=dev

The <code>Makefile</code> automatically overrides <code>.env</code> vars with the ones found in <code>.env.local</code>.

> [!IMPORTANT] > The <code>Makefile</code> internally appends <code>--env-file .env --env-file .env.local</code> to <code>docker compose</code> command for properly configuring container environment. So take it into account when interacting directly with <code>docker compose</code>.

Initial setup

You can set up a fresh PrestaShop installation using the provided <code>Makefile</code> target <code>init</code>. This command will:

• Pulls and build a PrestaShop docker image with xdebug extension and maybe other tweaks. This build is configurable using the environment variables <code>PHP_VERSION</code> and <code>PS_VERSION</code> environment variables.
• Starts the containers
• Runs the installer script with the defined environment variables.

Finally, PrestaShop is installed and will be running at <code>https://BASE_URL</code>.

You can install the Doofinder module through the admin or execute <code>make doofinder-upgrade</code>.

The admin panel will be available at <code>https://BASE_URL/PS_FOLDER_ADMIN</code>. Admin credentials are defined in the <code>.env</code>, if you used the <code>env.example</code> would be:

• User: <code>test@example.com</code>
• Pass: <code>admin123</code>

> [!NOTE] > Keep in mind that for versions prior to 1.7 PrestaShop will ask you to delete the <code>install</code> folder and rename the <code>admin</code> folder located in the <code>html</code> directory. > For newer versions this is done automatically, using the value on the environment variable <code>PS_FOLDER_ADMIN</code> (by default, <code>/4dm1n</code>).

Autoload

Starting from version 6.0.0, this plugin uses the Composer autoloader, which is generated by running <code>composer dump-autoload</code> via the <code>make dump-autoload</code> command. This target is always executed after <code>make doofinder-configure</code>. If you create a new class, you must run <code>make dump-autoload</code> manually to make the class discoverable by PrestaShop.

Version Upgrade

To upgrade the package version, simply edit the <code>PLUGIN_VERSION</code> environment variable in the <code>.env</code> file and run <code>make doofinder-configure</code>. This will update all the necessary files. However, you must manually edit the <code>doofinder.php</code> file, as PrestaShop requires that <code>$this-&gt;version</code> be a hardcoded value.

Xdebug ready to use

If you wish to debug your new PrestaShop installation, the <code>XDEBUG_CONFIG</code> and <code>XDEBUG_MODE</code> environment variables are already configured in <code>docker-compose.yml</code>. Simply configure your IDE accordingly and have fun!

Uninstall the module

You can remove the Doofinder module using this straightforward method:

make doofinder-uninstall

Test another versions of the module

Change your branch to the tag that you want inside package directory

make doofinder-upgrade

Backup and Restore Database

During development, it is sometimes useful to create a data snapshot before performing an action.

• To create a database dump, use:

  make db-backup [prefix=_some_state]
  

• To restore a previous state, run:

  make db-restore file=backup_file.sql.gz
  

Test other PrestaShop versions

You can test different Prestashop versions along with different PHP versions. These are the latest combinations available gathered from PrestaShop Docker Hub

| PrestaShop | PHP | | ---------- | ----------------------- | | 8.2.1 | 8.1, 8.0, 7.4, 7.3, 7.2 | | 8.1.7 | 8.1, 8.0, 7.4, 7.3, 7.2 | | 8.0.5 | 8.1, 8.0, 7.4, 7.3, 7.2 | | 1.7.8.9 | 7.4, 7.3, 7.2, 7.1 | | 1.6 | 7.2, 7.1, 7.0, 5.6 | | 1.5[^ps15] | 7.2, 7.1, 7.0, 5.6, 5.5 |

[^ps15]: Prestashop 1.5: This version is patched to allow auto installation (See Dockerfile). MySQL version must be 5.5. Must be used without SSL.