https://github.com/wintercms/wn-ignition-plugin

Ignition error page integration for Winter CMS
https://github.com/wintercms/wn-ignition-plugin

hacktoberfest

Last synced: about 1 month ago
JSON representation

Ignition error page integration for Winter CMS

• Host: GitHub
• URL: https://github.com/wintercms/wn-ignition-plugin
• Owner: wintercms
• License: mit
• Created: 2021-03-16T16:50:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-07T14:26:49.000Z (over 1 year ago)
• Last Synced: 2024-04-14T04:55:39.968Z (9 months ago)
• Topics: hacktoberfest
• Language: PHP
• Homepage:
• Size: 35.2 KB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wintercms - Winter.Ignition - Ignition error page integration. (Uncategorized / Uncategorized)

README

        
# Winter.Ignition Plugin

![ignition](https://flareapp.io/images/docs/ignition.jpg)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/wintercms/wn-battlesnake-plugin/blob/main/LICENSE)

Beautiful and useful error pages. Integrates the [Ignition](https://flareapp.io/docs/ignition/introducing-ignition/overview) error page into Winter CMS.

## Installation

This plugin is available for installation via [Composer](http://getcomposer.org/).

```bash

composer require --dev winter/wn-ignition-plugin

```

After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files).

```bash

php artisan migrate

```

## Usage Notes:

### Configuration

See config/ignition.php and config/flare.php for the available configuration options.

## License

This package is licensed under the [MIT license](https://github.com/wintercms/wn-ignition-plugin/blob/master/LICENSE.txt).

## Support

If you would like to contribute to this plugin's development, please feel free to submit issues or pull requests to the plugin's repository here: https://github.com/wintercms/wn-ignition-plugin

If you would like to support Winter CMS, please visit [WinterCMS.com](https://wintercms.com/support)

## TODO:

- DON'T USE IN PRODUCTION YET

- [ ] Verify configuration can be overrided in the Winter way, looks like package is loading configuration directly from a file path

- [x] Fix support for theme-rendered pages, remove the Laravel debug=false error pages

- [x] Add Winter-specific context variables (Winter version, installed plugins & versions)

- [ ] Fix auth context variables to support Winter auth

- [ ] Filter out sensitive values (sessions, cookies, passwords, api keys, secrets, etc); especially when uploading to Flare

- [x] See if there's some way to configure the "open in editor" links to be defined by an environment variable (both the editor and the base path to the file since the file could be run inside of Homestead which means the path wouldn't be valid on the host system)

- [ ] Change the styling to be more "Winter-fied" (blues instead of Laravel Red)

- [ ] Document how to extend the context variables

- [ ] Add ability to replay exceptions using the Ignition view (or at least the data from them) in the Backend Event Logs section