mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-11-14 19:29:45 +00:00
504d4a4134
* added dendrite captcha options * added hcaptcha doc * proper url * Apply suggestions from code review Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update main.yml * renamed captcha vars to new naming scheme * change vars to new format * Rename back some incorrect renamed variables These variables are either not just part of the `client_api` subsection, or are not even part of that section at all. They shouldn't have been renamed in baaef2ed616e2645550d9 * Fix up naming inconsistencies Some of these variables had been renamed in one place, but not in other places, so it couldn't have worked that way. * Add validation/deprecation for renamed Dendrite variables Related to 4097898f885cf4c73, baaef2ed616e2645550, 68f4418092fa8ad and a0b4a0ae6b2f1f18 Co-authored-by: Slavi Pantaleev <slavi@devture.com>
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
(Adapted from the [upstream project](https://github.com/matrix-org/synapse/blob/develop/docs/CAPTCHA_SETUP.md))
|
|
|
|
# Overview
|
|
Captcha can be enabled for this home server. This file explains how to do that.
|
|
The captcha mechanism used is Google's [ReCaptcha](https://www.google.com/recaptcha/). This requires API keys from Google. If your homeserver is Dendrite then [hCapcha](https://www.hcaptcha.com) can be used instead.
|
|
|
|
## ReCaptcha
|
|
|
|
### Getting keys
|
|
|
|
Requires a site/secret key pair from:
|
|
|
|
<http://www.google.com/recaptcha/admin>
|
|
|
|
Must be a reCAPTCHA **v2** key using the "I'm not a robot" Checkbox option
|
|
|
|
### Setting ReCaptcha keys
|
|
|
|
Once registered as above, set the following values:
|
|
|
|
```yaml
|
|
# for Synapse
|
|
matrix_synapse_enable_registration_captcha: true
|
|
matrix_synapse_recaptcha_public_key: 'YOUR_SITE_KEY'
|
|
matrix_synapse_recaptcha_private_key: 'YOUR_SECRET_KEY'
|
|
|
|
# for Dendrite
|
|
matrix_dendrite_client_api_enable_registration_captcha: true
|
|
matrix_dendrite_client_api_recaptcha_public_key: 'YOUR_SITE_KEY'
|
|
matrix_dendrite_client_api_recaptcha_private_key: 'YOUR_SECRET_KEY'
|
|
```
|
|
|
|
## hCaptcha
|
|
|
|
### Getting keys
|
|
|
|
Requires a site/secret key pair from:
|
|
|
|
<https://dashboard.hcaptcha.com/sites/new>
|
|
|
|
### Setting hCaptcha keys
|
|
|
|
```yaml
|
|
matrix_dendrite_client_api_enable_registration_captcha: true
|
|
matrix_dendrite_client_api_recaptcha_public_key: 'YOUR_SITE_KEY'
|
|
matrix_dendrite_client_api_recaptcha_private_key: 'YOUR_SECRET_KEY'
|
|
|
|
matrix_dendrite_client_api_recaptcha_siteverify_api: 'https://hcaptcha.com/siteverify'
|
|
matrix_dendrite_client_api_recaptcha_api_js_url: 'https://js.hcaptcha.com/1/api.js'
|
|
matrix_dendrite_client_api_recaptcha_form_field: 'h-captcha-response'
|
|
matrix_dendrite_client_api_recaptcha_sitekey_class: 'h-captcha'
|
|
```
|