summary refs log tree commit diff
path: root/syweb/webclient/CAPTCHA_SETUP
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-11-17 12:55:24 +0000
committerMark Haines <mark.haines@matrix.org>2014-11-17 12:55:24 +0000
commit5d273a0c76e12e3125dbf06a8f0caa03de01d4a9 (patch)
treec968f7c7586778b3e7b3053b9c07b4336ba727e8 /syweb/webclient/CAPTCHA_SETUP
parentSYWEB-152: Remove room join logic from RoomController and put it in eventHand... (diff)
downloadsynapse-5d273a0c76e12e3125dbf06a8f0caa03de01d4a9.tar.xz
Remove syweb directory. pull in syweb as a dependency from github
Diffstat (limited to 'syweb/webclient/CAPTCHA_SETUP')
-rw-r--r--syweb/webclient/CAPTCHA_SETUP46
1 files changed, 0 insertions, 46 deletions
diff --git a/syweb/webclient/CAPTCHA_SETUP b/syweb/webclient/CAPTCHA_SETUP
deleted file mode 100644
index ebc8a5f3b0..0000000000
--- a/syweb/webclient/CAPTCHA_SETUP
+++ /dev/null
@@ -1,46 +0,0 @@
-Captcha can be enabled for this web client / 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 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:
-
-  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
-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
-
-
-