From 4c1da52ab5309abd4f38cfab52271eb8b82a5722 Mon Sep 17 00:00:00 2001 From: brooke Date: Fri, 7 Mar 2025 17:22:10 -0500 Subject: [PATCH] update readme --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d3f76d..77aee68 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 4get -> One line description of the recipe +> A meta search engine that doesn't suck @@ -17,7 +17,7 @@ ## Quick start -* `abra app new 4get --secrets` +* `abra app new 4get` * `abra app config ` * `abra app deploy ` @@ -27,5 +27,27 @@ ## Captcha +4get does not support corporate captcha providers (ie. reCaptcha, hCaptcha, etc.) instead it employs a very simple image captcha based on user provided images. Images must be png, 100x100 in size, and named in order (ie. 1.png, 2.png, 3.png, etc.) + +Images are placed in a directory with a name of the person, place, or thing the user is expected to select. Provide 4get with images that match as well as some that do not. go to `https://4get.ca/web?s=test` with no cookies for some examples + +example directory structure: + +``` +captcha/ + birds/ + 1.png + 2.png + 3.png + anime/ + 1.png + 2.png + +``` + +* uncomment `#COMPOSE_FILE="$COMPOSE_FILE:compose.captcha.yml"` +* undeploy and redeploy 4get +* `abra app run app mkdir -p /var/www/html/4get/data/captcha/` +* `abra app cp /local/path/to/captcha_images/* app:/var/www/html/4get/data/captcha/` For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech). \ No newline at end of file