Compatibility
Check that your Sylius project can take the Fullmetrix plugin and what your infrastructure must let through.
Before having the plugin added, go through this page with your developer. A recent Sylius project usually meets these requirements already.
Supported versions
| Item | Required version |
|---|---|
| Sylius | 1.13 or 2.x |
| PHP | 8.1 or later, with the cURL and JSON extensions |
| Symfony | 6.4 or 7.x |
| Doctrine ORM | 2.15 or 3.x |
| Installation | Composer |
| Fullmetrix plugin | fullmetrix/sylius-plugin, latest version |
To check your project's exact versions, your developer can run composer show sylius/sylius and, once the plugin is installed, composer show fullmetrix/sylius-plugin.
What the project must allow
- Changing
composer.json,composer.lock,config/bundles.phpand adding a file inconfig/routes/. - Running Doctrine migrations on the production database. The plugin creates two tables of its own and changes no Sylius table.
- Clearing the Symfony cache on each server after deployment.
No scheduled task is needed. The plugin sends changes right after each response is sent to the visitor.
The store must be reachable
The connection works both ways.
- Fullmetrix reads the history and store data by calling your site over HTTPS, at addresses starting with
/fullmetrix/api/. These addresses must not be cached, rewritten or blocked by a proxy, a web application firewall, a site password or IP filtering. - Your PHP server sends changes and the connection request to
https://fullmetrix.com. It must therefore be able to open outgoing HTTPS connections.
Every call between Fullmetrix and your store is signed with a key specific to your connection, and the plugin rejects any unsigned call.
If your store sits behind Cloudflare or a web application firewall, read Cloudflare and firewalls.
The store address
When you click Connect, the plugin sends Fullmetrix the address you used to open the admin. So open the admin with the store's public address, over HTTPS. If the site sits behind a proxy or load balancer, Symfony must be configured to trust that proxy, otherwise the recorded address may be an internal one or use HTTP.
Several servers
The connection settings and the activity log are stored in the shared database. Every server must run the same plugin version, with the same bundle registered and the same routes.
Features available on Sylius
All the data reports need is imported, including variants, carts, refunds and promotions. The plugin can also show a marketing consent checkbox at checkout, with a text, position and colors you set in Checkout.
Subscriptions are reserved for WooCommerce. The Subscriptions menu therefore does not appear for a Sylius store.
The data sent
The import and updates send orders, customers, products, variants, categories, promotions and refunds, along with the store settings reports need, such as the currency. Visitor tracking sends page views, viewed products and carts. To learn what we do with this data, read Data we collect.
Once these points are checked, go to Installation.