https://github.com/anselmh/kirby-uniform-turnstile

A Kirby 3 plugin implementing a Cloudflare Turnstile guard for the Uniform plugin.
https://github.com/anselmh/kirby-uniform-turnstile

kirby-3 kirby-cms kirby-plugin kirby-plugins kirby3 kirby3-plugin

Last synced: 25 days ago
JSON representation

A Kirby 3 plugin implementing a Cloudflare Turnstile guard for the Uniform plugin.

• Host: GitHub
• URL: https://github.com/anselmh/kirby-uniform-turnstile
• Owner: anselmh
• License: mit
• Created: 2022-11-10T09:40:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-01T19:46:23.000Z (over 1 year ago)
• Last Synced: 2024-08-10T10:19:30.985Z (3 months ago)
• Topics: kirby-3, kirby-cms, kirby-plugin, kirby-plugins, kirby3, kirby3-plugin
• Language: PHP
• Homepage:
• Size: 11.7 KB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Uniform Cloudflare Turnstile Guard

A [Kirby 3](https://getkirby.com/) plugin implementing a [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/) guard for the [Uniform](https://github.com/mzur/kirby-uniform) plugin.

## Installation

### Composer

Add the plugin to your project:

```

composer require anselmh/kirby-uniform-turnstile

```

### Manual install

It is possible to install plugins manually. Download from the Github Releases page, unpack the archive and put it into `site/plugins`.

Please note that this project depends on [Uniform](https://github.com/mzur/kirby-uniform) so it is required to install this package as well.

## Configuration

Set the configuration in your `config.php` file:

```php

return [

  'anselmh.uniform-turnstile.siteKey' => 'my-site-key',

  'anselmh.uniform-turnstile.secretKey' => 'my-secret-key',

];

```

## Usage

### Template

You can use the provided helper function to embed the Turnstile into your template:

```html+php

= turnstileField() ?>

```

In order for turnstile to work, you need to provide the Turnstile JavaScript file.

Use the helper function `turnstileScript()` in your template or add it to the template at right before the closing `