I had to change the name of server from RayServer to Debugger. Please use a new docker repo
butschster/debugger
docker run --pull always -p 23517:8000 -p 1025:1025 -p 9912:9912 butschster/debugger:latest
Debugger is a beautiful, lightweight web server built on Laravel and VueJs that helps debugging your app. It runs without installation on multiple platforms.
1. Symfony VarDumper server
The dump()
and dd()
functions output its contents in the same browser window or console terminal as your own application. Sometimes mixing the real output with the debug output can be confusing. That’s why this the Debugger can be used to collect all the dumped data. Debugger can display dump output in the browser as well as in a terminal (console output).
Example
VAR_DUMPER_FORMAT=server
VAR_DUMPER_SERVER=127.0.0.1:9912
Debugger also is an email testing tool that makes it super easy to install and configure a local email server (Like MailHog). Debugger sets up a fake SMTP server and you can configure your preferred web applications to use Debugger’s SMTP server to send and receive emails. For instance, you can configure a local WordPress site to use Debugger for email deliveries.
Example
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
Debugger can be used to receive Sentry reports from your application. Debugger is a lightweight alternative for local development. Just configure Sentry DSN to send data to Debugger. It can display dump output in the browser as well as in a terminal (console output).
Simple example SENTRY_LARAVEL_DSN=http:https://[email protected]:23517/1
.
4. Compatible with Monolog
Debugger can receive logs from monolog/monolog
package via \Monolog\Handler\SlackWebhookHandler
handler.
Example
LOG_CHANNEL=slack
LOG_SLACK_WEBHOOK_URL=http:https://127.0.0.1:23517/slack
5. Spatie Ray debug tool
Debugger is compatible with spatie/ray
package. The Ray debug tool supports PHP, Ruby, JavaScript, TypeScript, NodeJS, Go and Bash
applications. After installing one of the libraries, you can use the ray function to quickly dump stuff. Any variable(s) that you pass will be sent to the Debugger. Debugger can display dump output in the browser as well as in a terminal (console output).
Supported features: Simple data, Colors, Sizes, Labels, New screen, Clear all, Caller, Trace, Pause, Counter, Class name of an object, Measure, Json, Xml, Carbon, File, Table, Image, Html, Text, Notifications, Phpinfo, Exception, Show queries, Count queries, Show events, Show jobs, Show cache, Model, Show views, Markdown, Collections, Env, Response, Request, Ban, Charles, Remove, Hide/Show events, Application log, Show Http client requests, Mailable
Reas more about spatie/ray
package.
Example
RAY_HOST=127.0.0.1 # Ray server host
RAY_PORT=23517 # Ray server port
It is a free alternative of The Ray app for those who want to run a server without GUI, cannot afford the paid version or just like open source.
But it doesn’t mean you shouldn’t support spatie’s packages!
Debugger has a responsive design and a mobile device can be used as an additional screen for viewing event history. Also you can user a termial to collect dump output if you don't want to use a browser.
Code samples of configured Laravel application ready to send data to Debugger you can find here.
- A server for debugging more than just Laravel applications..
- Сервер для дебага Laravel приложений и не только.
- Laravel 8
- InertiaJs
- Swoole Http/Websocket/TCP server
- Vue
- TailwindCSS
You can run Debugger via docker from Docker Hub or using the provided Dockerfile
Just run on bash command
docker run --pull always -p 23517:8000 -p 1025:1025 -p 9912:9912 butschster/debugger:latest
# or
docker run -p 23517:8000 -p 1025:1025 -p 9912:9912 butschster/debugger:v1.15.2
- Configure your .env for VarDumper
VAR_DUMPER_FORMAT=server
VAR_DUMPER_SERVER=127.0.0.1:9912
- Configure your .env for mail
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
- Configure your .env for Sentry package
SENTRY_LARAVEL_DSN=http:https://[email protected]:23517/1
- Configure your .env for Ray package
RAY_HOST=127.0.0.1 # Debugger host
RAY_PORT=23517 # Debugger port
- Configure your .env for monolog logs
LOG_CHANNEL=slack
LOG_SLACK_WEBHOOK_URL=http:https://127.0.0.1:23517/slack
That's it. Now you open http:https://127.0.0.1:23517 url in your browser or terminal and collect dump output from your application.
Enjoy!
- PHP 8.0
- Swoole 4.7
- NodeJS
- Clone repository
- Run composer `composer install
- Run npm
npm i
- Run ray server
php artisan server:start --host=127.0.0.1 --port=23517
- Run smtp server
php artisan smtp:start --host=127.0.0.1 --port=1025
- Run var-dumper server
php artisan dump-server:start --host=127.0.0.1 --port=9912
- Build npm
npm run prod
Debugger is open-sourced software licensed under the MIT license.