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
| Requirement | Version |
|---|---|
| Magento / Adobe Commerce / Mage-OS | 2.4.x (with magento/framework) |
| PHP | 8.1, 8.2, 8.3, 8.4, or 8.5 |
| Composer | 2.x |
| OpenSearch | Required only for qoliber/advanced-faq-search |
| Hyvä | Required only for qoliber/advanced-faq-hyva |
Install the core
composer require qoliber/advanced-faq
bin/magento module:enable Qoliber_AdvancedFaq
bin/magento setup:upgrade
bin/magento cache:flushThe 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.
# 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-aiYou 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:
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:flushEnable only the modules you actually installed — list just those module names in module:enable.
Package reference
| Package | Module | Role |
|---|---|---|
qoliber/advanced-faq | Qoliber_AdvancedFaq | Core (required) |
qoliber/advanced-faq-webapi | Qoliber_AdvancedFaqWebapi | REST endpoints |
qoliber/advanced-faq-graphql | Qoliber_AdvancedFaqGraphQl | GraphQL queries |
qoliber/advanced-faq-hyva | Qoliber_AdvancedFaqHyva | Hyvä storefront templates |
qoliber/advanced-faq-rule | Qoliber_AdvancedFaqRule | Rule-based auto-assignment |
qoliber/advanced-faq-search | Qoliber_AdvancedFaqSearch | OpenSearch provider + indexing |
qoliber/advanced-faq-ai | Qoliber_AdvancedFaqAi | AI draft-answer generation |
qoliber/ai | Qoliber_Ai | Shared AI abstraction (dependency of the AI satellite) |
Prerequisites for specific satellites
OpenSearch (qoliber/advanced-faq-search)
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:
bin/magento qoliber:advancedfaq:search:reindexFAQs 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:
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
- Go to Stores → Configuration → Qoliber → Advanced FAQ and review the settings (see Configuration).
- Create your first Topics and FAQ items under the Qoliber FAQ admin menu (see Usage).
- Visit
/faqon the storefront to confirm the hub renders.
Updating
composer update qoliber/advanced-faq qoliber/advanced-faq-*
bin/magento setup:upgrade
bin/magento setup:di:compile # production mode only
bin/magento cache:flushNext steps
- Configuration — Admin settings
- Usage — Authoring and storefront workflows
- AI answer generation — Configure and use AI drafting