Skip to content

Commit fc6ec47

Browse files
authored
Update readme.md
1 parent 14c7b64 commit fc6ec47

File tree

1 file changed

+59
-1
lines changed

1 file changed

+59
-1
lines changed

readme.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
<a href="#usage">Usage</a>
1111
</p>
1212

13-
![sql-viewer](https://github.com/user-attachments/assets/5a7730a9-1cac-4b6c-a00d-6fa938a32d48)
13+
![sql-viewer](https://github.com/user-attachments/assets/f57fe1d8-45f5-421f-ada4-17aad5b54536)
14+
1415

1516
### Documentation
1617

@@ -37,6 +38,63 @@ After installing the package, publish the front-end assets by running:
3738
php artisan sql-viewer:install
3839
```
3940

41+
This is the content that will be published to config/sql-viewer.php
42+
43+
```php
44+
return [
45+
/*
46+
* By default this package will only run in local development.
47+
* Do not change this, unless you know what your are doing.
48+
*/
49+
'enabled' => env('SQL_VIEWER_ENABLED', env('APP_ENV') === 'local'),
50+
51+
/*
52+
* The SqlViewer page will be available on this path.
53+
*/
54+
'path' => env('SQL_VIEWER_PATH', 'sql-viewer'),
55+
56+
/*
57+
* These middleware will be assigned to every SqlViewer route, giving you the chance
58+
* to add your own middlewares to this list or change any of the existing middleware.
59+
*/
60+
'middleware' => [
61+
'web',
62+
// Uncomment this if you want to add auth middleware
63+
// 'auth',
64+
],
65+
66+
/*
67+
* These emails will be allowed to access the SqlViewer.
68+
*/
69+
'allowed_emails' => [
70+
// 'admin@example.com',
71+
],
72+
73+
/*
74+
* These fields will be hidden (marked with *) from the SqlViewer result table by default.
75+
*/
76+
'hidden_fields' => [
77+
'password',
78+
'token',
79+
'secret',
80+
'api_key',
81+
'credit_card',
82+
'card_number'
83+
],
84+
85+
/*
86+
* Forbidden actions in SQL queries
87+
*/
88+
'forbidden_actions' => [
89+
'drop',
90+
'truncate',
91+
'delete',
92+
'insert',
93+
],
94+
];
95+
96+
```
97+
4098
### Usage
4199

42100
Once the installation is complete, you will be able to access **SQL Viewer** directly in your browser.

0 commit comments

Comments
 (0)