From a075607baea7bd0606ea2a36737d2b0e22754498 Mon Sep 17 00:00:00 2001 From: realaravinth Date: Fri, 3 Dec 2021 14:48:33 +0530 Subject: [PATCH] Document pow section being renamed to captcha --- CHANGELOG.md | 5 +++++ docs/CONFIGURATION.md | 19 ++++++++++++++----- 2 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..825b988d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +## 0.1.0(unreleased) + +### Changed + +- Rename pow section in settings to captcha and add options to configure([`42544ec42`](https://github.com/mCaptcha/mCaptcha/commit/42544ec421e0c3ec4a8d132e6101ab4069bf0065)) diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index caca379d..97c6b251 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -59,12 +59,21 @@ you will be overriding the values set in the configuration files. \* Authentication doesn't work without `MCAPTCHA_DOMAIN` set to the correct domain -### Proof of work +### Captcha -| Name | Value | -| ------------------- | --------------------------------------------------------------------------------------- | -| `MCAPTCHA_POW_SALT` | Salt has to be long and random | -| `MCAPTCHA_POW_GC` | Garbage collection duration in seconds, requires tuning but 30 is a good starting point | +| Name | Value | +| --------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `MCAPTCHA_CAPTCHA_SALT` | Salt has to be long and random | +| `MCAPTCHA_CAPTCHA_GC` | Garbage collection duration in seconds, requires tuning but 30 is a good starting point | +| `MCAPTCHA_CAPTCHA_AVG_TRAFFIC_DIFFICULTY`% | Difficulty factor to use in CAPTCHA configuration estimation for average traffic metric | +| `MCAPTCHA_CAPTCHA_PEAK_TRAFFIC_DIFFICULTY`% | Difficulty factor to use in CAPTCHA configuration estimation for peak traffic metric | +| `MCAPTCHA_CAPTCHA_BROKE_MY_SITE_TRAFFIC_DIFFICULTY`% | Difficulty factor to use in CAPTCHA configuration estimation for traffic that took the website down | + +\% See commits +[`54b14291ec140e`](https://github.com/mCaptcha/mCaptcha/commit/54b14291ec140ea4cbbf73462d3d6fc2d39f2d2c) +and +[`42544ec421e0`](https://github.com/mCaptcha/mCaptcha/commit/42544ec421e0c3ec4a8d132e6101ab4069bf0065) +for more info. ### SMTP