maarheeze / compass-client-laravel

1.2.0 2026-10-23 15:57 UTC

Requires

• php: ^8.3
• laravel/framework: ^13.17

Requires (Dev)

• larastan/larastan: ^3.13
• maarheeze/guidelines: ^1.8
• maarheeze/phpcs: ^4.0
• orchestra/testbench: ^11.3
• phpunit/phpunit: ^13

MIT

• compass
• monitoring
• laravel

Published on Packagist.org on 2026-10-24 09:15 UTC

README

Exposes the status of a Laravel site to Compass. It registers a single route that Compass reads, guarded by a bearer token and reachable during maintenance mode.

Installation

composer require maarheeze/compass-client-laravel

The package auto-registers via Laravel's package discovery.

Configuration

Set the key Compass sends as a bearer token. It is the same key on every site and in Compass itself:

COMPASS_CLIENT_KEY=your-key

If you want to override the path the status is served at, which defaults to /_compass:

COMPASS_CLIENT_PATH=/_compass

The endpoints Compass checks for uptime, separated by a comma, defaults to /:

COMPASS_CLIENT_ENDPOINTS=/,/contact

Publishing the config

To customize settings beyond the environment variables, publish the config file to config/compass-client.php:

php artisan vendor:publish --tag=compass-client-config

License

MIT