Commit 64db69f5 authored by Gaurav Kapoor's avatar Gaurav Kapoor
Browse files

Issue #3261349: Enable configuration

parent b042a091
Loading
Loading
Loading
Loading

README.md

0 → 100644
+60 −0
Original line number Diff line number Diff line
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

Igniton error handler integrates 'spatie/ignition'
(https://github.com/spatie/ignition) with Drupal and provides developer a
very good UI for displaying error messages and exceptions. The UI also provides
various other important debugging information such as stack trace, cache
headers etc.

Do not enable this module on production environment.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/ignition

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/search/ignition


REQUIREMENTS
------------

It will currently only work with Drupal 10 as the spatie/ignition library
has a dependency on Symfony 5.

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module.
   See: https://www.drupal.org/docs/extending-drupal/installing-modules for
   further information. Recommended way of installing module is via composer.


CONFIGURATION
-------------

 * Configure the ignition error handler at (/admin/config/development/ignition).
 * 'Enable' configuration can be used to toggle enabling/disabling.
 * 'Dark Mode' configuration can be used to enable Dark Mode for the UI.


MAINTAINERS
-----------

Current maintainers:
 * Kevin Quillen (kevinquillen) - https://www.drupal.org/u/kevinquillen
 * Gaurav Kapoor (gaurav.kapoor) - https://www.drupal.org/u/gauravkapoor

Supporting organization:
 * Velir (https://www.drupal.org/velir)
+2 −0
Original line number Diff line number Diff line
enabled: true
dark_mode: false
+10 −0
Original line number Diff line number Diff line
ignition.settings:
  type: config_object
  label: 'Ignition settings'
  mapping:
    enabled:
      type: boolean
      label: 'Enable Ignition error pages for the website.'
    dark_mode:
      type: boolean
      label: 'Enable dark mode for the Ignition error page.'
+1 −0
Original line number Diff line number Diff line
@@ -3,3 +3,4 @@ type: module
description: 'Uses the spatie/ignition error handler package instead of the core Drupal error handler.'
package: Development
core_version_requirement: ^10
configure: ignition.settings
+5 −0
Original line number Diff line number Diff line
ignition.settings:
  title: 'Ignition'
  parent: system.admin_config_development
  description: 'Provides configuration options for the Ignition error pages.'
  route_name: ignition.settings
Loading