Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.69 KB

readme.md

File metadata and controls

82 lines (53 loc) · 2.69 KB
Raw

Blockade

A simple block for your Laravel app to prevent access without a known code, and to force to https if you wish.*

Installation

  • Install Blockade using composer: composer require konsulting/laravel-blockade

  • If you are using Laravel 5.5 or above, the package will make the service provider available for auto-discovery. If you are using an earlier version of Laravel, add Blockade's Service Provider to config/app.php

'providers' => [
    // Other service providers...

    Konsulting\Laravel\Blockade\BlockadeServiceProvider::class,
],
  • Add the middleware to your app/Http/Kernel.php
protected $middlewareGroups = [
        'web' => [
            ... Other middleware
            \Konsulting\Laravel\Blockade\IsBlocked::class,
            \Konsulting\Laravel\Blockade\ForceSecure::class,
        ],
        ... Other middleware groups
    ];

Only add the middleware you want to use.

  • Publish configuration and adjust for your site
php artisan vendor:publish --provider=Konsulting\\Laravel\\Blockade\\BlockadeServiceProvider --tag=config
  • Optionally publish views and adjust for your site
php artisan vendor:publish --provider=Konsulting\\Laravel\\Blockade\\BlockadeServiceProvider --tag=views

Configuration Options

There is a small set of configuration options. See the blockade.php config file for more information.

key - the variable name for the 'unlock code' to be used when checking is the site is blocked.

code - the code that allows access, it can be set using the environment variable BLOCKADE_CODE in the .env file

multiple_codes - whether or not to allow multiple codes to be used (specified as a comma-delimited list). Defaults to false

show_form - should Blockade show a form for the user to enter the code? defaults to false

redirect - optional url to redirect the user to when blocked

until - optional datetime for the blockade to expire

not_blocked - an array of url patterns that should not be blocked

not_secure - an array of url patterns that should not be forced to https

Security

If you find any security issues, or have any concerns, please email keoghan@klever.co.uk, rather than using the issue tracker.

Contributing

Contributions are welcome and will be fully credited. We will accept contributions by Pull Request.

Please:

  • Use the PSR-2 Coding Standard
  • Add tests, if you’re not sure how, please ask.
  • Document changes in behaviour, including readme.md.

Testing

We use PHPUnit and the excellent orchestral/testbench

Run tests using PHPUnit: vendor/bin/phpunit