This commit is contained in:
realaravinth 2021-05-30 20:52:54 +05:30
parent dea99209a0
commit abe6fd403f
No known key found for this signature in database
GPG key ID: AD9F0F08E855ED88

View file

@ -56,23 +56,27 @@ to their request.
## Why use mCaptcha? ## Why use mCaptcha?
- **Free software, privacy focused** - [x] **Free software, privacy focused**
- **Seamless UX** - No more annoying CAPTCHAs! - [x] **Seamless UX** - No more annoying CAPTCHAs!
- **IP address independent:** your users are behind a NAT? We got you covered! - [x] **No tracking:** Our CAPTCHA routes are cookie free!
- **Automatic bot throttling:** - [x] **IP address independent:** your users are behind a NAT? We got you covered!
- **Resistant to replay attacks:** proof-of-work configurations have - [x] **Resistant to replay attacks:** proof-of-work configurations have
short lifetimes(30s) and can be used only once. If a user submits a short lifetimes(30s) and can be used only once. If a user submits a
PoW to an already used configuration or an expired one, their proof PoW to an already used configuration or an expired one, their proof
will be rejected. will be rejected.
## Demo ## Demo
## Client-side widget: ## Client-side widget:
1. [Link to widget](https://demo.mcaptcha.org/widget?sitekey=RnR9SvkkB2s1W9yrQSBBViJHLvuiXKo4) mCaptcha's UX is super silent, solving CAPTCHAs have never been more
easier. One click and you are on your way.
To observe mCaptcha in action, open dev tools and
monitor console and network activity.
2. [Video]('https://github.com/mCaptcha/guard/blob/master/docs/res/widget-in-action.mp4?raw=true): 1. [Link to widget](https://demo.mcaptcha.org/widget?sitekey=RnR9SvkkB2s1W9yrQSBBViJHLvuiXKo4)(opens https://demo.mcaptcha.org)
To observer, you need to open dev tools
2. [Video](https://github.com/mCaptcha/guard/blob/master/docs/res/widget-in-action.mp4?raw=true):
### Demo servers are available at: ### Demo servers are available at:
@ -93,10 +97,14 @@ Clone the repo and run the following from the root of the repo:
```bash ```bash
$ docker-compose -d up $ docker-compose -d up
``` ```
It takes a while to build the image so please be patient :) It takes a while to build the image so please be patient :)
See [DEPLOYMENT.md](./docs/DEPLOYMET.md) detailed alternate deployment
methods.
## Development: ## Development:
See [HACKING.md](./docs/HACKING.md) See [HACKING.md](./docs/HACKING.md)