summary refs log tree commit diff
path: root/CAPTCHA_SETUP
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2015-04-28 13:39:42 +0100
committerErik Johnston <erik@matrix.org>2015-04-28 13:39:42 +0100
commit327ca883ec51780ea2a914d3c89ca0499f4656ac (patch)
treedc3f2c06cdbbfce8b1d1bb6a4db31a8852f5b43a /CAPTCHA_SETUP
parentQuickly fix dodgy est. time remaining (diff)
parentMerge pull request #126 from matrix-org/csauth (diff)
downloadsynapse-327ca883ec51780ea2a914d3c89ca0499f4656ac.tar.xz
Merge branch 'develop' of github.com:matrix-org/synapse into postgres
Diffstat (limited to 'CAPTCHA_SETUP')
-rw-r--r--CAPTCHA_SETUP31
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
+