Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dominion-solutions/filament-captcha
CAPTCHA plugin for Filament
https://github.com/dominion-solutions/filament-captcha
filament-form filament-plugin filamentphp filamentphp-plugin php82
Last synced: about 1 month ago
JSON representation
CAPTCHA plugin for Filament
- Host: GitHub
- URL: https://github.com/dominion-solutions/filament-captcha
- Owner: dominion-solutions
- License: mit
- Created: 2024-01-23T21:03:05.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-07T19:06:26.000Z (7 months ago)
- Last Synced: 2024-07-13T11:24:43.329Z (4 months ago)
- Topics: filament-form, filament-plugin, filamentphp, filamentphp-plugin, php82
- Language: PHP
- Homepage:
- Size: 74.2 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# CAPTCHA Plugin for Filament
[](https://packagist.org/packages/dominion-solutions/filament-captcha)
[](https://github.com/dominion-solutions/filament-captcha/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/dominion-solutions/filament-captcha/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/dominion-solutions/filament-captcha)
CAPTCHA Support in Filament!
[Skip to Installation](#installation)
### What Is CAPTCHA?
CAPTCHA stands for Completely Automated Public Turing test to tell Computers and Humans Apart. The goal of this package is to keep bots from being able to submit fake data on your forms. This should be the last (and not first) line of defense to keep bots from submitting garbage data to your unprotected forms.
### Why do I need it?
If you're using a public panel within your application to collect data, for example a comment box, or a lead funnel, it can be (at best) annoying or (worst) a security liability for bots to try to be able to submit data to a form.
## Installation
You can install the package via composer:
```bash
composer require dominion-solutions/filament-captcha
```
You will also need a Captcha Provider. Filament Captcha supports the following providers:
| Provider | Composer Package | Install Instructions |
| -------- | ---------------- | -------------------- |
| {m’e} Web Studio Captcha | `composer require mews/captcha` | [Installation](https://github.com/mewebstudio/captcha?tab=readme-ov-file#installation) |
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-captcha-config"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-captcha-views"
```
This is the contents of the published config file:
```php
return [
'engine' => env('CAPTCHA_ENGINE', 'mews'),
];
```
## Usage
Usage with `mews/captcha`
```php
public function form(Form $form): Form
{
return $form->schema([
Captcha::make('captcha')
->rules(['captcha'])
->required()
->validationMessages([
'captcha' => __('Captcha does not match the image'),
]),
]);
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Mark J. Horninger](https://github.com/dominion-solutions)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.