Skip to content
OCMLabs Docs

Installation

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

Requirements

Section titled “Requirements”
  • Magento 2.4.6 to 2.4.8 (framework, catalog, backend, and ui modules)
  • PHP 8.3 or higher

Magento 2 Open Source

Section titled “Magento 2 Open Source”
Section titled “Install via Composer (recommended)”
Terminal window
composer require ocmlabs/module-faq
bin/magento module:enable OCMLabs_Faq
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

Install manually

Section titled “Install manually”

Copy the module directory to app/code/OCMLabs/Faq, then run the same commands starting from module:enable.

Verify the installation

Section titled “Verify the installation”

Once setup completes, confirm the module is active:

Terminal window
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.

Grant admin access

Section titled “Grant admin access”

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.

Production deployment

Section titled “Production deployment”

After installing on a production instance, run the full static content deploy if you are in production mode:

Terminal window
bin/magento setup:static-content:deploy
bin/magento cache:flush

Adobe Commerce

Section titled “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 window
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

The registered module name is OCMLabs_Faq (same as the Open Source package), so the enable and setup commands above reference that.

Hyva theme

Section titled “Hyva theme”

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

Terminal window
composer require ocmlabs/module-faqhyva
bin/magento module:enable OCMLabs_FaqHyva
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush

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

See Hyva Compatibility for more detail on what the companion module does and how the storefront changes.

Check the frontend

Section titled “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.