From 724134eaa57fee01edccb589e20fa92dbba15162 Mon Sep 17 00:00:00 2001
From: holzi1005 <holzi1005@noreply.localhost>
Date: Tue, 22 Apr 2025 09:12:51 +0200
Subject: [PATCH] Add REAME.md

---
 REAME.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 REAME.md

diff --git a/REAME.md b/REAME.md
new file mode 100644
index 0000000..92a6e45
--- /dev/null
+++ b/REAME.md
@@ -0,0 +1,72 @@
+# LiveKit Egress Docker Image
+
+Dies ist ein geklontes Docker-Image für [LiveKit Egress](https://github.com/livekit/egress), eine leistungsstarke Lösung zur Aufnahme und Weiterleitung von Echtzeit-Audio- und Videoinhalten.
+
+## 📦 Inhalt
+
+Dieses Repository enthält:
+
+- Eine Dockerfile-Konfiguration für den Betrieb von LiveKit Egress in einem Container.
+- Beispieldateien für Konfiguration und Ausführung.
+- Eine Möglichkeit, die Egress-Funktion lokal oder in der Cloud bereitzustellen.
+
+## 🚀 Schnellstart
+
+### 1. Klonen des Repositories
+
+```bash
+git clone <dieses-repo>
+cd <dieses-repo>
+```
+
+### 2. Image bauen
+
+```bash
+docker build -t livekit-egress .
+```
+
+### 3. Container starten
+
+```bash
+docker run --rm \
+  -e EGRESS_API_KEY=<your_api_key> \
+  -e EGRESS_API_SECRET=<your_api_secret> \
+  -e LIVEKIT_URL=<wss://your.livekit.server> \
+  livekit-egress
+```
+
+> **Hinweis**: Ersetze die Umgebungsvariablen durch deine tatsächlichen LiveKit-Zugangsdaten.
+
+## ⚙️ Konfiguration
+
+Die Konfiguration kann entweder über Umgebungsvariablen oder eine YAML-Datei erfolgen. Siehe [LiveKit Egress Doku](https://docs.livekit.io/egress/) für alle verfügbaren Optionen.
+
+### Beispiel: `config.yaml`
+
+```yaml
+api_key: your_api_key
+api_secret: your_api_secret
+ws_url: wss://your.livekit.server
+log_level: info
+```
+
+Dann kannst du das Image wie folgt mit dieser Konfiguration starten:
+
+```bash
+docker run --rm \
+  -v $(pwd)/config.yaml:/egress/config.yaml \
+  livekit-egress
+```
+
+## 🛠️ Entwicklung
+
+Wenn du Änderungen am Egress-Code machen willst:
+
+```bash
+# optional: mount lokales Verzeichnis
+docker run -v $(pwd):/app -it livekit-egress /bin/bash
+```
+
+## 📄 Lizenz
+
+Dieses Projekt basiert auf [LiveKit Egress](https://github.com/livekit/egress) und unterliegt deren Lizenzbedingungen.