Fix README formatting and add Greenfield installation instructions
This commit is contained in:
72
README.md
72
README.md
@@ -3,44 +3,72 @@
|
|||||||
Dieses Projekt verwaltet selbst-gehostete Matrix-Bridges für Beeper mittels Docker Compose.
|
Dieses Projekt verwaltet selbst-gehostete Matrix-Bridges für Beeper mittels Docker Compose.
|
||||||
|
|
||||||
## Struktur
|
## Struktur
|
||||||
- \`docker-compose.yml\`: Definition der Dienste (WhatsApp, Telegram, Signal, Google Chat).
|
- `docker-compose.yml`: Definition der Dienste (WhatsApp, Telegram, Signal, Google Chat).
|
||||||
- \`data/\`: Persistente Daten für die Bridges (Configs + SQLite Datenbanken).
|
- `data/`: Persistente Daten für die Bridges (Configs + SQLite Datenbanken).
|
||||||
- \`migrate.sh\`: Hilfsskript zum Importieren bestehender lokaler Installationen.
|
- `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.
|
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
|
./migrate.sh
|
||||||
\`\`\`
|
```
|
||||||
|
|
||||||
### 2. Starten
|
### Option B: Neuinstallation (Greenfield)
|
||||||
Startet alle Bridges im Hintergrund.
|
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/<bridge>/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
|
docker compose up -d
|
||||||
\`\`\`
|
|
||||||
|
|
||||||
### 3. Logs prüfen & QR-Code scannen
|
# Oder um alle Logs direkt zu sehen (zum Debuggen)
|
||||||
Falls du dich neu anmelden musst, findest du den QR-Code im Log des jeweiligen Containers:
|
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
|
docker compose logs -f whatsapp
|
||||||
# oder
|
```
|
||||||
docker compose logs -f telegram
|
|
||||||
\`\`\`
|
|
||||||
|
|
||||||
Alternativ kannst du im Beeper-Chat mit dem Bridge-Bot \`login\` schreiben.
|
|
||||||
|
|
||||||
## Wartung
|
## Wartung
|
||||||
|
|
||||||
**Update der Bridges:**
|
**Update der Bridges:**
|
||||||
\`\`\`bash
|
```bash
|
||||||
|
# Zieht die Images nacheinander (vermeidet Timeouts)
|
||||||
docker compose pull
|
docker compose pull
|
||||||
|
|
||||||
|
# Startet neu
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
\`\`\`
|
```
|
||||||
|
|
||||||
**Backup:**
|
**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.
|
||||||
Reference in New Issue
Block a user