rappasoft/lockout

Put your Laravel application into read-only mode.

Fund package maintenance!
rappasoft

v3.0.1 2020-12-13 05:41 UTC

This package is auto-updated.

Last update: 2021-07-13 06:58:16 UTC


README

Package Logo

Latest Version on Packagist Run Tests StyleCI Code Coverage Quality Score Total Downloads

A simple .env flag that can place your application into read-only mode. By default only get requests are allowed. You can optionally allow authentication.

Installation

You can install the package via composer:

composer require rappasoft/lockout

Version Compatibility

Laravel Lockout
6.x 1.x
7.x 2.x
8.x 3.x

Publish

You can publish the configuration file to override the defaults:

php artisan vendor:publish --provider="Rappasoft\Lockout\LockoutServiceProvider"

Usage

Enable

Add to .env file

APP_READ_ONLY = true

By default only pages accessed with GET requests will be allowed, everything else will throw a 401 Unauthorized response. You can modify the blocked request types in the lockout configuration file.

Configure

To optionally allow logging into the application to view secure areas, after login only GET requests will still be allowed.

APP_READ_ONLY_LOGIN = true

You can set your login/logout paths from the configuration file if they differ from the Laravel default.

Locking GET Pages

If you want to block access to regular pages in addition to the lockout types, or just by themselves you can edit the pages array of the config file:

'pages' => [
    'register', // Blocks access to the register page
],

Conditionally Rendering Views

You may conditionally render views based on the status of the lockout with this blade helper:

@readonly
    Sorry for the inconvenience, but our application is currently in read-only mode. Please check back soon.
@endreadonly

Whitelisting Pages

You may whitelist certain paths for certain methods. I.e. part of your application is behind the password.confirm middleware and you want the demo user to be able to access it.

'whitelist' => [
    'post' => '/password/confirm',
],

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email rappa819@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.