Skip to content

Latest commit

 

History

History
executable file
·
170 lines (131 loc) · 5.15 KB

README.md

File metadata and controls

executable file
·
170 lines (131 loc) · 5.15 KB
Raw

everyone-mention-telegram-bot

Contents

Description

Everyone Mention Bot is simple, but useful telegram bot to gather group members attention.

You can create groups per chat to mention every user that joined the group by calling one command instead of mentioning them one by one.

Usage

First, users need to join the group to let mentioning them, to do that, they simply need to join specific group. It can be done in 2 ways:

Users that have joined the group can be mentioned in 3 ways:

To leave the group use one of the two ways:

To display available groups:

Dynamic mentioning

You can use @ character (as you would mention a user) to mention specific group.

All the below will mention users from default group.

@all, @channel, @chat, @everyone, @group, @here.

If you did create a group named gaming, you can simply use @gaming in your text to mention them all.

Commands

Important: {group-name} is not required, if not given, it will be set to default.

/join

Joins the group (if group did not exist before, it will be created).

/join {group_name}

Examples

without group name

join default command example

with group name

join group command example

/leave

Leaves the group (and deletes if no members are left).

/leave {group_name}

Examples

without group name

leave default command example

with group name

leave group command example

/everyone

Mention everyone that joined requested group.

/everyone {group-name}

Examples

without group name

everyone default command example

with group name

everyone group command example

/groups

Will display available groups for this chat as well with members count.

groups command example

/start

Start & Help message

start command example

Example command flow

example command flow

Inline Mode Usage

To use inline mode, type @everyone_mention_bot in telegram message input or click on the Inline Mode button from /start command.

inline popup

Type in your group name (you can leave it blank for default group name), then click on one of the three following options.

inline answer

Getting started

Requirements

  • docker-compose in version 1.25.0
  • docker in version 20.10.7

Installation

  • copy the repository
git clone https://github.com/miloszowi/everyone-mention-telegram-bot.git
  • copy environment files and fulfill empty values
cp .env.local .env
cp docker/config/app.env.local docker/config/app.env
cp docker/config/database.env.local docker/config/app.env
  • start the project (-d flag will run containers in detached mode)
docker-compose up -d

Logs

docker/logs <container>

Env files

  • .env

    • MONGODB_INTERNAL_PORT - Mongodb internal port (should be the same as declared in app.env)
    • APP_INTERNAL_PORT - App internal port (should be the same as declared in app.env)
    • APP_EXPOSED_PORT - App exposed port (if you are not using any reverse proxy it should be also the same as declared in app.env)

  • app.env

    • BOT_TOKEN - your telegram bot token from BotFather
    • WEBHOOK_URL - url for telegram webhooks (withour the bot token)
    • PORT - port used for initializing webhook & app
    • MONGODB_DATABASE - MongoDB database name
    • MONGODB_USERNAME - MongoDB username
    • MONGODB_PASSWORD - MongoDB password
    • MONGODB_HOSTNAME - MongoDB host (default database - container name)
    • MONGODB_PORT - MongoDB port (default 27017 - given in docker-compose configuration)
    • BANNED_USERS - user ids separated by comma that are not allowed to use the bot

  • database.env

    • MONGO_INITDB_ROOT_USERNAME - conf from app.env
    • MONGO_INITDB_ROOT_PASSWORD - conf from app.env
    • MONGO_INITDB_DATABASE - conf from app.env
    • MONGODB_DATA_DIR - directory to store MongoDB documents (inside a container)
    • MONDODB_LOG_DIR - path to logs storage