Weave Code
Laravel Ignition Laravel Package
spatie/laravel-ignition
Beautiful, customizable error page for Laravel 10+ apps (PHP 8.1+). Shows detailed exception screens, offers helpful solutions, and can share errors to Flare. With a Flare API key, it tracks production errors and sends notifications.
A beautiful error page for Laravel apps
Frequently asked questions about Laravel Ignition
- How do I install spatie/laravel-ignition in a Laravel 10+ project?
- Run `composer require spatie/laravel-ignition` in your project directory. Ignition will automatically publish its configuration file and register the service provider. No additional steps are needed for basic usage. For Laravel 8/9, use `facade/ignition` instead.
- Does laravel-ignition work with Laravel 11 or 12?
- Yes, Ignition officially supports Laravel 10 through 13 (as of v2.12.0). The package is regularly updated to ensure compatibility with new Laravel releases. Check the [GitHub repo](https://github.com/spatie/laravel-ignition) for the latest version notes.
- Can I customize the error page’s appearance (e.g., colors, branding)?
- Absolutely. Ignition allows full customization via the `ignition.php` config file. You can override the default Blade template, adjust CSS variables, or even disable features like the AI-powered solutions section. See the [documentation](https://flareapp.io/docs/ignition/customization) for details.
- How does Flare integration work, and is it required?
- Flare integration is optional but powerful. If you configure a Flare API key in `.env`, Ignition will send errors to Flare for tracking, notifications, and team collaboration. Without Flare, Ignition still provides a rich error page locally. Flare requires an outbound HTTP call, so ensure your server allows it.
- Will Ignition slow down my Laravel application in production?
- Ignition adds minimal overhead—only active during errors. The middleware runs early in the stack but doesn’t process requests unless an exception occurs. For high-traffic apps, disable Ignition in staging/production via `IGNATION_ENABLED=false` in `.env` if needed.
- Can I use Ignition with Livewire or Inertia.js?
- Yes, Ignition supports Livewire (including v4) and Inertia.js out of the box. It captures context like Livewire component states or Inertia page props, making debugging easier. No extra configuration is required for basic usage, though custom exception handlers may need adjustments.
- How do I exclude sensitive data (e.g., API keys) from error reports?
- Use Ignition’s `context` configuration to filter sensitive data. For example, add `'exclude' => ['password', 'api_key']` to the `ignition.php` config. Flare also supports [data sanitization](https://flareapp.io/docs/ignition/flare-integration#sanitizing-data) to strip PII from reports.
- Is there a way to test Ignition without breaking my app?
- Yes, use `Ignition::fake()` in tests to simulate errors without rendering the full page. This is useful for unit/integration tests. For manual testing, throw exceptions in routes or controllers (e.g., `abort(500)`) to trigger Ignition’s error page.
- What are the alternatives to laravel-ignition for Laravel error pages?
- Alternatives include **Whoops** (lightweight, no Flare), **Laravel Debugbar** (for debugging tools), or **Sentry** (for production monitoring). Ignition stands out with its modern UI, AI solutions, and seamless Flare integration. For Laravel 5.x, `facade/ignition` (v1.x) is the legacy option.
- How do I disable Ignition in production but keep it in development?
- Set `IGNATION_ENABLED=false` in your `.env` file for production. Ignition respects this environment variable and won’t render error pages when disabled. This is useful for security or performance reasons while keeping debugging tools active in dev/staging.
Weaver
How can I help you explore Laravel packages today?