diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2016-12-03 13:07:43 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-03 13:07:43 +0000 |
| commit | 546ec1a5cf562eeb1b9fd3d140c7b1c86c974e4e (patch) | |
| tree | a0e0e3de57ae6ad1a6a4e54f4ce8d629aae530f0 /docs/CAPTCHA_SETUP.rst | |
| parent | Merge branch 'release-v0.18.4' of github.com:matrix-org/synapse (diff) | |
| parent | README: review comments (diff) | |
| download | synapse-546ec1a5cf562eeb1b9fd3d140c7b1c86c974e4e.tar.xz | |
Merge pull request #1667 from matrix-org/rav/update_readme
Updates to the README
Diffstat (limited to 'docs/CAPTCHA_SETUP.rst')
| -rw-r--r-- | docs/CAPTCHA_SETUP.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/CAPTCHA_SETUP.rst b/docs/CAPTCHA_SETUP.rst new file mode 100644 index 0000000000..db621aedfc --- /dev/null +++ b/docs/CAPTCHA_SETUP.rst @@ -0,0 +1,30 @@ +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 +------------ +Requires a public/private key pair from: + +https://developers.google.com/recaptcha/ + + +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:: + + recaptcha_public_key: YOUR_PUBLIC_KEY + recaptcha_private_key: YOUR_PRIVATE_KEY + +In addition, you MUST enable captchas via:: + + enable_registration_captcha: true + +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 as an option on the home server like so:: + + captcha_ip_origin_is_x_forwarded: true |