Update README.md

README.md

@@ -1,75 +1,87 @@
-## Matrix Jitsi-admin Bot
+# Matrix Meetling Bot
 
-Dies ist ein Bot, der für die Verwaltung von Jitsi-Meetings über Matrix erstellt wurde. Der Bot ermöglicht die Steuerung und Verwaltung von Meetings über eine Matrix-Instanz.
+Ein Bot zur Verwaltung von **Jitsi-Meetings** über eine **Matrix-Instanz**. Mit diesem Bot lassen sich Jitsi-Sitzungen direkt über Matrix steuern und verwalten - ideal für automatisierte Konferenzen und Raumverwaltung.
-
-### Installation
-
-#### Token erstellen
-
-1. Klonen des Repositorys:
-
-   ```
-   git clone https://de-h2-git01.h2.home/emanuel.holzmann/matrix-bot.git
-   ```
-
-2. Installation der benötigten Pakete:
-
-   ```
-   npm install
-   ```
-
-3. Generieren des Tokens:
-
-   Führen Sie den folgenden Befehl aus und ersetzen Sie `username`, `passwort` und `https://matrixdomain.org` durch die entsprechenden Anmeldeinformationen:
-
-   ```shell
-   MATRIX_USERNAME=username MATRIX_PASSWORD=passwort MATRIX_URL=https://matrixdomain.org node login.mjs 
-   ```
-
-   Der generierte Access-Token muss sicher aufbewahrt werden, da er der Schlüssel für den Docker-Container ist.
-
-#### Container starten
-
-1. Erneutes Checkout der Anwendung (optional, wenn bereits geklont):
-
-   ```
-   git clone https://de-h2-git01.h2.home/emanuel.holzmann/matrix-bot.git
-   ```
-
-2. Wechseln in das Verzeichnis:
-
-   ```
-   cd matrix-bot
-   ```
-
-3. Bauen der Anwendung und Starten des Containers mit `docker-compose`:
-
-   Führen Sie den folgenden Befehl aus und ersetzen Sie `tokenKommtHIerHer` durch den generierten Accesstoken aus Schritt 1, `https://matrixdomain.org` und `https://jitsi-admin-url.de` müssen durch reale URLs ersetzt werden:
-
-   ```shell
-   MATRIX_TOKEN=tokenKommtHIerHer MATRIX_URL=https://matrixdomain.org JITSI_ADMIN_URL=https://jitsi-admin-url.de docker-compose up --build -d
-   ```
-
-4. Berechtigungen für das Volume festlegen:
-
-   ```shell
-   chown -R 1000:1000 /var/lib/docker/volumes/matrix-bot_secret_data/
-   ```
-   
-5. Possible Arguments
-
-````shell
-MATRIX_URL=<Matrix Url>|https://matrix.org
-MATRIX_TOKEN=<Matrix Token>
-MATRIX_PASSWORD=<Matrix password>
-JITSI_ADMIN_URL=<jitsi admin url>|https://jitsi-admin.de
-MATRIX_DISPLAYNAME=<displayName of the bot>|"Raumassistent"
-SHOW_WARNING_OF_MIM=<boolean show if a warning>|false
-````
-### Hinweise
-
-Stellen Sie sicher, dass die Umgebungsvariablen korrekt gesetzt sind und die Zugangsdaten sicher behandelt werden. Der Bot ermöglicht die Verwaltung von Jitsi-Meetings über Matrix und kann entsprechend konfiguriert werden.
 
 ---
 
-Bitte beachten Sie, dass die Pfadangaben, Token und URLs entsprechend Ihren tatsächlichen Konfigurationen und Anforderungen angepasst werden müssen.
+## 🚀 Funktionen
+
+- Starten und Verwalten von Jitsi-Meetings über Matrix
+- Konfigurierbare Umgebungsvariablen
+- Integration über Docker möglich
+
+---
+
+## 🛠️ Installation & Einrichtung
+
+### 1. 🔑 Matrix-Zugangstoken generieren
+
+Führe den folgenden Befehl aus, um einen Access-Token zu generieren. Ersetze `username`, `passwort` und die URL durch deine echten Zugangsdaten:
+
+```bash
+docker run --rm -it \
+  -e MATRIX_USERNAME=username \
+  -e MATRIX_PASSWORD=passwort \
+  -e MATRIX_URL=https://matrixdomain.org \
+  -v "$PWD:/app" \
+  -w /app \
+  git.h2-invent.com/meetling/matrix-bot \
+  node login.mjs
+```
+
+> 💡 **Hinweis:** Bewahre den generierten Token sicher auf - er wird zur Authentifizierung im Container verwendet.
+
+---
+
+## 🐳 Deployment mit Docker
+
+### 1. 📂 Docker Compose Download
+
+Falls noch nicht geschehen:
+
+```bash
+mkdir /opt/matrix-bot
+cd /opt/matrix-bot
+wget https://git.h2-invent.com/Meetling/matrix-bot/raw/branch/master/docker-compose.yml
+```
+
+### 2. ⚙️ Container starten
+
+Baue das Docker-Image und starte den Container. Ersetze dabei:
+
+- `tokenKommtHierHer`: den zuvor generierten Matrix Access-Token
+- `https://matrixdomain.org`: deine Matrix-Instanz
+- `https://jitsi-admin-url.de`: die Jitsi-Admin-URL
+
+```bash
+MATRIX_TOKEN=tokenKommtHierHer \
+MATRIX_URL=https://matrixdomain.org \
+JITSI_ADMIN_URL=https://jitsi-admin-url.de \
+docker-compose up -d
+```
+
+### 3. 🔐 Berechtigungen setzen
+
+Stelle sicher, dass das Docker-Volume korrekt gesetzt ist:
+
+
+---
+
+## ⚙️ Konfigurierbare Umgebungsvariablen
+
+| Variable              | Beschreibung                                                    | Beispielwert                      |
+|----------------------|------------------------------------------------------------------|-----------------------------------|
+| `MATRIX_URL`         | URL der Matrix-Instanz                                           | `https://matrix.org`              |
+| `MATRIX_TOKEN`       | Der generierte Access-Token                                      | _deinToken_                       |
+| `MATRIX_PASSWORD`    | (Optional) Passwort des Matrix-Accounts                          | `geheimesPasswort`                |
+| `JITSI_ADMIN_URL`    | URL zum Jitsi-Admin-Endpunkt                                     | `https://jitsi-admin.de`          |
+| `MATRIX_DISPLAYNAME` | Anzeigename des Bots in Matrix                                   | `"Raumassistent"`                 |
+| `SHOW_WARNING_OF_MIM`| Gibt an, ob Warnungen angezeigt werden sollen (true/false)       | `false`                           |
+
+---
+
+## 📌 Hinweise
+
+- Stelle sicher, dass alle Zugangsdaten und Tokens **sicher gespeichert** und **nicht öffentlich geteilt** werden.
+- Die in der README genannten URLs und Tokens dienen nur als **Beispiele** - bitte passe sie an deine Umgebung an.
+- Der Bot bietet eine flexible Möglichkeit, Jitsi-Meetings über Matrix zu automatisieren.