From 010dc6f42e8d617edd3c2b1c66beff8c1aea59e9 Mon Sep 17 00:00:00 2001 From: Gemini Bot Date: Fri, 5 Dec 2025 03:08:36 +0000 Subject: [PATCH] Fix README formatting and add Greenfield installation instructions --- README.md | 72 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 89e615c..3dd27ca 100644 --- a/README.md +++ b/README.md @@ -3,44 +3,72 @@ Dieses Projekt verwaltet selbst-gehostete Matrix-Bridges für Beeper mittels Docker Compose. ## Struktur -- \`docker-compose.yml\`: Definition der Dienste (WhatsApp, Telegram, Signal, Google Chat). -- \`data/\`: Persistente Daten für die Bridges (Configs + SQLite Datenbanken). -- \`migrate.sh\`: Hilfsskript zum Importieren bestehender lokaler Installationen. +- `docker-compose.yml`: Definition der Dienste (WhatsApp, Telegram, Signal, Google Chat). +- `data/`: Persistente Daten für die Bridges (Configs + SQLite Datenbanken). +- `migrate.sh`: Hilfsskript zum Importieren bestehender lokaler Installationen. -## Installation & Migration +## Installation -### 1. Migration bestehender Daten +### Option A: Migration bestehender Daten Wenn du die Bridges vorher manuell (ohne Docker) betrieben hast, nutze das Skript, um Configs und Datenbanken zu importieren. Das Skript passt automatisch die Datenbank-Pfade für Docker an. -\`\`\`bash +```bash ./migrate.sh -\`\`\` +``` -### 2. Starten -Startet alle Bridges im Hintergrund. +### Option B: Neuinstallation (Greenfield) +Wenn du noch keine lokalen Bridges hast: -\`\`\`bash +1. **Ordnerstruktur anlegen:** + (Wird automatisch durch git clone erledigt, da .gitkeep Dateien existieren) + +2. **Standard-Configs generieren:** + Starte die Container kurz, damit sie die Standard-`config.yaml` Dateien erzeugen. Die Container werden sich danach beenden oder neustarten, weil die Registrierung fehlt. + ```bash + docker compose up + ``` + *Hinweis: Breche den Vorgang mit `Ctrl+C` ab, sobald die Configs erstellt wurden.* + +3. **Registrierung (WICHTIG):** + Damit Beeper die Bridges akzeptiert, benötigst du für jede Bridge eine `registration.yaml`. Diese erstellst du am besten mit dem offiziellen Tool [`bbctl`](https://github.com/beeper/bridge-manager) lokal auf deinem Rechner. + + Beispiel: + ```bash + bbctl register whatsapp + mv registration.yaml data/whatsapp/ + ``` + +4. **Konfiguration anpassen:** + Bearbeite die `data//config.yaml` falls nötig. Achte darauf, dass `sqlite:////data/bridge.db` als Datenbankpfad gesetzt ist. + +## Starten +Startet alle Bridges. + +```bash +# Im Hintergrund (Daemon) docker compose up -d -\`\`\` -### 3. Logs prüfen & QR-Code scannen -Falls du dich neu anmelden musst, findest du den QR-Code im Log des jeweiligen Containers: +# Oder um alle Logs direkt zu sehen (zum Debuggen) +docker compose up +``` -\`\`\`bash +## Logs & Login +Falls du dich neu anmelden musst (QR-Code Scan), findest du den Code in den Logs oder im Beeper "Bridge Bot" Chat. + +```bash docker compose logs -f whatsapp -# oder -docker compose logs -f telegram -\`\`\` - -Alternativ kannst du im Beeper-Chat mit dem Bridge-Bot \`login\` schreiben. +``` ## Wartung **Update der Bridges:** -\`\`\`bash +```bash +# Zieht die Images nacheinander (vermeidet Timeouts) docker compose pull + +# Startet neu docker compose up -d -\`\`\` +``` **Backup:** -Sichere einfach den kompletten \`data/\` Ordner. Er enthält alle Sitzungen und Schlüssel. +Sichere einfach den kompletten `data/` Ordner. Er enthält alle Sitzungen und Schlüssel. \ No newline at end of file