3 min readJun 6, 2026by jakub

Installation

The Advanced FAQ suite is a lean core plus a set of optional satellites. Install the core first, then add only the satellites you need — the core works on its own.

Requirements

RequirementVersion
Magento / Adobe Commerce / Mage-OS2.4.x (with magento/framework)
PHP8.1, 8.2, 8.3, 8.4, or 8.5
Composer2.x
OpenSearchRequired only for qoliber/advanced-faq-search
HyväRequired only for qoliber/advanced-faq-hyva

Install the core

Bash
composer require qoliber/advanced-faq
bin/magento module:enable Qoliber_AdvancedFaq
bin/magento setup:upgrade
bin/magento cache:flush

The core ships content models, repositories, admin grids, the Luma storefront, the FAQ Block widget, REST service contracts, a built-in MySQL search provider, FAQPage JSON-LD, and XML sitemap inclusion. No satellite is required for any of this.

Optional satellites

Add any of the following alongside the core. Each one overrides a graceful extension point and degrades cleanly when absent.

Bash
# REST API endpoints
composer require qoliber/advanced-faq-webapi

# GraphQL queries
composer require qoliber/advanced-faq-graphql

# Hyvä storefront templates (Tailwind, CSP-safe)
composer require qoliber/advanced-faq-hyva

# Rule-based auto-assignment (catalog-rule conditions)
composer require qoliber/advanced-faq-rule

# OpenSearch search provider + real-time indexing + reindex command
composer require qoliber/advanced-faq-search

# AI draft-answer generation
composer require qoliber/advanced-faq-ai
qoliber/ai is pulled in automatically

You do not install qoliber/ai directly. It is a Composer dependency of qoliber/advanced-faq-ai and is pulled in automatically when you require the AI satellite. qoliber/ai is the shared, provider-agnostic AI abstraction (Claude / ChatGPT / Gemini / Grok); see AI answer generation.

After requiring the satellites you want, enable them and run setup once:

Bash
bin/magento module:enable \
  Qoliber_AdvancedFaqWebapi Qoliber_AdvancedFaqGraphQl Qoliber_AdvancedFaqHyva \
  Qoliber_AdvancedFaqRule Qoliber_AdvancedFaqSearch Qoliber_AdvancedFaqAi Qoliber_Ai
bin/magento setup:upgrade
bin/magento setup:di:compile      # production mode only
bin/magento cache:flush

Enable only the modules you actually installed — list just those module names in module:enable.

Package reference

PackageModuleRole
qoliber/advanced-faqQoliber_AdvancedFaqCore (required)
qoliber/advanced-faq-webapiQoliber_AdvancedFaqWebapiREST endpoints
qoliber/advanced-faq-graphqlQoliber_AdvancedFaqGraphQlGraphQL queries
qoliber/advanced-faq-hyvaQoliber_AdvancedFaqHyvaHyvä storefront templates
qoliber/advanced-faq-ruleQoliber_AdvancedFaqRuleRule-based auto-assignment
qoliber/advanced-faq-searchQoliber_AdvancedFaqSearchOpenSearch provider + indexing
qoliber/advanced-faq-aiQoliber_AdvancedFaqAiAI draft-answer generation
qoliber/aiQoliber_AiShared AI abstraction (dependency of the AI satellite)

Prerequisites for specific satellites

This satellite requires a working OpenSearch instance — it builds on Magento_Elasticsearch and adds an edge-ngram analyzer for prefix / as-you-type matching. The core falls back to a built-in MySQL search provider when this module is not installed, so OpenSearch is only a prerequisite if you want the upgraded search. After install, build the index once:

Bash
bin/magento qoliber:advancedfaq:search:reindex

FAQs are also indexed in real time on save/delete and on topic/tag assignment changes, so a full reindex is normally only needed after bulk imports or index changes.

Hyvä (qoliber/advanced-faq-hyva)

Install this only on Hyvä storefronts. It depends on qoliber/hyva-module-registration and ships CSP-safe Tailwind templates and class markup — not a compiled stylesheet. As is normal for Hyvä, the CSS is built by your Hyvä child theme, so regenerate the theme config and rebuild Tailwind after install:

Bash
bin/magento hyva:config:generate
# then rebuild your child theme's Tailwind (npm run build / watch in the theme dir)

The Luma frontend ships in the core and needs no extra module.

Post-installation

  1. Go to Stores → Configuration → Qoliber → Advanced FAQ and review the settings (see Configuration).
  2. Create your first Topics and FAQ items under the Qoliber FAQ admin menu (see Usage).
  3. Visit /faq on the storefront to confirm the hub renders.

Updating

Bash
composer update qoliber/advanced-faq qoliber/advanced-faq-*
bin/magento setup:upgrade
bin/magento setup:di:compile      # production mode only
bin/magento cache:flush

Next steps