Skip to content

Installation

Installation

Requirements

  • PHP 8.4+
  • Laravel 12.x or 13.x

See Requirements for the exact Composer constraints.

Install via Composer

composer require cboxdk/laravel-health

The package auto-discovers its service provider. No manual registration is needed.

Publish Configuration

php artisan vendor:publish --tag="health-config"

This creates config/health.php with all default values.

Publish Views (optional)

To customize the dashboard template:

php artisan vendor:publish --tag="health-views"

The views are copied to resources/views/vendor/health.

Verify Installation

curl http://localhost/health

A 200 response with JSON output confirms the package is working. The default liveness endpoint runs a database check and is public, so no token is needed. You can also run the checks from the terminal:

php artisan health:check