Skip to content

Commit

Permalink
captcha notes/proto-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
c-e-p committed Jun 19, 2023
1 parent 71d1944 commit 8b62ab3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions captcha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Captcha

Ourchive currently supports [hCaptcha](https://www.hcaptcha.com/), a privacy-first CAPTCHA service with a free tier.

CAPTCHA is enabled through your environment settings. When you sign up for hcaptcha, you will be given two values: a site key and a secret key. The site key is used by the site; the secret key is used for verification. Keep these values somewhere safe, like a password manager.

The following values should be modified in your .env file or environment variables [tk - add details for managed services]:

'''
OURCHIVE_CAPTCHA_SITE_KEY=[change to site key from hcaptcha]
OURCHIVE_USE_CAPTCHA=True
OURCHIVE_CAPTCHA_PROVIDER=hcaptcha
OURCHIVE_CAPTCHA_PARAM=h-captcha-response
OURCHIVE_CAPTCHA_SECRET=[change to secret from hcaptcha]
'''

Captcha is used for anonymous comments. **If you have anonymous comments enabled we strongly recommend using captcha.**

Our assumption is that site users are trusted people who aren't bots. Please refer to our [tk add link]config documentation for advice on preventing spam comments & signups.

0 comments on commit 8b62ab3

Please sign in to comment.