feat: add install.sh — interactive setup for beginners with emoji feedback + README overhaul

This commit is contained in:
Bernd (Hermes Agent)
2026-05-05 17:46:06 +02:00
parent 6ac0f2a08c
commit b6b3469c21
2 changed files with 271 additions and 26 deletions
+85 -26
View File
@@ -5,33 +5,57 @@
Stellt einen nativen Chatclient für das Hermes Agent Gateway bereit — mit Echtzeit-Nachrichten via WebSocket/DDP und REST-API für ausgehende Antworten.
## Features
---
- **Echtzeit-Streaming**: WebSocket/DDP für sofortige eingehende Nachrichten
- **Präsenz-Status**: Grüner Online-Indikator im Rocket.Chat
- **Markdown-Support**: Fett, kursiv, Inline-Code, Code-Blöcke, Links
- **Interaktive Buttons**: Ja/Nein, Bestätigen/Abbrechen, Mehrfachauswahl
- **Raum-Unterstützung**: Kanäle, private Gruppen, Direktnachrichten
- **Allowlist**: Steuerung, wer den Bot nutzen darf
## Schnellstart (für Neulinge)
## Installation
### 1. Voraussetzungen
```bash
# In dein Hermes Agent Verzeichnis wechseln
cd ~/.hermes/hermes-agent
# Plugin-Verzeichnis anlegen
mkdir -p plugins/platforms/rocketchat
# Diese drei Dateien hineinkopieren:
cp plugin.yaml plugins/platforms/rocketchat/
cp __init__.py plugins/platforms/rocketchat/
cp adapter.py plugins/platforms/rocketchat/
sudo apt update && sudo apt install -y curl git python3 bash
```
## Konfiguration
### 2. Plugin herunterladen
### Über Umgebungsvariablen
```bash
cd /tmp
git clone https://gitea.thomander.de/andreas/Hermes_rocket.chat_Plugin.git
cd Hermes_rocket.chat_Plugin
```
### 3. Installation starten
```bash
./install.sh
```
Das Script führt dich Schritt für Schritt durch:
- 🔵 Prüfe Voraussetzungen (curl, git, python3)
- 🔵 Erstelle Plugin-Verzeichnis
- 🔵 Kopiere alle Dateien
- 🔵 Frage deine Rocket.Chat-Daten ab
- 🔵 Teste die Verbindung
- 🔵 Schreibe Konfiguration in `~/.hermes/.env`
Am Ende ist das Plugin einsatzbereit — einfach `hermes gateway start`.
---
## Manuelle Installation (Experten)
Wer das Setup lieber von Hand macht:
```bash
# Plugin-Verzeichnis anlegen
mkdir -p ~/.hermes/hermes-agent/plugins/platforms/rocketchat
# Dateien hineinkopieren
cp plugin.yaml ~/.hermes/hermes-agent/plugins/platforms/rocketchat/
cp __init__.py ~/.hermes/hermes-agent/plugins/platforms/rocketchat/
cp adapter.py ~/.hermes/hermes-agent/plugins/platforms/rocketchat/
```
### Konfiguration über Umgebungsvariablen
```bash
export ROCKETCHAT_BASE_URL="https://rocketchat.example.com"
@@ -42,7 +66,7 @@ export ROCKETCHAT_ALLOWED_USERS="andreas,max" # optional
export ROCKETCHAT_ALLOW_ALL_USERS="false" # default
```
### Über `config.yaml`
### Konfiguration über `config.yaml`
```yaml
plugins:
@@ -52,14 +76,49 @@ plugins:
base_url: "https://rocketchat.example.com"
user: "bernd"
password: "dein-passwort"
room_id: "J3jvMyrKTMzKvKHSh" # optional
allowed_users: ["andreas", "max"] # optional
allow_all_users: false # default
room_id: "J3jvMyrKTMzKvKHSh"
allowed_users: ["andreas", "max"]
allow_all_users: false
```
## Abhängigkeiten
---
Keine externen Pakete erforderlich — nutzt ausschließlich Python-Standardbibliothek (`urllib`, `socket`, `ssl`, `threading`).
## Features
| Feature | Beschreibung |
|---------|-------------|
| 🚀 Echtzeit-Streaming | DDP/WebSocket für sofortige eingehende Nachrichten |
| 🟢 Präsenz | Grüner Online-Status im Rocket.Chat |
| ✍️ Markdown | Fett, kursiv, `Code`, Blöcke, Links |
| 🔘 Interaktive Buttons | Ja/Nein, Bestätigen/Abbrechen, Mehrfachauswahl |
| 📢 Räume | Kanäle, private Gruppen, Direktnachrichten |
| 🔒 Allowlist | Steuerung, wer den Bot nutzen darf |
| 📦 Zero-Dependency | Nur Python-Standardbibliothek |
---
## Was ist im Paket?
```
Hermes_rocket.chat_Plugin/
├── install.sh ← Interaktives Setup für neue Benutzer
├── README.md ← Diese Datei
├── COMMUNITY_POST.md ← Fertige Vorlage für Foren/Reddit
├── plugin.yaml ← Plugin-Metadaten
├── __init__.py ← Plugin-Einstieg, Button-Templates
├── adapter.py ← DDP/WebSocket + REST Adapter
└── LICENSE ← Unlicense (Public Domain)
```
---
## Hilfe & Support
- **Hermes Agent Docs**: https://hermes-agent.nousresearch.com/
- **Rocket.Chat**: https://www.rocket.chat/
- **Dieses Repo**: https://gitea.thomander.de/andreas/Hermes_rocket.chat_Plugin
---
## Lizenz