MrTuxedo/telegram-moderator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Stan James 2018-02-10 08:37:03 -07:00
parent be39359262
commit e0b73cc123
1 changed files with 40 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,24 +1,17 @@
# Telegram Bot # Telegram Bot
*NOTE* Development version of bot than does message monitoring and more. - Deletes messages matching specified patterns
- Bans users for posting messagses matching specified patterns
- Bans users with usernames matching specified patterns
- Records logs of converstations
## Installation ## Installation
- Required: Python 3.x, pip, PostgreSQL - Required: Python 3.x, pip, PostgreSQL
- Create virtualenv
- Clone this repo - Clone this repo
- `pip install --upgrade -r requirements.txt` - `pip install --upgrade -r requirements.txt`
## Telegram Bot Setup
- Create a bot by talking to BotFather: https://core.telegram.org/bots#creating-a-new-bot
- Store your Telegram Bot Token in environment variable `BOT_TOKEN`. It will look similar to this:
```
export TELEGRAM_BOT_TOKEN="4813829027:ADJFKAf0plousH2EZ2jBfxxRWFld3oK34ya"
```
- Create a Telegram group.
- Add your bot to the group like so: https://stackoverflow.com/questions/37338101/how-to-add-a-bot-to-a-telegram-group
- Use `/setprivacy` with `@BotFather` in order to allow it to see all messages in a group.
## Database setup ## Database setup
- Store database URL in environment variable. - Store database URL in environment variable.
``` ```
@ -26,6 +19,40 @@
``` ```
- Run: `python model.py` to setup the DB tables. - Run: `python model.py` to setup the DB tables.
## Setup
- Create a Telegram bot by talking to `@BotFather` : https://core.telegram.org/bots#creating-a-new-bot
- Use `/setprivacy` with `@BotFather` in order to allow it to see all messages in a group.
- Store your Telegram Bot Token in environment variable `TELEGRAM_BOT_TOKEN`. It will look similar to this:
```
export TELEGRAM_BOT_TOKEN="4813829027:ADJFKAf0plousH2EZ2jBfxxRWFld3oK34ya"
```
- Create your Telegram group.
- Add your bot to the group like so: https://stackoverflow.com/questions/37338101/how-to-add-a-bot-to-a-telegram-group
- Make your bot an admin in the group
## Configuring patterns
- Regex patterns will be read from the following env variables
- `MESSAGE_BAN_PATTERNS` Messages matching this will ban the user.
- `MESSAGE_HIDE_PATTERNS` Messages matching this will be hidden/deleted
- `NAME_BAN_PATTERNS` Users with usernames or first/last names maching this will be banned from the group.
- `SAFE_USER_IDS` User ID's that are except from these checkes. Note that the bot cannot ban admin users, but can delete their messages.
Sample bash file to set `MESSAGE_BAN_PATTERNS`:
```
read -r -d '' MESSAGE_BAN_PATTERNS << 'EOF'
# ETH
# e.g. F8C8405e85Cfe42551DEfeB2a4548A33bb3DF840
[0-9a-fA-F]{40,40}
# BTC 13qt9rCA2CQLZedmUuDiPkwdcAJLsuTvLm
# e.g.
|[0-9a-fA-Z]{34,34}
EOF
```
## Running the bot ## Running the bot
- Run: `python bot.py` to start logger - Run: `python bot.py` to start.
- Messages will be displayed on `stdout` as they are logged. - Messages will be displayed on `stdout` as they are logged.