OCMLABS/MODULE-FAQ · INSTALLATION

Installing the FAQ & Product Questions module

The FAQ module installs as a single Composer package on both Magento Open Source and Adobe Commerce. The Hyvä companion module is an optional second package for stores running the Hyvä theme.

Requirements

MAGENTO: 2.4.6 - 2.4.8
PHP: 8.3+
THEME: Luma (native) · Hyvä via ocmlabs/module-faqhyva companion package
LICENSE: Composer / Packagist - public, no auth credentials required

1. Install via Composer

TERMINAL

$ composer require ocmlabs/module-faq
$ bin/magento module:enable OCMLabs_Faq
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

Installing manually instead of via Composer works too: copy the module directory to app/code/OCMLabs/Faq, then run the same commands starting from module:enable.

2. Adobe Commerce

Adobe Commerce installs the ocmlabs/module-faq-commerce metapackage, not the core ocmlabs/module-faq package. The metapackage requires ocmlabs/module-faq alongside magento/product-enterprise-edition, so a single composer require pulls the module in with its Adobe Commerce licensing gate intact:

TERMINAL

$ composer require ocmlabs/module-faq-commerce
$ bin/magento module:enable OCMLabs_Faq
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

NOTE /

The registered module name is OCMLabs_Faq - the same as the Open Source package - so the enable and setup commands above reference that, even on the Commerce metapackage.

3. Hyvä theme

If your store runs the Hyvä theme, install the companion module alongside the core FAQ module:

TERMINAL

$ composer require ocmlabs/module-faqhyva
$ bin/magento module:enable OCMLabs_FaqHyva
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush
# then re-run your Tailwind build so the module’s classes compile

The Hyvä companion module replaces the Luma accordion template with an Alpine.js implementation compatible with Hyvä’s asset pipeline. Admin management (grid, edit form, configuration) is unchanged - only the frontend rendering layer differs.

4. Verify

Confirm the module is enabled and the version matches your entitlement:

TERMINAL

$ bin/magento module:status OCMLabs_Faq

You should see OCMLabs_Faq listed under enabled modules. In the admin panel, navigate to Catalog > Product FAQs - if the menu item is visible, the module installed correctly.

The module uses a single ACL permission, OCMLabs_Faq::manage, found under System > Permissions > User Roles in the Content section. Assign it to any role that should be able to create or manage FAQs - without it, the Catalog > Product FAQs menu item does not appear for that user.

CAUTION /

If your production instance runs in production mode, run bin/magento setup:static-content:deploy and bin/magento cache:flush after installing - the module will not render correctly on the storefront until static content is regenerated.

Check the frontend

Visit any product page in your store. If you have already created a FAQ assigned to that product, you will see an FAQs tab in the product detail tabs section. If no active FAQs are assigned to the product, the tab does not appear - that is expected behaviour.

The JSON-LD schema block is injected into the page <head> automatically alongside the tab. Verify it is present by viewing the page source and searching for application/ld+json.