Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teampanfu/laravel-turnstile
A Laravel package for Cloudflare's Turnstile service.
https://github.com/teampanfu/laravel-turnstile
captcha cloudflare laravel standalone turnstile
Last synced: 1 day ago
JSON representation
A Laravel package for Cloudflare's Turnstile service.
- Host: GitHub
- URL: https://github.com/teampanfu/laravel-turnstile
- Owner: teampanfu
- License: mit
- Created: 2023-07-17T00:43:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-17T22:50:23.000Z (over 1 year ago)
- Last Synced: 2025-01-22T13:05:48.446Z (25 days ago)
- Topics: captcha, cloudflare, laravel, standalone, turnstile
- Language: PHP
- Homepage: https://developers.cloudflare.com/turnstile
- Size: 16.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Turnstile for Laravel
[](https://github.com/teampanfu/laravel-turnstile/releases)
[](https://packagist.org/packages/teampanfu/laravel-turnstile)
[](LICENSE)
A package that seamlessly integrates [Cloudflare's Turnstile](https://developers.cloudflare.com/turnstile) service into your Laravel application.
## Installation
To install, use [Composer](https://getcomposer.org):
```sh
composer require teampanfu/laravel-turnstile
```
## Manual setup
As of Laravel 5.5, packages are automatically detected by [package discovery](https://laravel.com/docs/9.x/packages#package-discovery). So if you are using a newer version, you can skip these steps.
Add the following to your `config/app.php`:
```php
'providers' => [
...
/*
* Package Service Providers...
*/
Panfu\Laravel\Turnstile\TurnstileServiceProvider::class,
...
],
'aliases' => [
...
'Turnstile' => Panfu\Laravel\Turnstile\Facades\Turnstile::class,
...
],
```
Then publish the configuration file:
```php
php artisan vendor:publish --provider="Panfu\Laravel\Turnstile\TurnstileServiceProvider"
```
## Configuration
To get started, log in to the [Cloudflare Dashboard](https://dash.cloudflare.com), go to "Turnstile" in the side navigation, and add your website.
You will be given a site key and a secret key. You can add both to your `.env` file as follows:
```
TURNSTILE_SITEKEY=1x00000000000000000000AA
TURNSTILE_SECRET=1x0000000000000000000000000000000AA
```
## Usage
### Display
To display the widget on your website, you can simply add the following HTML code (assuming you are using [Blade](https://laravel.com/docs/blade)):
```html
```
*A list of [available configurations](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#configurations) (such as theme or language) can be found in the documentation.*
### Script
In order for the widget to work, you need to include the JavaScript resource. You can add the following HTML code for this:
```html
```
### Validation
To validate a request, you can use the following rule:
```php
$request->validate([
'cf-turnstile-response' => ['turnstile'],
]);
```
*You can leave out the `required` rule, it is already handled by this package.*
#### Custom validation message
You may want to display an error message in case the validation fails. Add the following to your `lang/[lang]/validation.php` file:
```php
'custom' => [
'cf-turnstile-response' => [
'turnstile' => 'The validation has failed.',
],
],
```
### Use without Laravel
Although the package is specifically designed for Laravel, it can still be used without it. Here is an example of how it works:
```php
validate($responseToken, $remoteip); // $remoteip is optional
if ($isValid) {
echo 'Token is valid.';
} else {
echo 'Token is not valid.';
}
exit;
}
?>
Submit
```
*Remote IP helps prevent abuses by ensuring that the current visitor is the one who received the token.*
## Testing
```sh
$ ./vendor/bin/phpunit
```
## Contribute
If you find a bug or have a feature suggestion, feel free to create a new issue or pull request.
We appreciate every contribution!
## License
This package is open-source software licensed under the [MIT License](LICENSE).