Welcome to Expulsabot 👋

🏠 Homepage

Readme Maker is a simple application to help you to make your README files

Prerequisites

All prerequisites are in the Docker File

Installing Expulsabot

To install Expulsabot, follow these steps:

Docker

docker run -d --name=expulsabot \
-p 5000:5000 \
-v database:/app/database \
-env-file ./expulsabot.env
atareao/expulsabot:amd64

Also you can use the docker-compose.yml. This is for using with Traefik, but must be work without it anyway.

Using Expulsabot

Before you start the expulsabot app, you must get a Telegram Bot working. So you have the required parameter.

The courtesy_time, is the time expulsabot wait until kick a user if not answer.

The webhook is a the endpoint, you must tell Telegram to point to. If your url is https://expulsabot.tuservidor.com, and the WEBHOOK is bfc7dabd-27ef-4f27-9eeb-55726e388335... You must tell Telegram following url https://expulsabot.tuservidor.com/webhook/bfc7dabd-27ef-4f27-9eeb-55726e388335 (remember add /webhook/ path to url before uuid).

To get a webhook you can use a uuid generator

Contributing to Expulsabot

To contribute to Expulsabot, follow these steps:

Fork this repository.
Create a branch: git checkout -b <branch_name>.
Make your changes and commit them: git commit -m '<commit_message>'
Push to the original branch: git push origin atareao/readmemaker
Create the pull request.

Alternatively see the GitHub documentation on creating a pull request. </commit_message></branch_name>

👤 Contributors ✨

Thanks goes to these wonderful people (emoji key):

Lorenzo

💻

rapejim/expulsabot