diff options
| author | Mark Haines <mjark@negativecurvature.net> | 2015-04-28 11:00:27 +0100 |
|---|---|---|
| committer | Mark Haines <mjark@negativecurvature.net> | 2015-04-28 11:00:27 +0100 |
| commit | 9182f876645a27eb9599c99963876b12067fe93a (patch) | |
| tree | 158a1e1213f73f2395389d5a861b5eb07f8eb36f /CAPTCHA_SETUP | |
| parent | Merge pull request #133 from matrix-org/invite_power_level (diff) | |
| parent | Add commentage. (diff) | |
| download | synapse-9182f876645a27eb9599c99963876b12067fe93a.tar.xz | |
Merge pull request #126 from matrix-org/csauth
Client / Server Auth Refactor
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 + |