jadedctrl/ kaptchapelo
1
0
Disbranĉigi 0
Fontkodo Issues Tirpetoj Actions Packages Projects Eldonoj Wiki Activity

Add example photo to README

This commit is contained in:
Jaidyn Ann 2023-08-08 20:27:22 -05:00
parent 0d2d99ed1d
commit 6e3cca5b0a
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -3,6 +3,7 @@ Kaptĉapelo is a simple [Kocaptcha](https://github.com/koto-bank/kocaptcha)-comp
Since Kaptĉapelo is a kinda-sorta drop-in replacement for Kocaptcha, you can [use it as CAPTCHA](https://docs-develop.pleroma.social/backend/configuration/cheatsheet/#captcha) for your [Pleroma](https://pleroma.social) server. Since Kaptĉapelo is a kinda-sorta drop-in replacement for Kocaptcha, you can [use it as CAPTCHA](https://docs-develop.pleroma.social/backend/configuration/cheatsheet/#captcha) for your [Pleroma](https://pleroma.social) server.
![A screenshot of a CAPTCHA challenge on the registration page of a Pleroma server. It is a picture of a feminine anime character, Ferris from Re:Zero, with the question in Esperanto: “Ĉu ĝi estas knabo aŭ knabino?”](example.png)
## Installation ## Installation
@ -52,7 +53,7 @@ Now, Kaptchapelo should be running and good to go; visit http://localhost:5001 a
## Configuration ## Configuration
### Web-server ### Reverse-proxy
You’ll probably be running Kaptchapelo through a reverse proxy; here’s how you can add it to an existing server definition with [nginx](https://nginx.org/): You’ll probably be running Kaptchapelo through a reverse proxy; here’s how you can add it to an existing server definition with [nginx](https://nginx.org/):
``` ```
@ -82,7 +83,7 @@ That is to say, you don’t need a dedicated subdomain!
Making custom captchas is easy! A challenge is simply a PNG file (question) and a TXT file (answer). Making custom captchas is easy! A challenge is simply a PNG file (question) and a TXT file (answer).
… that’s it! Literally. … that’s it! Literally.
Note that the PNG and TXT files should have the same name (bird.png and bird.txt, not bird2.png and bird1.txt), and that the TXT answer should consist of one line with _no_ newline. Note that the PNG and TXT files should have the same name (`bird.png` and `bird.txt`, not `bird2.png` and `bird1.txt`), and that the TXT answer should consist of one line with _no_ newline.
A peek through this repository’s example captchas (in `./captcha/`) should give you the idea. A peek through this repository’s example captchas (in `./captcha/`) should give you the idea.
@ -100,5 +101,5 @@ In addition, you can also change the port and address by editing this script.
## Misc. information ## Misc. information
Author: Jaidyn Ann @jadedctrl@jam.xwx.moe Author: Jaidyn Ann `@jadedctrl@jam.xwx.moe`
License: GNU AGPLv3 License: GNU AGPLv3

BIN
example.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 100 KiB