summary refs log blame commit diff
path: root/docs/CAPTCHA_SETUP
blob: 75ff80981b036a94372e2f572ad14d9141f451ad (plain) (tree)
1
2
3
4
5
6
7
8
9
10
                                                                               







                                                                                     


                                                                              
 
                                       




                                          







                                                                                
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