Skip to content
This repository was archived by the owner on Aug 14, 2026. It is now read-only.

README.md

Latest commit

 

History

History
102 lines (64 loc) · 2.19 KB

README.md

File metadata and controls

102 lines (64 loc) · 2.19 KB
Raw
DebugPHP Server

Self-hosted real-time debugging dashboard for PHP.

This is the server and dashboard component of DebugPHP.

License: MIT PHP Version PHPStan

Requirements

  • PHP 8.1+
  • Composer

Installation

Option A — PHP built-in server

git clone https://github.com/CallMeLeon167/debugphp-server.git
cd debugphp-server
composer install
php -S localhost:8787

Option B — Docker

git clone https://github.com/CallMeLeon167/debugphp-server.git
cd debugphp-server
docker compose up

Connecting your PHP app

Install the client package in your PHP application:

composer require callmeleon167/debugphp --dev

Then initialize it with your session token from the dashboard:

use DebugPHP\Debug;

Debug::init('your-session-token', [
    'host' => 'http://localhost:8080',
]);

Debug::send('Hello DebugPHP!');
Debug::send($user, 'User')->color('blue');

Running inside Docker?

Enable auto-detection so the client finds the server automatically:

Debug::init('your-session-token', [
    'dockerized' => true,
]);

See the DebugPHP client repository for the full API documentation.

Re-running the setup

If you need to reconfigure the server after initial setup, set ALLOW_SETUP to true in setup/index.php, run the wizard, then set it back to false.

Contributing

Please read CONTRIBUTING.md before opening a pull request.

License

MIT — see LICENSE for details.

Links