Skip to content

Commit 9a080da

Browse files
ssddanbrownssddanbrown
committed
Added debugbar config
- Set debugbar support for APP_URL - Set debugbar to not show by default in debug mode. Closes BookStackApp#1508
1 parent 762d1d7 commit 9a080da

File tree

1 file changed

+132
-0
lines changed

1 file changed

+132
-0
lines changed

‎config/debugbar.php‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<?php
2+
3+
/**
4+
* Debugbar Configuration Options
5+
*
6+
* Changes to these config files are not supported by BookStack and may break upon updates.
7+
* Configuration should be altered via the `.env` file or environment variables.
8+
* Do not edit this file unless you're happy to maintain any changes yourself.
9+
*/
10+
11+
return [
12+
13+
// Debugbar is enabled by default, when debug is set to true in app.php.
14+
// You can override the value by setting enable to true or false instead of null.
15+
//
16+
// You can provide an array of URI's that must be ignored (eg. 'api/*')
17+
'enabled' => env('DEBUGBAR_ENABLED', false),
18+
'except' => [
19+
'telescope*'
20+
],
21+
22+
23+
// DebugBar stores data for session/ajax requests.
24+
// You can disable this, so the debugbar stores data in headers/session,
25+
// but this can cause problems with large data collectors.
26+
// By default, file storage (in the storage folder) is used. Redis and PDO
27+
// can also be used. For PDO, run the package migrations first.
28+
'storage' => [
29+
'enabled' => true,
30+
'driver' => 'file', // redis, file, pdo, custom
31+
'path' => storage_path('debugbar'), // For file driver
32+
'connection' => null, // Leave null for default connection (Redis/PDO)
33+
'provider' => '' // Instance of StorageInterface for custom driver
34+
],
35+
36+
// Vendor files are included by default, but can be set to false.
37+
// This can also be set to 'js' or 'css', to only include javascript or css vendor files.
38+
// Vendor files are for css: font-awesome (including fonts) and highlight.js (css files)
39+
// and for js: jquery and and highlight.js
40+
// So if you want syntax highlighting, set it to true.
41+
// jQuery is set to not conflict with existing jQuery scripts.
42+
'include_vendors' => true,
43+
44+
// The Debugbar can capture Ajax requests and display them. If you don't want this (ie. because of errors),
45+
// you can use this option to disable sending the data through the headers.
46+
// Optionally, you can also send ServerTiming headers on ajax requests for the Chrome DevTools.
47+
48+
'capture_ajax' => true,
49+
'add_ajax_timing' => false,
50+
51+
// When enabled, the Debugbar shows deprecated warnings for Symfony components
52+
// in the Messages tab.
53+
'error_handler' => false,
54+
55+
// The Debugbar can emulate the Clockwork headers, so you can use the Chrome
56+
// Extension, without the server-side code. It uses Debugbar collectors instead.
57+
'clockwork' => false,
58+
59+
// Enable/disable DataCollectors
60+
'collectors' => [
61+
'phpinfo' => true, // Php version
62+
'messages' => true, // Messages
63+
'time' => true, // Time Datalogger
64+
'memory' => true, // Memory usage
65+
'exceptions' => true, // Exception displayer
66+
'log' => true, // Logs from Monolog (merged in messages if enabled)
67+
'db' => true, // Show database (PDO) queries and bindings
68+
'views' => true, // Views with their data
69+
'route' => true, // Current route information
70+
'auth' => true, // Display Laravel authentication status
71+
'gate' => true, // Display Laravel Gate checks
72+
'session' => true, // Display session data
73+
'symfony_request' => true, // Only one can be enabled..
74+
'mail' => true, // Catch mail messages
75+
'laravel' => false, // Laravel version and environment
76+
'events' => false, // All events fired
77+
'default_request' => false, // Regular or special Symfony request logger
78+
'logs' => false, // Add the latest log messages
79+
'files' => false, // Show the included files
80+
'config' => false, // Display config settings
81+
'cache' => false, // Display cache events
82+
],
83+
84+
// Configure some DataCollectors
85+
'options' => [
86+
'auth' => [
87+
'show_name' => true, // Also show the users name/email in the debugbar
88+
],
89+
'db' => [
90+
'with_params' => true, // Render SQL with the parameters substituted
91+
'backtrace' => true, // Use a backtrace to find the origin of the query in your files.
92+
'timeline' => false, // Add the queries to the timeline
93+
'explain' => [ // Show EXPLAIN output on queries
94+
'enabled' => false,
95+
'types' => ['SELECT'], // ['SELECT', 'INSERT', 'UPDATE', 'DELETE']; for MySQL 5.6.3+
96+
],
97+
'hints' => true, // Show hints for common mistakes
98+
],
99+
'mail' => [
100+
'full_log' => false
101+
],
102+
'views' => [
103+
'data' => false, //Note: Can slow down the application, because the data can be quite large..
104+
],
105+
'route' => [
106+
'label' => true // show complete route on bar
107+
],
108+
'logs' => [
109+
'file' => null
110+
],
111+
'cache' => [
112+
'values' => true // collect cache values
113+
],
114+
],
115+
116+
// Inject Debugbar into the response
117+
// Usually, the debugbar is added just before </body>, by listening to the
118+
// Response after the App is done. If you disable this, you have to add them
119+
// in your template yourself. See http://phpdebugbar.com/docs/rendering.html
120+
'inject' => true,
121+
122+
// DebugBar route prefix
123+
// Sometimes you want to set route prefix to be used by DebugBar to load
124+
// its resources from. Usually the need comes from misconfigured web server or
125+
// from trying to overcome bugs like this: http://trac.nginx.org/nginx/ticket/97
126+
'route_prefix' => '_debugbar',
127+
128+
// DebugBar route domain
129+
// By default DebugBar route served from the same domain that request served.
130+
// To override default domain, specify it as a non-empty value.
131+
'route_domain' => env('APP_URL', '') === 'http://bookstack.dev' ? '' : env('APP_URL', ''),
132+
];

0 commit comments

Comments
 (0)