summary refs log tree commit diff
path: root/CAPTCHA_SETUP
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2015-03-30 18:27:42 +0100
committerDavid Baker <dave@matrix.org>2015-03-30 18:27:42 +0100
commit4891c4ff72af2733627c4bfb29cc0fa5362ab617 (patch)
tree75ff27a46f3328748ad4d2e638ffc251658ce905 /CAPTCHA_SETUP
parentAdd original, unmodified CAPTCHA-SETUP from the webclient repo before modifyi... (diff)
downloadsynapse-4891c4ff72af2733627c4bfb29cc0fa5362ab617.tar.xz
Update CAPTCHA_SETUP (it continues to ignore fallback, but I guess I should fix it so that doesn't need the key in two different places)
Diffstat (limited to '')
-rw-r--r--CAPTCHA_SETUP27
1 files changed, 6 insertions, 21 deletions
diff --git a/CAPTCHA_SETUP b/CAPTCHA_SETUP
index 38089ce093..75ff80981b 100644
--- a/CAPTCHA_SETUP
+++ b/CAPTCHA_SETUP
@@ -1,4 +1,4 @@
-Captcha can be enabled for this web client / home server. This file explains how to do that.
+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
@@ -8,31 +8,18 @@ Requires a public/private key pair from:
 https://developers.google.com/recaptcha/
 
 
-Setting Private ReCaptcha Key
------------------------------
-The private key is a config option on the home server config. If it is not 
-visible, you can generate it via --generate-config. Set the following value:
+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
 
-Setting Public ReCaptcha Key
-----------------------------
-The web client will look for the global variable webClientConfig for config 
-options. You should put your ReCaptcha public key there like so:
-
-webClientConfig = {
-    useCaptcha: true,
-    recaptcha_public_key: "YOUR_PUBLIC_KEY"
-};
-
-This should be put in webclient/config.js which is already .gitignored, rather 
-than in the web client source files. You MUST set useCaptcha to true else a
-ReCaptcha widget will not be generated.
-
 Configuring IP used for auth
 ----------------------------
 The ReCaptcha API requires that the IP address of the user who solved the
@@ -42,5 +29,3 @@ IP address. This can be configured as an option on the home server like so:
 
   captcha_ip_origin_is_x_forwarded: true
 
-
-