diff options
author | Richard van der Hoff <richard@matrix.org> | 2019-09-19 20:32:25 +0100 |
---|---|---|
committer | Richard van der Hoff <richard@matrix.org> | 2019-09-19 20:32:25 +0100 |
commit | 284e1cb027c2c5e8376a5b83d21d626e18dcbc33 (patch) | |
tree | 39adfb627d806891d95ffabb0bd7490f1fc737eb /docs/CAPTCHA_SETUP.md | |
parent | Fix a bug with saml attribute maps. (diff) | |
parent | fix sample config (diff) | |
download | synapse-284e1cb027c2c5e8376a5b83d21d626e18dcbc33.tar.xz |
Merge branch 'develop' into rav/fix_attribute_mapping
Diffstat (limited to '')
-rw-r--r-- | docs/CAPTCHA_SETUP.md (renamed from docs/CAPTCHA_SETUP.rst) | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/CAPTCHA_SETUP.rst b/docs/CAPTCHA_SETUP.md index 0c22ee4ff6..5f9057530b 100644 --- a/docs/CAPTCHA_SETUP.rst +++ b/docs/CAPTCHA_SETUP.md @@ -1,30 +1,31 @@ +# Overview Captcha can be enabled for this home server. This file explains how to do that. The captcha mechanism used is Google's ReCaptcha. This requires API keys from Google. -Getting keys ------------- +## Getting keys + Requires a public/private key pair from: -https://developers.google.com/recaptcha/ +<https://developers.google.com/recaptcha/> Must be a reCAPTCHA v2 key using the "I'm not a robot" Checkbox option -Setting ReCaptcha Keys ----------------------- +## Setting ReCaptcha Keys + The keys are a config option on the home server config. If they are not -visible, you can generate them via --generate-config. Set the following value:: +visible, you can generate them via `--generate-config`. Set the following value: + + recaptcha_public_key: YOUR_PUBLIC_KEY + recaptcha_private_key: YOUR_PRIVATE_KEY - recaptcha_public_key: YOUR_PUBLIC_KEY - recaptcha_private_key: YOUR_PRIVATE_KEY +In addition, you MUST enable captchas via: -In addition, you MUST enable captchas via:: + enable_registration_captcha: true - enable_registration_captcha: true +## Configuring IP used for auth -Configuring IP used for auth ----------------------------- The ReCaptcha API requires that the IP address of the user who solved the captcha is sent. If the client is connecting through a proxy or load balancer, -it may be required to use the X-Forwarded-For (XFF) header instead of the origin -IP address. This can be configured using the x_forwarded directive in the +it may be required to use the `X-Forwarded-For` (XFF) header instead of the origin +IP address. This can be configured using the `x_forwarded` directive in the listeners section of the homeserver.yaml configuration file. |