2015-12-27 23:36:33 -05:00
|
|
|
# reCAPTCHA
|
|
|
|
|
|
|
|
|
|
GitLab leverages [Google's reCAPTCHA](https://www.google.com/recaptcha/intro/index.html)
|
|
|
|
|
to protect against spam and abuse. GitLab displays the CAPTCHA form on the sign-up page
|
|
|
|
|
to confirm that a real user, not a bot, is attempting to create an account.
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
2015-12-28 15:21:34 -05:00
|
|
|
To use reCAPTCHA, first you must create a site and private key.
|
2015-12-27 23:36:33 -05:00
|
|
|
|
2018-11-12 19:39:21 -05:00
|
|
|
1. Go to the URL: <https://www.google.com/recaptcha/admin>.
|
2018-12-07 16:47:34 -05:00
|
|
|
1. Fill out the form necessary to obtain reCAPTCHA v2 keys.
|
|
|
|
|
1. Log in to your GitLab server, with administrator credentials.
|
|
|
|
|
1. Go to Reporting Applications Settings in the Admin Area (`admin/application_settings/reporting`).
|
2019-09-30 02:06:02 -04:00
|
|
|
1. Fill all reCAPTCHA fields with keys from previous steps.
|
2018-11-12 19:39:21 -05:00
|
|
|
1. Check the `Enable reCAPTCHA` checkbox.
|
|
|
|
|
1. Save the configuration.
|
2018-06-21 14:13:08 -04:00
|
|
|
|
|
|
|
|
## Enabling reCAPTCHA for user logins via passwords
|
|
|
|
|
|
|
|
|
|
By default, reCAPTCHA is only enabled for user registrations. To enable it for
|
|
|
|
|
user logins via passwords, the `X-GitLab-Show-Login-Captcha` HTTP header must
|
|
|
|
|
be set. For example, in NGINX, this can be done via the `proxy_set_header`
|
|
|
|
|
configuration variable:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
proxy_set_header X-GitLab-Show-Login-Captcha 1;
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
In GitLab Omnibus, this can be configured via `/etc/gitlab/gitlab.rb`:
|
|
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
|
nginx['proxy_set_headers'] = { 'X-GitLab-Show-Login-Captcha' => 1 }
|
|
|
|
|
```
|
