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

Aktualizovat z2/README.md

Browse Source
This commit is contained in:
Tetiana Mohorian 2025-04-10 10:59:36 +00:00
parent 7513232859
commit df6db01f2a
1 changed files with 20 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
z2/README.md
View File

@ -1,12 +1,12 @@
# 📚 Hate Speech Bot – Dokumentácia # Hate Speech Bot – Dokumentácia
## 🔍 Opis aplikácie ## Opis aplikácie
Ide o kompletný systém na detekciu nenávistných správ v prostredí Telegramu. Obsahuje Telegram bota, ktorý analyzuje správy, zaznamenáva porušenia do databázy MySQL, a webovú aplikáciu (Flask), ktorá tieto dáta zobrazuje v reálnom čase. Webová stránka sa automaticky aktualizuje každých 5 sekúnd a zobrazí najnovších porušovateľov. Ide o kompletný systém na detekciu nenávistných správ v prostredí Telegramu. Obsahuje Telegram bota, ktorý analyzuje správy, zaznamenáva porušenia do databázy MySQL, a webovú aplikáciu (Flask), ktorá tieto dáta zobrazuje v reálnom čase. Webová stránka sa automaticky aktualizuje každých 5 sekúnd a zobrazí najnovších porušovateľov.
--- ---
## 📦 Zoznam použitých kontajnerov ## Zoznam použitých kontajnerov
| Kontajner | Popis | | Kontajner | Popis |
|--------------------------------------|-------| |--------------------------------------|-------|
@ -15,7 +15,7 @@ Ide o kompletný systém na detekciu nenávistných správ v prostredí Telegram
--- ---
## ☸️ Zoznam Kubernetes objektov ## Zoznam Kubernetes objektov
| Objekt | Popis | | Objekt | Popis |
|----------------------------|-------| |----------------------------|-------|
@ -32,14 +32,14 @@ Ide o kompletný systém na detekciu nenávistných správ v prostredí Telegram
--- ---
## 🌐 Virtuálne siete a pomenované zväzky ## Virtuálne siete a pomenované zväzky
- Všetky pod-y komunikujú v internej sieti v rámci `botspace`. - Všetky pod-y komunikujú v internej sieti v rámci `botspace`.
- `PersistentVolume` pripojený k MySQL cez `PersistentVolumeClaim` zabezpečuje trvalé uloženie údajov v `/var/lib/mysql`. - `PersistentVolume` pripojený k MySQL cez `PersistentVolumeClaim` zabezpečuje trvalé uloženie údajov v `/var/lib/mysql`.
--- ---
## ⚙️ Konfigurácia kontajnerov ## Konfigurácia kontajnerov
- `flask-web` je nakonfigurovaný na porte `5000`, ktorý je sprístupnený cez službu `flask-service`. - `flask-web` je nakonfigurovaný na porte `5000`, ktorý je sprístupnený cez službu `flask-service`.
- `bot-deployment` využíva `Secret` na získanie Telegram tokenu. - `bot-deployment` využíva `Secret` na získanie Telegram tokenu.
@ -47,29 +47,29 @@ Ide o kompletný systém na detekciu nenávistných správ v prostredí Telegram
--- ---
## 🛠️ Návod na použitie ## Návod na použitie
### ✅ Príprava aplikácie: ### Príprava aplikácie:
```bash ```bash
bash prepare-app.sh ./prepare-app.sh
``` ```
➡️ Vytvorí Docker image a pushne ho na Docker Hub. Vytvorí Docker image a pushne ho na Docker Hub.
--- ---
### 🚀 Spustenie aplikácie: ### Spustenie aplikácie:
```bash ```bash
bash start-app.sh ./start-app.sh
``` ```
➡️ Vytvorí všetky Kubernetes objekty a spustí port-forward (napr. na `localhost:8080`). Vytvorí všetky Kubernetes objekty a spustí port-forward (napr. na `localhost:8080`).
--- ---
### ⏸️ Pozastavenie aplikácie (port-forward): ### Pozastavenie aplikácie (port-forward):
```bash ```bash
pkill -f "kubectl port-forward" pkill -f "kubectl port-forward"
@ -77,29 +77,25 @@ pkill -f "kubectl port-forward"
--- ---
### ❌ Odstránenie celej aplikácie: ### Odstránenie celej aplikácie:
```bash ```bash
bash stop-app.sh ./stop-app.sh
``` ```
➡️ Zmaže celý namespace `botspace` a všetky objekty. Zmaže celý namespace `botspace` a všetky objekty.
--- ---
## 🌍 Prístup k webovej aplikácii ## Prístup k webovej aplikácii
Po spustení aplikácie si otvor webový prehliadač a zadaj adresu: Po spustení aplikácie si otvor webový prehliadač a zadaj adresu:
``` ```
http://localhost:8080 http://localhost:8888
``` ```
➡️ Zobrazí sa webová stránka s tabuľkou porušovateľov, ktorá sa aktualizuje každých 5 sekúnd. Zobrazí sa webová stránka s tabuľkou porušovateľov, ktorá sa aktualizuje každých 5 sekúnd.
--- ---
## 👩‍💻 Autor
Vypracovala: **Tetiana Mohorian**
Projekt Z2 – Kubernetes nasadenie webovej aplikácie s databázou