https://github.com/googlecloudplatform/recaptcha-edge

NPM libraries and binary distributions for accessing reCAPTCHA at the Edge
https://github.com/googlecloudplatform/recaptcha-edge

bot-management edge-computing google-cloud recaptcha security waf

Last synced: 6 months ago
JSON representation

NPM libraries and binary distributions for accessing reCAPTCHA at the Edge

• Host: GitHub
• URL: https://github.com/googlecloudplatform/recaptcha-edge
• Owner: GoogleCloudPlatform
• License: apache-2.0
• Created: 2024-10-10T20:33:44.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-04-02T17:43:31.000Z (6 months ago)
• Last Synced: 2025-04-02T18:32:31.099Z (6 months ago)
• Topics: bot-management, edge-computing, google-cloud, recaptcha, security, waf
• Language: TypeScript
• Homepage: https://cloud.google.com/security/products/recaptcha
• Size: 1.47 MB
• Stars: 2
• Watchers: 7
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# reCAPTCHA WAF (Edge Compute) Library

[![Build and Test Core Library](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_core.yml/badge.svg)](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_core.yml)

[![Build and Test Akamai Binding](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_akamai.yml/badge.svg)](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_akamai.yml)

[![Build and Test Cloudflare Binding](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_cloudflare.yml/badge.svg)](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_cloudflare.yml)

[![Build and Test Fastly Binding](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_fastly.yml/badge.svg)](https://github.com/GoogleCloudPlatform/recaptcha-edge/actions/workflows/build_fastly.yml)

A library to access reCAPTCHA Enterprise via various edge compute platforms. The currently supported platforms are:

* [Cloudflare](https://github.com/GoogleCloudPlatform/recaptcha-edge/tree/main/bindings/cloudflare)

* [Fastly](https://github.com/GoogleCloudPlatform/recaptcha-edge/tree/main/bindings/fastly)

## Usage

This project is intended to be used in one of two ways:

1. Using a prebuilt package uploaded to your edge compute platform of choice.

2. or imported as an NPM package for advanced use-cases.

### Prebuilt Package

Check the [Releases](https://github.com/GoogleCloudPlatform/recaptcha-edge/releases) page for the most recent build for your edge compute platform of choice. 

The prebuilt packages are intended to be used with the [reCAPTCHA Firewall Policies](https://cloud.google.com/recaptcha/docs/firewall-policies-overview) feature.

Typically, this involves:

* Create the appropriate reCAPTCHA Site Keys in [Google Cloud reCAPTCHA Console](https://console.cloud.google.com/security/recaptcha).

* Upload and install the package to your edge compute platform.

* Configure the package to use the created reCAPTCHA Site Keys.

* Create a set of Firewall Policies to protect sensitive pages or actions.

Please see the [reCAPTCHA Google Cloud Documentation](https://cloud.google.com/recaptcha/docs) for more details on each step.

### As a Library

This package has not yet been added to the NPM package repository, and must be manually imported.

Please see the examples for each binding in the [bindings](https://github.com/GoogleCloudPlatform/recaptcha-edge/tree/main/bindings) directory of choice.

## Contribution

Please see our [Contribution](https://github.com/GoogleCloudPlatform/recaptcha-edge/blob/main/CONTRIBUTING.md) guidelines.

## Issues and Support

For technical issues, please see the [reCAPTCHA Enterprise Support Documentation](https://cloud.google.com/recaptcha/docs/getting-support).

For bugs or issues specifically with this codebase, please open a new [Github issue](https://github.com/GoogleCloudPlatform/recaptcha-edge/issues) in this project.