Quick Start

Default Endpoints

After installation, these endpoints are available:

The UI dashboard is disabled by default.

Add a Check

Assign checks to probe endpoints in config/health.php. Liveness should be minimal (restart-worthy failures only). Readiness includes all dependencies:

use Cbox\LaravelHealth\Checks\RedisCheck;

'checks' => [
    'liveness' => [
        DatabaseCheck::class,         // only core dependency
    ],
    'readiness' => [
        DatabaseCheck::class,
        CacheCheck::class,
        QueueCheck::class,
        StorageCheck::class,
        RedisCheck::class,            // dependency checks go here
    ],
],

Why this split matters: if Redis goes down and RedisCheck is on liveness, Kubernetes restarts every pod — turning a Redis blip into a full outage. On readiness, pods stop receiving traffic but stay alive and recover when Redis returns. See Kubernetes Probes for the full guide.

Secure Endpoints

Set a bearer token via environment variable:

HEALTH_TOKEN=your-secret-token

Then authenticate requests:

curl -H "Authorization: Bearer your-secret-token" http://localhost/health/ready

The liveness endpoint is public by default. See Security for IP allowlists and custom auth.

Enable the Dashboard

In config/health.php:

'endpoints' => [
    'ui' => ['path' => '/ui', 'enabled' => true],
],

Visit /health/ui to see the HTML dashboard with real-time health status and system metrics.

Related Documentation

• Configuration
• Health Checks
• Endpoints
• Security