teknologi-umum / captcha-lite Goto Github PK

See: https://docs.github.com/en/actions/publishing-packages/publishing-docker-images

Publish a container image (with multiple tags that correspond to the release event, whether it's nightly or stable build) to Github Container Registry via Github Actions.

Bump version to Go 1.19 on go.mod and Dockerfile. Might also bump dependencies version.

Reference: https://pkg.go.dev/gopkg.in/telebot.v3

Right now we're using Telebot v2, yet the original teknologi-umum/captcha repository uses Telebot v3. We shall upgrade to that version, too.

On 2024, I'll be moving everything away stuff on captcha-lite to captcha. It's hard maintaining 2 stuffs in any event for security vulnerability and stuff.

The plan will be:

• January 2024: Issue a deprecation warning on the README.
• June 2024: Convert the repository to public archive.

Current deployment options that are available to be used by the users are Docker, Fly.io, and Heroku. What if they want to run it on their VM without any of that with minimal resource? They can use systemd.

The task is very simple, just provide a systemd unit file with environment variables already loaded (and give notice for them to change it). Please take into account of the restart policy and it needs network connection.

Provide a /metrics endpoints that can be used to monitor the application to Prometheus.

Some metrics that can be monitored:

• How many users that joined to the group (per group name) -- either just joined, finished, or didn't finished the captcha
• How many users that finished the captcha (per group name)
• How many users that didn't finish the captcha (per group name)
• How many users are donig the captcha right now (per group name)
• How many commands are the bot sending to Telegram (per group name) -- commands means everything from banning a user, deleting a message, and sending a message.

Can be enabled only by specifying METRICS=true on the environment variable.

Current logging uses noop, sentry, and rollbar. Provide console logger. Might use zerolog or similar, but make sure the library that's being used has minimal dependency (no dependency would be best).