Skip to content

Commit aacb254

Browse files
Merge pull request #5685 from Countly/create-readme-file-for-recaptcha
Create readme file for recaptcha
2 parents 41fae6f + 2350c75 commit aacb254

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

plugins/recaptcha/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Recaptcha plugin
2+
3+
The reCAPTCHA plugin for Countly is designed to integrate Google's reCAPTCHA service into your Countly analytics platform. This plugin helps protect your application from spam and abuse while ensuring a smooth user experience. It provides an easy-to-use API for managing reCAPTCHA verification and includes robust functionality for displaying reCAPTCHA challenges.
4+
5+
## File Structure
6+
7+
File structure follows usual Countly plugin structure
8+
```
9+
recaptcha/
10+
├── api/
11+
│ └── api.js
12+
├── frontend/
13+
│ ├── public
14+
│ │ ├── javascripts
15+
│ │ │ ├── countly.models.js
16+
│ │ │ └── countly.views.js
17+
│ │ ├── localization # all localization files
18+
│ │ └── stylesheets
19+
│ └── app.js # reCAPTCHA integration for Countly login
20+
├── install.js
21+
├── package.json
22+
├── README.md
23+
└── tests.js # plugin tests
24+
```
25+
26+
## Configuration
27+
28+
The reCAPTCHA plugin for Countly requires a site key and a secret key from the Google reCAPTCHA admin console. Both keys are essential for the plugin to function correctly and ensure secure verification. In the recaptcha settings in Countly, there is a link to the Google reCAPTCHA admin page.

0 commit comments

Comments
 (0)