OCMLABS/MODULE-SUPPORT-TICKET · INSTALLATION

Installation

The Support Tickets module installs as a single Composer package. Magento Open Source and Adobe Commerce each use their own package; pick the one that matches your edition below.

Requirements

MAGENTO: 2.4.7 - 2.4.8
PHP: 8.3+
THEME: Luma (native) · Hyva via ocmlabs/module-support-ticket-hyva companion package
LICENSE: Composer / Packagist - public, no auth credentials required

CAUTION /

Magento 2.4.9 is not yet supported. Install only on 2.4.7 or 2.4.8.

Magento 2 Open Source

Install via Composer (recommended)

TERMINAL

$ composer require ocmlabs/module-support-ticket
$ bin/magento module:enable OCMLabs_SupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

Install manually

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

Adobe Commerce

On Adobe Commerce, install the ocmlabs/module-support-ticket-commerce package:

TERMINAL

$ composer require ocmlabs/module-support-ticket-commerce
$ bin/magento module:enable OCMLabs_SupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

Hyva theme

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

TERMINAL

$ composer require ocmlabs/module-support-ticket-hyva
$ bin/magento module:enable Hyva_OCMLabsSupportTicket
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento cache:flush

NOTE /

The Hyva companion module declares a sequence dependency on OCMLabs_SupportTicket, so install the core module first. It requires the hyva-themes/magento2-compat-module-fallback package and replaces the Luma LESS/jQuery storefront templates with Tailwind CSS and Alpine.js implementations compatible with Hyva’s asset pipeline. Admin management (grid, edit form, configuration) is unchanged; the only difference is the frontend rendering layer for the customer portal and the product page Support button.

Verify the installation

Via CLI:

TERMINAL

$ bin/magento module:status OCMLabs_SupportTicket

The output should show Module is enabled.

Via database:

The install creates two new tables: ocmlabs_support_ticket and ocmlabs_support_ticket_comment. Confirm they exist after running setup:upgrade.

Via admin panel:

Navigate to Stores > Support > Support Tickets. If the menu item is visible and the grid loads, the module installed correctly.

Grant admin access

Four ACL permissions live under System > Permissions > User Roles in the OrangeCollar section:

OCMLabs_SupportTicket::tickets - View and access the ticket grid
OCMLabs_SupportTicket::tickets_manage - Edit tickets and add replies
OCMLabs_SupportTicket::tickets_delete - Delete tickets
OCMLabs_SupportTicket::config - Access Support Tickets configuration

Without OCMLabs_SupportTicket::tickets, the Stores > Support > Support Tickets menu item does not appear for that user. See System Settings for the configuration path.

Configure the module

CAUTION /

Before going live, set the Admin Notification Email under Stores > Configuration > OrangeCollar > Support Tickets. This is the address that receives every new-ticket alert and every customer reply notification.

See System Settings for the full configuration reference.

Check the frontend

Log in as a customer account on the storefront.
Go to My Account. A My Support Tickets link should appear in the account navigation.
Click it to confirm the ticket list page loads.
Navigate to any product page and confirm the Support button is visible.
Create a test ticket to verify the full submission flow and confirm notification emails are delivered.

Production deployment

If deploying to a production environment with static content already compiled, run the full static content deploy after setup:upgrade:

TERMINAL

$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento setup:static-content:deploy -f
$ bin/magento cache:flush

If your production deploy pipeline uses maintenance mode:

TERMINAL

$ bin/magento maintenance:enable
$ bin/magento setup:upgrade
$ bin/magento setup:di:compile
$ bin/magento setup:static-content:deploy -f
$ bin/magento cache:flush
$ bin/magento maintenance:disable