diff options
| author | Richard van der Hoff <richard@matrix.org> | 2016-12-01 12:01:54 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2016-12-01 12:08:03 +0000 |
| commit | 971edd04affd484168b3dbec43783afe03d55a4e (patch) | |
| tree | 97cfcba43d1439a151f71231dd9accc9be39ce0e /docs/CAPTCHA_SETUP | |
| parent | Merge branch 'release-v0.18.4' of github.com:matrix-org/synapse (diff) | |
| download | synapse-971edd04affd484168b3dbec43783afe03d55a4e.tar.xz | |
rename CAPTCHA_SETUP
this is rst so name it accordingly
Diffstat (limited to 'docs/CAPTCHA_SETUP')
| -rw-r--r-- | docs/CAPTCHA_SETUP | 31 |
1 files changed, 0 insertions, 31 deletions
diff --git a/docs/CAPTCHA_SETUP b/docs/CAPTCHA_SETUP deleted file mode 100644 index 75ff80981b..0000000000 --- a/docs/CAPTCHA_SETUP +++ /dev/null @@ -1,31 +0,0 @@ -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 - |