Search by

maarheeze / compass-client-laravel

wietsewarendorff

exposes the status of a laravel site to compass

Package info

github.com/maarheeze/compass-client-laravel

pkg:composer/maarheeze/compass-client-laravel

Statistics

Installs: 22

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

1.4.1 2026-11-10 16:10 UTC

This package is auto-updated.

Last update: 2026-11-10 16:10:26 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 paths Compass checks for uptime, separated by a comma, defaults to /:

COMPASS_CLIENT_UPTIME_CHECK_PATHS=/,/contact

The names of the routes Compass checks for uptime, separated by a comma, defaults to none. They are reported as their paths, so a route with required parameters cannot be used:

COMPASS_CLIENT_UPTIME_CHECK_ROUTES=home,contact

When Laravel Nightwatch is installed, the requests from Compass are left out of it. To record them anyway:

COMPASS_CLIENT_NIGHTWATCH_IGNORE=false

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