Installation - PrestaShop

Before you start, create a project in the DockRay panel. Its settings hold the project token - the public identifier that goes into the ingest URL - and the API keys tab is where you generate a private key. The key is shown once, when it is generated: DockRay stores only its hash. If you do not have a project yet, start with Getting Started.

Requirements

• PrestaShop 1.7.8 or newer, 8.x or 9.x,
• PHP 8.2 or newer,
• outbound HTTPS connections allowed from the shop's server.

The module is not in the Addons marketplace - we release dockray-prestashop.zip ourselves and you download it from the PrestaShop integration page. PrestaShop does not run Composer during installation, so the SDK ships inside the archive.

Installing from the back office

1. Download the current dockray-prestashop.zip package.
2. Sign in to the shop's back office.
3. Go to Modules → Module Manager and choose Upload a module.
4. Pick the archive and wait for the install to finish.
5. Open Configure on the DockRay module.
6. Enter the project token and the private key, then save.
7. Click Send a test event.

Installing without credentials is safe: the module loads, sends nothing and changes nothing about how the shop behaves.

Installing from the command line

unzip dockray-prestashop.zip -d modules/
php bin/console prestashop:module install dockray
php bin/console cache:clear

After a console install the credentials are still filled in on the module's configuration screen - or through PHP constants, which the configuration article covers.

Clear the cache after installing

PrestaShop keeps the list of attached hooks in the service container. If the module installs correctly but reports nothing, the first step is php bin/console cache:clear, or clearing the cache from Advanced Parameters → Performance.

After the install

Check that the token and the key come from the same project, then move on to configuration: that is where you set the environment, request timing, the scope of customer data and - optionally - collecting JavaScript errors from the storefront.