README

Easily integrate Spatie Ignition error pages into your OpenMage installation!

Thanks to @fballiano for the brilliant idea started here:
OpenMage/magento-lts#3954

Requirements

This module requires the mage_run_installed_exception event, introduced in OpenMage 20.7.0, to properly catch unhandled exceptions.

Installation

Install via Composer

composer require empiricompany/openmage_ignition

Manual Core Patch (before v20.7.0)

If you prefer to manually patch OpenMage, add the following event dispatch inside app/Mage.php:

self::dispatchEvent('mage_run_installed_exception', ['exception' => $e]);

Alternatively, you can apply this patch directly via Composer:

"patches": {
    "openmage/magento-lts": {
        "Add mage_run_installed_exception event for unhandled exceptions (#3613)": "https://github.com/OpenMage/magento-lts/pull/3613.patch"
    }
}

Configuration

Navigate to System > Configuration > Advanced > Developer > Ignition Settings:

Available settings:

1. Enabled — Enable or disable Ignition (default: enabled).

2. Default Editor — Set your preferred code editor (default: clipboard).

3. Default Theme — Choose between light, dark, or auto (default: auto).

4. Save Custom Settings in Session — Allow session-based overrides (default: disabled).

5. Enable AI-Generated Solutions — Generate error solutions with OpenAI.

   Note: Requires installing the additional library:

   composer require openai-php/client

   Reference commit

   ⚠️ Warning: Caching is not yet implemented — every error will trigger an OpenAI API call.

6. OpenAI API Key — API key for OpenAI integration.

7. Enable Flare — Enable error tracking with Flare.

8. Flare API Key — API key for your Flare project.

9. Anonymize IP — Anonymize user IP addresses sent to Flare.

Note:
Saving settings in .ignition.json is currently not supported — all settings are stored in the OpenMage system configuration or session.

Screenshots

Ignition Error Page	Flare Integration

🚀 Enjoy a better error handling experience in OpenMage!