1
0

CAPTCHA_SETUP.rst 1.0 KB

1234567891011121314151617181920212223242526272829
  1. Captcha can be enabled for this home server. This file explains how to do that.
  2. The captcha mechanism used is Google's ReCaptcha. This requires API keys from Google.
  3. Getting keys
  4. ------------
  5. Requires a public/private key pair from:
  6. https://developers.google.com/recaptcha/
  7. Setting ReCaptcha Keys
  8. ----------------------
  9. The keys are a config option on the home server config. If they are not
  10. visible, you can generate them via --generate-config. Set the following value::
  11. recaptcha_public_key: YOUR_PUBLIC_KEY
  12. recaptcha_private_key: YOUR_PRIVATE_KEY
  13. In addition, you MUST enable captchas via::
  14. enable_registration_captcha: true
  15. Configuring IP used for auth
  16. ----------------------------
  17. The ReCaptcha API requires that the IP address of the user who solved the
  18. captcha is sent. If the client is connecting through a proxy or load balancer,
  19. it may be required to use the X-Forwarded-For (XFF) header instead of the origin
  20. IP address. This can be configured using the x_forwarded directive in the
  21. listeners section of the homeserver.yaml configuration file.