summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2016-12-03 13:07:43 +0000
committerGitHub <noreply@github.com>2016-12-03 13:07:43 +0000
commit546ec1a5cf562eeb1b9fd3d140c7b1c86c974e4e (patch)
treea0e0e3de57ae6ad1a6a4e54f4ce8d629aae530f0 /docs
parentMerge branch 'release-v0.18.4' of github.com:matrix-org/synapse (diff)
parentREADME: review comments (diff)
downloadsynapse-546ec1a5cf562eeb1b9fd3d140c7b1c86c974e4e.tar.xz
Merge pull request #1667 from matrix-org/rav/update_readme
Updates to the README
Diffstat (limited to 'docs')
-rw-r--r--docs/CAPTCHA_SETUP.rst (renamed from docs/CAPTCHA_SETUP)11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/CAPTCHA_SETUP b/docs/CAPTCHA_SETUP.rst
index 75ff80981b..db621aedfc 100644
--- a/docs/CAPTCHA_SETUP
+++ b/docs/CAPTCHA_SETUP.rst
@@ -10,13 +10,13 @@ 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:
+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:
+
+In addition, you MUST enable captchas via::
 
   enable_registration_captcha: true
 
@@ -25,7 +25,6 @@ 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:
+IP address. This can be configured as an option on the home server like so::
 
   captcha_ip_origin_is_x_forwarded: true
-