spatie/symfony-ignition-bundle

A beautiful error page for Symfony apps

Fund package maintenance!
spatie

Installs: 5 981

Dependents: 0

Suggesters: 0

Security: 0

Stars: 22

Watchers: 4

Forks: 5

Open Issues: 0

Type:symfony-bundle

1.1.0 2023-12-16 17:16 UTC

This package is auto-updated.

Last update: 2024-02-16 17:43:52 UTC


README

Latest Version on Packagist Tests Total Downloads

Ignition is a beautiful and customizable error page for PHP applications

Using this bundle, you can replace Symfony's default exception pages with Ignition.

This is what how the Ignition looks like in the browser.

Screenshot of ignition

There's also a beautiful dark mode.

Screenshot of ignition in dark mode

Support us

68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f73796d666f6e792d69676e6974696f6e2d62756e646c652e6a70673f743d31

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require --dev spatie/symfony-ignition-bundle

Enable the bundle in config/bundles.php:

 return [
     // ...
+    Spatie\SymfonyIgnitionBundle\IgnitionBundle::class => ['dev' => true],
 ];

Configuration

Use bin/console debug:config ignition to see configuration options.

config/packages/ignition.yaml:

ignition:
    application_path: '%kernel.project_dir%'
    dark_mode: false
    should_display_exceptions: '%kernel.debug%'
    # if you want AI solutions to your app's errors
    openai_key: 'key-here'

Usage

When you now throw an exception anywhere in your app...

class IndexController extends AbstractController
{
    #[Route('/', name: 'index')]
    public function index(): Response
    {
        throw new Exception('Hello Ignition!');
    }
}

... you'll see a beautiful error page.

screenshot

To learn all the options that Ignition provides, including error reporting to Flare, head over to the readme of spatie/ignition.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.