exolnet / laravel-status
Laravel module to get the status of a web application.
Requires
- php: ^8.1
- illuminate/filesystem: ^10.0|^11.0
- illuminate/routing: ^10.0|^11.0
- illuminate/support: ^10.0|^11.0
Requires (Dev)
- mockery/mockery: ^1.4
- orchestra/testbench: ^8.0|^9.0
- phpunit/phpunit: ^10.5
- squizlabs/php_codesniffer: ^3.6
README
The eXolnet Laravel Status package extends the base features available in Laravel.
Installation
Require this package with composer:
composer require exolnet/laravel-status
If you don't use package auto-discovery, add the service provider to the providers array in config/app.php:
Exolnet\Status\StatusServiceProvider::class
Usage
Health page
To see the health status, you have to access /health page.
SHA revision page
To see commit SHA version, you have to access /sha page. Be sure you have a revision file at the project root.
Testing
To run the phpUnit tests, please use:
composer test
Contributing
Please see CONTRIBUTING and CODE OF CONDUCT for details.
Security
If you discover any security related issues, please email security@exolnet.com instead of using the issue tracker.
Credits
License
This code is licensed under the MIT license. Please see the license file for more information.