README

Give an ability to the user to lock their access without logging out of the system for a break.

Installation

You can install the package via Composer:

composer require marjose123/filament-lockscreen

Panel provider configuration:

use lockscreen\FilamentLockscreen\Lockscreen;
use lockscreen\FilamentLockscreen\Http\Middleware\Locker;
use lockscreen\FilamentLockscreen\Http\Middleware\LockerTimer;


public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            //.......
              Lockscreen::make()
                ->usingCustomTableColumns() // Use custom table columns. Default:  email, password.
                ->enableRateLimit() // Enable rate limit for the lockscreen. Default: Enable, 5 attempts in 1 minute.
                ->setUrl() // Customize the lockscreen url.
                ->enableIdleTimeout() // Enable auto lock during idle time. Default: Enable, 30 minutes.
               ->disableDisplayName() // Display the name of the user based on the attribute supplied. Default: name
               ->icon() // Customize the icon of the lockscreen.
               ->enablePlugin() // Enable the plugin.
        ]); 
}

Testing

composer test

Upgrade Guide

See UPGRADE from 2.x to 3.x

Changelog

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

Contributing

If you want to contribute to the Filament-lockerscreen package, you may want to test it in a real Laravel project:

Fork this repository to your GitHub account.
Create a Laravel app locally.
Clone your fork in your Laravel app's root directory.
In the /filament-lockscreen directory, create a branch for your fix, e.g. fix/error-message.

Install the packages in your app's composer.json:

{
   // ...
    "require": {
        "marjose123/filament-lockscreen": "*",
    },
    "repositories": [
        {
            "type": "path",
            "url": "filament-lockscreen"
        }
    ],
   // ...
}

Now, run composer update.

Security Vulnerabilities

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

Credits

License

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

marjose123 / filament-lockscreen

Maintainers

Details