freeptcha/README.md

15 lines
661 B
Markdown

# Freeptcha
Freeptcha is a completely free, open source and portable captcha generator.
# Deploying locally for development
To deploy a local instance, write a `.env`, install the packages and run `yarn dev`.
Deploying to production is not supported (yet), but to run with the most optimizations,
set `APP_DEBUG` to `false` in `.env`, and run the file directly: `node index.js`.
# Examples
Below are captchas generated by this. To generate a captcha, deploy an instance send a GET `/captcha/v{version}/{text}`, with `version` being the captcha version and `text` being the captcha text.
| Captcha version | Image |
| --- | --- |
| 1 | ![](./readme/v1.jpg) |