diff options
| author | Mark Haines <mark.haines@matrix.org> | 2015-04-29 13:15:14 +0100 |
|---|---|---|
| committer | Mark Haines <mark.haines@matrix.org> | 2015-04-29 13:15:14 +0100 |
| commit | 4ad8b451559682645c818f6c1180e5f9d42a7eeb (patch) | |
| tree | 94fe0beaaaa4ed8c1bb9451f1274df819d9ce8d7 /CAPTCHA_SETUP | |
| parent | Update the query format used by keyring to match current key v2 spec (diff) | |
| parent | Mention that postgres databases must have the correct charset encoding (diff) | |
| download | synapse-4ad8b451559682645c818f6c1180e5f9d42a7eeb.tar.xz | |
Merge branch 'develop' into key_distribution
Conflicts: synapse/config/homeserver.py
Diffstat (limited to 'CAPTCHA_SETUP')
| -rw-r--r-- | CAPTCHA_SETUP | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/CAPTCHA_SETUP b/CAPTCHA_SETUP new file mode 100644 index 0000000000..75ff80981b --- /dev/null +++ b/CAPTCHA_SETUP @@ -0,0 +1,31 @@ +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 + |