From 0d2c02348b5beb1dd5ccf6e03c42ed1e0a23bf16 Mon Sep 17 00:00:00 2001 From: Aravinth Manivannan Date: Mon, 16 Oct 2023 18:29:37 +0530 Subject: [PATCH] feat: document environment variable name changes --- docs/CONFIGURATION.md | 77 +++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 40 deletions(-) diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index cc31adbf..d964a484 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -21,54 +21,52 @@ you will be overriding the values set in the configuration files. | Name | Value | | ----------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `MCAPTCHA_CONFIG` | Path to configuration file | -| `MCAPTCHA_COMMERCIAL` | Does this instance offer commercial plans? Please consider donating if it does :D | -| `MCAPTCHA_SOURCE_CODE` | Link to the source code of this instance | -| `MCAPTCHA_ALLOW_REGISTRATION` | Is registration allowed on this instance? | -| `MCAPTCHA_ALLOW_DEMO` | Allow demo access to the server? If registration(previous option) is disabled then demo users will not be allowed | +| `MCAPTCHA_debug` | Enable debug logging | +| `MCAPTCHA_config` | Path to configuration file | +| `MCAPTCHA_commercial` | Does this instance offer commercial plans? Please consider donating if it does :D | +| `MCAPTCHA_source_code` | Link to the source code of this instance | +| `MCAPTCHA_allow_registration` | Is registration allowed on this instance? | +| `MCAPTCHA_allow_demo` | Allow demo access to the server? If registration(previous option) is disabled then demo users will not be allowed | -#### Database +### Database -| Name | Value | -| ------------------------------------ | -------------------------------------------------------------- | -| `MCAPTCHA_DATEBASE_PASSWORD` | database user password | -| `MCAPTCHA_DATEBASE_NAME` | database name | -| `MCAPTCHA_DATEBASE_PORT` | port on which the DBMS is running | -| `MCAPTCHA_DATEBASE_HOSTNAME` | hostname of the DBMS | -| `MCAPTCHA_DATEBASE_USERNAME` | database username | -| `MCAPTCHA_DATEBASE_POOL` | database connection pool size | -| `MCAPTCHA_DATEBASE_DATABASE_TYPE` | database tpye: "postgres" or "maria" | +| Name | Value | +| ------------------------------------- | -------------------------------------------------------------- | +| `MCAPTCHA_database_DATEBASE_POOL` | database connection pool size | | `DATABASE_URL` (overrides above vars) | database URL in `postgres://user:pass@host:port/dbname` format | -#### Redis +### Redis | Name | Value | | --------------------- | -------------------------- | -| `MCAPTCHA_REDIS_URL` | Redis URL | -| `MCAPTCHA_REDIS_POOL` | Redis connection pool size | +| `MCAPTCHA_redis_URL` | Redis URL | +| `MCAPTCHA_redis_POOL` | Redis connection pool size | -#### Server +### Server -| Name | Value | -| ---------------------------------------- | ---------------------------------------------------------------------------------- | -| `MCAPTCHA_SERVER_PORT` | The port on which you want mCaptcha to listen to | -| `PORT`(overrides `MCAPTCHA_SERVER_PORT`) | The port on which you want mCaptcha to listen to | -| `MCAPTCHA_SERVER_IP` | The IP address on which you want mCaptcha to listen to | -| `MCAPTCHA_SERVER_DOMAIN` | Domain under which mCaptcha will be\* | -| `MCAPTCHA_SERVER_COOKIE_SECRET` | Cookie secret, must be long and random | -| `MCAPTCHA_SERVER_PROXY_HAS_TLS` | Is mCaptcha behind a proxy? If yes, mCaptcha can send additional headers like HSTS | +| Name | Value | +| ------------------------------- | ---------------------------------------------------------------------------------- | +| `PORT` | The port on which you want mCaptcha to listen to | +| `MCAPTCHA_server_IP` | The IP address on which you want mCaptcha to listen to | +| `MCAPTCHA_server_DOMAIN` | Domain under which mCaptcha will be\* | +| `MCAPTCHA_server_COOKIE_SECRET` | Cookie secret, must be long and random | +| `MCAPTCHA_server_PROXY_HAS_TLS` | Is mCaptcha behind a proxy? If yes, mCaptcha can send additional headers like HSTS | \* Authentication doesn't work without `MCAPTCHA_DOMAIN` set to the correct domain ### Captcha -| 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 | +| 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_RUNNERS` | [Performance] Number of runners to use for PoW validation. Defaults to number of CPUs available | +| `MCAPTCHA_captcha_QUEUE_LENGTH` | [Performance] PoW Validation queue length, controls how many pending validation jobs can be held in queue | +| `MCAPTCHA_captcha_ENABLE_STATS` | Record for CAPTCHA events like configuration fetch, solves and authentication of validation token. Useful for commercial deployments. | | +| `MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_avg_traffic_difficulty`% | Default difficulty factor to use in easy mode CAPTCHA configuration estimation for average traffic metric | +| `MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_peak_sustainable_traffic_difficulty`% | Default difficulty factor to use in easy mode CAPTCHA configuration estimation for peak traffic metric | +| `MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_broke_my_site_traffic_difficulty`% | Default difficulty factor to use in easy mode CAPTCHA configuration estimation for traffic that took the website down | +| `MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_duration`% | Default duration to use in CAPTCHA configuration in easy mode | \% See commits [`54b14291ec140e`](https://github.com/mCaptcha/mCaptcha/commit/54b14291ec140ea4cbbf73462d3d6fc2d39f2d2c) @@ -80,9 +78,8 @@ for more info. | Name | Value | | ------------------------ | ----------------------------------------------- | -| `MCAPTCHA_SMTP_FROM` | email address from which the email will be sent | -| `MCAPTCHA_SMTP_REPLY_TO` | email address to which reply can be sent | -| `MCAPTCHA_URL` | SMTP server URL | -| `MCAPTCHA_SMTP_PORT` | SMTP server port | -| `MCAPTCHA_SMTP_USERNAME` | SMTP username | -| `MCAPTCHA_SMTP_PASSWORD` | SMTP password | +| `MCAPTCHA_smtp_FROM` | email address from which the email will be sent | +| `MCAPTCHA_smtp_URL` | SMTP server URL | +| `MCAPTCHA_smtp_PORT` | SMTP server port | +| `MCAPTCHA_smtp_USERNAME` | SMTP username | +| `MCAPTCHA_smtp_PASSWORD` | SMTP password |