README

A plugin to help you implement the Cloudflare Turnstile into your Filament panels.

This extension leverages Laravel Turnstile under the hood. For more details, please refer to the README on the project page.
Kudos to coderflexx for his remarkable work.

Installation

You can install the package via composer:

composer require afatmustafa/filamentv3-turnstile

Getting Started

To include Cloudflare Turnstile in your app, you'll first need to obtain both the SiteKey and the SecretKey from your Cloudflare dashboard.

Once you have the keys, populate the TURNSTILE_SITE_KEY and TURNSTILE_SECRET_KEY fields in your .env configuration:

TURNSTILE_SITE_KEY=2x00000000000000000000AB
TURNSTILE_SECRET_KEY=2x0000000000000000000000000000000AA

For testing purposes, Cloudflare offers Dummy site keys and secret keys. Consider using them if needed.

TURNSTILE_SITE_KEY=1x00000000000000000000AA
TURNSTILE_SECRET_KEY=1x0000000000000000000000000000000AA

More dummy keys, please refer to the Cloudflare documentation.

Form Component Usage

Now using Turnstile is quite simple, all you need to do is follow the code below:

use Afatmustafa\FilamentTurnstile\Forms\Components\Turnstile;

    Turnstile::make('turnstile')
        ->theme('light') // Supported themes: light, dark
        ->size('normal') // Supported sizes: normal, compact
        ->language('en-US') // Supported languages: ar-eg,de,en,es,fa,fr,id,it,ja,ko,nl,pl,pt-br,ru,tr,uk,zh-cn and zh-tw

Integrating Turnstile Captcha to Filament's Login Page

To seamlessly integrate the Turnstile captcha with the login page in Filament, follow these steps:

Create a new Login class under the app/Filament\Pages\Auth directory, and extend it from the Filament\Pages\Auth\Login class.
Override the form method, and add the Turnstile component to the form schema.

namespace App\Filament\Pages\Auth;

use Filament\Forms\Form;
use Afatmustafa\FilamentTurnstile\Forms\Components\Turnstile;

class Login extends \Filament\Pages\Auth\Login
{
    public function form(Form $form): Form
    {
        return $form
            ->schema([
                $this->getEmailFormComponent(),
                $this->getPasswordFormComponent(),
                $this->getRememberFormComponent(),
                Turnstile::make('turnstile')
                    ->theme('light')
                    ->size('normal')
                    ->language('en-US'),
            ])
            ->statePath('data');
    }
}

2. In your PanelProvider file, override the login method, and return the newly created Login class.

namespace App\Providers\Filament;

...
use App\Filament\Pages\Auth\Login;
...

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->default()
            ->id('admin')
            ->path('app')
            ->login(Login::class)
            ...
    }
}

3. That's it! You should now see the Turnstile captcha on the login page.

Testing

composer test

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

License

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

afatmustafa / filamentv3-turnstile

Maintainers

Details