README

A simple Laravel package to protect your application (or specific routes) with Basic Authentication. This is particularly useful for staging or preview environments where you want to restrict access without setting up complex authentication.

Installation

You can install the package via composer:

composer require kommandhub/laravel-folder-protection

The service provider will automatically register itself.

Publish Configuration

You can publish the configuration file using:

php artisan vendor:publish --tag="folder-protection-config"

This will create a config/folder-protection.php file in your application.

Configuration

You can configure the protection using environment variables in your .env file:

FOLDER_PROTECTION_ENABLED=true
FOLDER_PROTECTION_USER=your_username
FOLDER_PROTECTION_PASSWORD=your_password

Default Behavior

By default, the protection is enabled only when APP_ENV is set to staging.

Note: The package also supports APP_FOLDER_PROTECTION_USER and APP_FOLDER_PROTECTION_PASSWORD for backward compatibility.

Usage

Global Middleware

To protect your entire application, add the middleware to your bootstrap/app.php (Laravel 11+) or app/Http/Kernel.php (Laravel 10 and below).

Laravel 11 & 12

// bootstrap/app.php
->withMiddleware(function (Middleware $middleware) {
    $middleware->append(\KommandHub\FolderProtection\Http\Middleware\FolderProtection::class);
})

Laravel 10 and below

// app/Http/Kernel.php
protected $middleware = [
    // ...
    \KommandHub\FolderProtection\Http\Middleware\FolderProtection::class,
];

Route-specific Middleware

You can also apply the middleware to specific routes or groups:

Route::middleware([\KommandHub\FolderProtection\Http\Middleware\FolderProtection::class])->group(function () {
    Route::get('/staging-only', function () {
        // ...
    });
});

Testing

composer test

Code Coverage

To run tests with code coverage (requires Xdebug or PCOV):

composer test:coverage

The coverage reports will be generated in build/coverage.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• KommandHub
• All Contributors

License

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