tm216ux/bakalarka_praca
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Aktualizovat telegram_bot/README.md

Browse Source
This commit is contained in:
Tetiana Mohorian 2025-06-04 10:44:32 +00:00
parent 2bce122ddf
commit 173e819191
1 changed files with 56 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
telegram_bot/README.md
View File

@ -1,123 +1,122 @@
# Hate Speech Bot – Documentation
# Hate Speech Bot – Dokumentácia ## 🧠 Application Overview
## 🧠 Opis aplikácie The Hate Speech Bot is a complete system for the automated detection of hate speech within **Telegram**. It functions as a monitoring and analysis tool that enables:
Hate Speech Bot je kompletný systém na automatickú detekciu nenávistnej reči v prostredí **Telegramu**. Aplikácia slúži ako monitorovací a analytický nástroj, ktorý umožňuje: - Automatic **interception and analysis of user messages** in group chats
- When hate speech is detected, it records information about the **user and the message into a database**
- Displays violators through a **real-time web interface**
- Automaticky **zachytiť a analyzovať správy** používateľov v skupinových chatoch. ### System Components:
- V prípade detekcie nenávistného prejavu zaznamená informáciu o **používateľovi a správe do databázy**. 1. **Telegram Bot**: Intercepts messages and uses a fine-tuned LLM model to classify whether the message contains hate speech.
- Vizualizuje porušovateľov cez **webové rozhranie** v reálnom čase. 2. **MySQL Database**: Stores user information, messages, and incident timestamps.
3. **Web Application (Flask)**: Displays a real-time table of violations, updated every 5 seconds.
### Komponenty systému:
1. **Telegram Bot**: Interceptuje správy v skupine a pomocou trénovaného LLM modelu klasifikuje, či ide o nenávistnú reč.
2. **MySQL databáza**: Ukladá údaje o používateľoch, správach a čase incidentu.
3. **Webová aplikácia (Flask)**: Zobrazuje tabuľku s porušeniami, automaticky aktualizovanú každých 5 sekúnd.
--- ---
## 🧱 Zoznam použitých Docker kontajnerov ## 🧱 List of Used Docker Containers
| Kontajner | Popis | | Container | Description |
|--------------------------------------|-------| |-------------------------------------|-------------|
| `tetianamohorian/hate-speech-bot` | Obsahuje Telegram bota, klasifikačný model (napr. fine-tuned BERT), a Flask frontend. | | `tetianamohorian/hate-speech-bot` | Contains the Telegram bot, classification model (e.g. fine-tuned BERT), and Flask frontend |
| `mysql:8` | Relačný databázový systém pre ukladanie záznamov o porušovateľoch. | | `mysql:8` | Relational database for storing violator records |
--- ---
## ☸️ Zoznam Kubernetes objektov ## ☸️ List of Kubernetes Objects
| Objekt | Popis | | Object | Description |
|----------------------------|-------| |---------------------------|-------------|
| `Namespace: botspace` | Izolovaný priestor pre všetky objekty súvisiace s aplikáciou. | | `Namespace: botspace` | Isolated space for all app-related objects |
| `Deployment: bot-deployment` | Nasadzuje kontajner s botom. | | `Deployment: bot-deployment` | Deploys the container with the bot |
| `Deployment: flask-web` | Nasadzuje Flask webserver. | | `Deployment: flask-web` | Deploys the Flask web server |
| `StatefulSet: mysql` | Zabezpečuje perzistentný a konzistentný chod MySQL databázy. | | `StatefulSet: mysql` | Ensures persistent and consistent MySQL operation |
| `PersistentVolume` | Uchováva fyzické dáta databázy mimo podu. | | `PersistentVolume` | Stores database data outside the pod |
| `PersistentVolumeClaim` | Žiadosť o diskový priestor pre databázu. | | `PersistentVolumeClaim` | Requests disk space for the database |
| `Service: mysql` | Vnútorná služba pre prístup k databáze. | | `Service: mysql` | Internal service for accessing the database |
| `Service: flask-service` | Port-forward pre sprístupnenie webu. | | `Service: flask-service` | Port-forward service for accessing the web |
| `ConfigMap: init-sql` | Obsahuje SQL skripty na prvotnú inicializáciu schémy. | | `ConfigMap: init-sql` | Contains initial SQL schema scripts |
| `Secret: bot-secret` | Bezpečné uloženie citlivých údajov ako je Telegram token. | | `Secret: bot-secret` | Secure storage of sensitive data like the Telegram token |
--- ---
## 🌐 Virtuálne siete a úložiská ## 🌐 Virtual Networks and Storage
- Všetky pody komunikujú cez internú sieť v `botspace`, čím sa znižuje riziko únikov údajov. - All pods communicate over an internal network in `botspace`, minimizing data leakage risks
- `PersistentVolume` pripojený k MySQL zaručuje zachovanie dát aj po reštarte podu. - `PersistentVolume` attached to MySQL ensures data preservation even after pod restarts
--- ---
## ⚙️ Konfigurácia kontajnerov ## ⚙️ Container Configuration
- **Flask Web**: Beží na porte `5000`, ktorý je dostupný cez `flask-service`. Obnovuje sa každých 5 sekúnd pomocou JavaScriptu (AJAX `fetch`). - **Flask Web**: Runs on port `5000`, accessible via `flask-service`. Automatically updates via JavaScript (AJAX `fetch`) every 5 seconds
- **Telegram Bot**: Spustený v samostatnom threade, číta správy, klasifikuje ich pomocou PyTorch modelu (alebo HuggingFace Transformers), a zapisuje výsledok do databázy. - **Telegram Bot**: Runs in a separate thread, classifies messages using a PyTorch model or HuggingFace Transformers, and logs results into the database
- **MySQL**: Inicializovaná pomocou `initContainer`, ktorý spustí skript uložený v `ConfigMap`. - **MySQL**: Initialized with an `initContainer` that runs a script from the `ConfigMap`
--- ---
## 🚀 Návod na použitie ## 🚀 Usage Guide
### 1. Príprava aplikácie: ### 1. Prepare the Application:
```bash ```bash
./prepare-app.sh ./prepare-app.sh
``` ```
- Zostaví Docker image s aplikáciou. - Builds the Docker image
- Pushne ho do Docker Hub repozitára. - Pushes it to Docker Hub
--- ---
### 2. Spustenie aplikácie: ### 2. Start the Application:
```bash ```bash
./start-app.sh ./start-app.sh
``` ```
- Vytvorí Kubernetes objekty. - Creates Kubernetes objects
- Spustí port-forwarding pre Flask web na `localhost:8888`. - Starts port-forwarding for Flask web on `localhost:8888`
--- ---
### 3. Pozastavenie (port-forward): ### 3. Stop Port-Forwarding:
```bash ```bash
pkill -f "kubectl port-forward" pkill -f "kubectl port-forward"
``` ```
- Zastaví dočasný prístup cez port-forward. - Terminates temporary access via port-forward
--- ---
### 4. Odstránenie aplikácie: ### 4. Remove the Application:
```bash ```bash
./stop-app.sh ./stop-app.sh
``` ```
- Zmaže celý `botspace`, vrátane databázy a všetkých služieb. - Deletes the entire `botspace`, including database and services
--- ---
## 🌍 Prístup k webovej aplikácii ## 🌍 Accessing the Web Interface
Po úspešnom spustení aplikácie otvorte webový prehliadač: After launching the app, open a browser:
``` ```
http://localhost:8888 http://localhost:8888
``` ```
- Zobrazí sa tabuľka s informáciami o porušovateľoch. - A table of violators will be displayed
- Dáta sa aktualizujú automaticky každých 5 sekúnd bez potreby obnoviť stránku. - Data updates automatically every 5 seconds
--- ---
## 📦 Použité technológie ## 📦 Technologies Used
- **Python, Flask, PyTorch / Transformers** – analýza a klasifikácia textov - **Python, Flask, PyTorch / Transformers** – text analysis and classification
- **Docker, Docker Hub** – kontajnerizácia - **Docker, Docker Hub** – containerization
- **Kubernetes** – orchestrácia, škálovanie a sieťová izolácia - **Kubernetes** – orchestration, scaling, and network isolation
- **MySQL** – relačné databázové úložisko - **MySQL** – relational data storage
- **JavaScript (AJAX)** – aktualizácia frontendu v reálnom čase - **JavaScript (AJAX)** – real-time frontend updates