Skip to content

Commit 04bbd0f

Browse files
committed
Captcha docs
1 parent d6a3c6e commit 04bbd0f

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/deploy.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,13 @@ Register your app with the provider, and set the following variables:
128128
* `OAUTH_TYPE` - one of the supported providers (see above)
129129
* `OAUTH_ID` - the Client ID of your app.
130130
* `OAUTH_SECRET` - the Client Secret of your app.
131-
* `OAUTH_DOMAIN` - OAuth/Mattermost/Hitobito domain, Slack subdomain, or Azure tenant.
131+
* `OAUTH_DOMAIN` - OAuth/Mattermost/Hitobito domain, Slack subdomain, Azure tenant..
132+
* `OAUTH_LOGO` - (optional) URL to a button image from your SSO platform.
132133
* `OAUTH_SCOPE` - (optional) comma-delimited Scope, if not the default (`email,profile,openid`)
133134
* `OAUTH_USERINFO` - (optional) location of userinfo endpoint relative to the domain.
134135
* `OAUTH_SKIP_LOGIN` - (optional) users should go directly to external login screen.
135136
* `OAUTH_LINK_REGISTER` - (optional) a registration link to your SSO platform.
136137
* `OAUTH_HELP_REGISTER` - (optional) a short text for the login page.
137-
* `OAUTH_LOGO` - (optional) URL to a button from your SSO platform.
138138

139139
You may then wish to disable non-SSO logins using `DRIBDAT_ALLOW_LOGINS` (if an e-mail server is configured, they can still use that), and registrations with `DRIBDAT_NOT_REGISTER`
140140

@@ -144,15 +144,18 @@ You can find more advice in the [Troubleshooting](trouble#need-help-setting-up-s
144144

145145
## Spam shield
146146

147-
To try to reduce spam issues on your Dribdat instance, we encourage you to use an OAuth provider (as above) with competency in this area. Basic form validation using [Google Recaptcha](https://developers.google.com/recaptcha) and compatible providers like [Friendly Captcha](https://developer.friendlycaptcha.com/docs/v2/guides/migrating-from-recaptcha), is available:
147+
To try to reduce spam issues on your Dribdat instance, we encourage you to use an OAuth provider (as above) with competency in this area. Basic form validation using [Google Recaptcha](https://developers.google.com/recaptcha) and compatible providers like [Friendly Captcha](https://developer.friendlycaptcha.com/docs/v2/guides/migrating-from-recaptcha) or [HCaptcha](https://www.hcaptcha.com/), is available:
148148

149149
* `RECAPTCHA_PUBLIC_KEY` - A public key.
150150
* `RECAPTCHA_PRIVATE_KEY` - A private key.
151-
* `RECAPTCHA_API_SERVER` - (optional) Specify your Recaptcha API server.
152-
* `RECAPTCHA_PARAMETERS` - (optional) A dict of JavaScript (api.js) parameters.
153-
* `RECAPTCHA_DATA_ATTRS` - (optional) A dict of [data attributes](https://developers.google.com/recaptcha/docs/display#javascript_resource_apijs_parameters).
154-
* `RECAPTCHA_VERIFY_SERVER` - (optional) The remote API of your alternative Captcha service.
151+
* `RECAPTCHA_PARAMETERS` - (optional) A dict of configuration parameters.
152+
* `RECAPTCHA_HTML` - (optional) Override default HTML template.
153+
* `RECAPTCHA_DATA_ATTRS` - (optional) A dict of [data attributes](https://developers.google.com/recaptcha/docs/display#javascript_resource_apijs_parameters) for Recaptcha using-a-proxy-server.
155154
* `RECAPTCHA_SCRIPT` - (optional) The script that is used by your alternative Captcha service.
155+
* `RECAPTCHA_DIV_CLASS` - (optional) Override the default class of the captcha div in case an alternative captcha service is used. Default is `g-recaptcha`
156+
* `RECAPTCHA_VERIFY_SERVER` - (optional) The remote API of your alternative Captcha service.
157+
158+
See the [Flask WTF docs](https://flask-wtf.readthedocs.io/en/1.2.x/config/#recaptcha) for further configuration settings.
156159

157160
## File storage
158161

0 commit comments

Comments
 (0)