update readme

This commit is contained in:
2025-03-07 17:22:10 -05:00
parent fca4095a3f
commit 4c1da52ab5

View File

@ -1,6 +1,6 @@
# 4get
> One line description of the recipe
> A meta search engine that doesn't suck
<!-- metadata -->
@ -17,7 +17,7 @@
## Quick start
* `abra app new 4get --secrets`
* `abra app new 4get`
* `abra app config <app-name>`
* `abra app deploy <app-name>`
@ -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-domain> app mkdir -p /var/www/html/4get/data/captcha/<dataset-name>`
* `abra app cp <app-domain> /local/path/to/captcha_images/* app:/var/www/html/4get/data/captcha/<dataset-name>`
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).