@google-cloud/recaptcha-edge
v1.0.5
Published
A reCAPTCHA Enterprise Typescript library for Edge Compute Platforms.
Readme
reCAPTCHA Edge Compute Library
A library to access reCAPTCHA Enterprise via various edge compute platforms. The currently supported platforms are:
Usage
This project is intended to be used in one of two ways:
- Using a prebuilt package uploaded to your edge compute platform of choice.
- or imported as an NPM package for advanced use-cases.
Prebuilt Package
Check the 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 feature.
Typically, this involves:
- Create the appropriate reCAPTCHA Site Keys in Google Cloud reCAPTCHA Console.
- 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 for more details on each step.
As a Library
Each platform has their own NPM package. Bindings that are hosted on NPM include:
Bindings that are not yet hosted on NPM should be downloaded and installed locally.
The base package is available on NPM as @google-cloud/recaptcha-edge and is intended as an abstraction layer for implementing additional platforms. Platform-specific packages should be used if possible.
Please see the examples and documentation for each binding in the bindings directory of choice.
Contribution
Please see our Contribution guidelines.
Issues and Support
For technical issues, please see the reCAPTCHA Enterprise Support Documentation.
For bugs or issues specifically with this codebase, please open a new Github issue in this project.
