README

Integrate ignition error page https://github.com/spatie/ignition in OpenMage!

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

Installation

The module needs a new event mage_run_installed_exception to catch exceptions introduced in OpenMage 20.7.0.

Install composer package

composer require empiricompany/openmage_ignition

Manually patch core files

If you want to manually patch you need to add new event in the file app/Mage.php

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

Or apply a patch from this PR:

"patches": {
    "openmage/magento-lts": {
        "Add mage_run_installed_exception event when uncatched exception is thrown #3613": "https://github.com/OpenMage/magento-lts/pull/3613.patch"
    }
}

Ignition Settings

In System/Advanced/Developer section

Enabled: Enable / Disable (enable)
Default Editor: set default editor (clipboard)
Default Theme: set default theme (auto)
Save custom settings in session: Enable if you want custom settings foreach session, otherwise settings will be overrided (disabled)
Enable AI Generated Solution: Enable AI Generated Solution by OpenAI (⚠️ Warning: there is no cache implemention yet, so all errors always call OpenAI api)
OpenAI API Key: OpenAI Api Key used to generate solutions
Enable Flare: Enable error tracking with Flare
Flare API Key: Flare Api Key of project
Anonymize IP: anonymize IP sended to Falre

Save settings in file .ignition.json is not supported yet, all new settings will be saved directly in system config or in session.