Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

DebugBar integration for Winter CMS
https://github.com/wintercms/wn-debugbar-plugin

hacktoberfest

Last synced: about 2 months ago
JSON representation

DebugBar integration for Winter CMS

Awesome Lists containing this project

README

        

# Winter.DebugBar Plugin

Easily see what's going on under the hood of your Winter CMS applications. Integrates [Laravel DebugBar](https://github.com/barryvdh/laravel-debugbar) / [PHP DebugBar](http://phpdebugbar.com/) into Winter CMS.

![debugbar](https://github.com/wintercms/wn-debugbar-plugin/assets/7253840/eb170da3-133e-4608-b963-fa692e00b127)

# Installation

To install with Composer, run the following command from your project folder:

```bash
composer require winter/wn-debugbar-plugin
```

### Usage

Set `debug` to `true` in `config/app.php` and the debugbar should appear on your site to all authenticated backend users with the `winter.debugbar.access_debugbar` permission.

If you would like to make the debug bar accessible to all users, regardless of authentication and permissions, set `allow_public_access` to `true` in the configuration file.

See [barryvdh/laravel-debugbar](https://github.com/barryvdh/laravel-debugbar) for more usage instructions and documentation.

### Configuration

All configuration for the plugin is found in the `plugins/winter/debugbar` directory. To override any of these settings, create an override file called `config/winter/debugbar/config.php` in your local system.

To include exceptions in the response header of AJAX calls, set `debugAjax` to `true` in `config/app.php`.

Events are not captured by default since it can slow down the front-end when many events are fired, you may enable it with the `collectors.events` setting.