From 971edd04affd484168b3dbec43783afe03d55a4e Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Thu, 1 Dec 2016 12:01:54 +0000 Subject: rename CAPTCHA_SETUP this is rst so name it accordingly --- README.rst | 4 ++-- docs/CAPTCHA_SETUP | 31 ------------------------------- docs/CAPTCHA_SETUP.rst | 30 ++++++++++++++++++++++++++++++ 3 files changed, 32 insertions(+), 33 deletions(-) delete mode 100644 docs/CAPTCHA_SETUP create mode 100644 docs/CAPTCHA_SETUP.rst diff --git a/README.rst b/README.rst index f1ccc8dc45..e0e835f14f 100644 --- a/README.rst +++ b/README.rst @@ -180,8 +180,8 @@ old key cached. If you update the signing key, you should change the name of the key in the .signing.key file (the second word) to something different. By default, registration of new users is disabled. You can either enable -registration in the config by specifying ``enable_registration: true`` -(it is then recommended to also set up CAPTCHA - see docs/CAPTCHA_SETUP), or +registration in the config by specifying ``enable_registration: true`` (it is +then recommended to also set up CAPTCHA - see ``_), or you can use the command line to register new users:: $ source ~/.synapse/bin/activate 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 - diff --git a/docs/CAPTCHA_SETUP.rst b/docs/CAPTCHA_SETUP.rst new file mode 100644 index 0000000000..db621aedfc --- /dev/null +++ b/docs/CAPTCHA_SETUP.rst @@ -0,0 +1,30 @@ +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 -- cgit 1.5.1