Files
matrix-chat-export/README.md
Patrick Asmus 4dae5477ce
Some checks failed
Build & Push Docker Image / build-and-push (push) Failing after 5s
Add application, Dockerfile, CI workflow and documentation
- FastAPI-based Matrix chat export tool with E2E support
- Dockerfile with Python 3.12-slim base image
- Docker Compose with dedicated network configuration
- Gitea Actions workflow for automated image builds
- README with setup instructions and feature overview
- MIT license

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-07-03 08:04:27 +02:00

89 lines
2.7 KiB
Markdown

<p align="center">
<a href="https://techniverse.net">
<img src="https://assets.techniverse.net/f1/git/graphics/repo-techniverse-logo.png" alt="Techniverse Community" height="70" />
</a>
</p>
<h1 align="center">Matrix Chat Export</h1>
<h4 align="center">
Web-basiertes Tool zum Exportieren von Matrix-Chaträumen inkl. Medien und E2E-Verschlüsselung
</h4>
<h6 align="center">
<a href="https://www.cleveradmin.de">🏰 Website</a>
·
<a href="https://techniverse.net">📰 Community</a>
·
<a href="https://social.techniverse.net/@donnerwolke">🐘 Mastodon</a>
·
<a href="https://matrix.to/#/#support:techniverse.net">💬 Support</a>
</h6>
<br><br>
## Funktionen
- **Matrix-Chaträume exportieren** — vollständiger Nachrichtenverlauf als HTML-Datei
- **Medien-Download** — Bilder, Videos, Audio, Dateien und Sticker werden mitgespeichert
- **E2E-Verschlüsselung** — Import von Megolm-Schlüsseln zum Entschlüsseln verschlüsselter Nachrichten
- **Inkrementeller Export** — bei erneutem Export werden nur neue Nachrichten geladen
- **ZIP-Download** — fertigen Export als ZIP-Archiv herunterladen
- **Zwei Login-Methoden** — Anmeldung per Access Token oder Benutzername/Passwort
- **Session-Wiederherstellung** — bestehende Sitzungen werden automatisch wiederhergestellt
## Voraussetzungen
- Docker & Docker Compose
## Installation
```bash
git clone https://git.techniverse.net/scriptos/matrix-chat-export.git
cd matrix-chat-export
docker compose up -d
```
Die Anwendung ist anschließend unter `http://<host>:8092` erreichbar.
## Konfiguration
| Variable | Beschreibung | Standard |
|----------|-------------|----------|
| `TZ` | Zeitzone | `Europe/Berlin` |
| `LOG_LEVEL` | Log-Level (`DEBUG`, `INFO`, `WARNING`, `ERROR`) | `INFO` |
### Volumes
| Pfad (Container) | Beschreibung |
|-------------------|-------------|
| `/app/exports` | Gespeicherte Chat-Exports |
| `/app/store` | Session-Daten und importierte Schlüssel |
## Verwendung
1. Anwendung im Browser öffnen
2. Mit dem Matrix-Homeserver verbinden (Token oder Passwort)
3. Optional: E2E-Schlüssel importieren (für verschlüsselte Räume)
4. Raum auswählen und Export starten
5. Export als HTML ansehen oder als ZIP herunterladen
> **Hinweis:** Es wird kein Admin-Token benötigt. Ein normaler Benutzer-Access-Token ist ausreichend.
> Die Anwendung greift ausschließlich auf Räume zu, in denen der Benutzer Mitglied ist.
## Technologie
- **Backend:** Python 3.12, FastAPI, matrix-nio
- **Container:** Docker mit Python-Slim Base Image
<br><br>
<p align="center">
<img src="https://assets.techniverse.net/f1/git/graphics/gray0-catonline.svg" alt="">
</p>
<p align="center">
<sub>
© Patrick Asmus · Techniverse Network · <a href="./LICENSE">Lizenz</a>
</sub>
</p>