65 lines
3.4 KiB
Markdown
65 lines
3.4 KiB
Markdown
# Nachrichten – Chat-Plugin für Inhaus
|
||
|
||
Direktnachrichten und Gruppenchats im Mitarbeiterportal.
|
||
|
||
- **Direktnachrichten** an alle Kolleginnen und Kollegen (Personensuche), **Gruppenchats** für alle mit dem Recht
|
||
„Gruppenchats anlegen“ (unter Rollen vergeben). Gruppen-Admins benennen um, fügen hinzu, entfernen, ernennen Admins.
|
||
- **Anhänge** (Bilder, PDFs, Office …; Einfügen aus der Zwischenablage, Ziehen & Ablegen), **GIFs**, **Emojis**,
|
||
**Reaktionen**, **Antworten** auf einzelne Nachrichten, **Bearbeiten** und **Löschen** eigener Nachrichten.
|
||
- **Ungelesen-Zähler** als Sprechblase neben der Glocke, „Neu“-Trenner, „gelesen“ unter eigenen Nachrichten,
|
||
„schreibt gerade …“. Stummschalten je Gespräch.
|
||
- **Benachrichtigung** (Glocke und Push, auch in der Inhaus-App) – je Gespräch einmal, bis es gelesen ist, und nicht,
|
||
während das Gespräch offen ist.
|
||
- Handy- und Desktop-Ansicht, Tastatur (Enter sendet, Umschalt+Enter neue Zeile, Esc bricht ab), Screenreader-Hinweise.
|
||
|
||
Voraussetzung: Inhaus **0.39.0** oder neuer.
|
||
|
||
## Installation
|
||
|
||
1. Neuestes Release herunterladen: `chat-<version>.zip` unter
|
||
https://git.loheide.cloud/friloo/inhaus-plugin-chat/releases
|
||
2. Backend → **Plugins** → hochladen → aktivieren. Updates erscheinen danach automatisch unter „Plugins“.
|
||
3. Unter **Rollen** das Recht **„Gruppenchats anlegen“** an die passenden Rollen vergeben (z. B. Teamleitungen).
|
||
4. Optional unter **Portal → Nachrichten**: GIPHY, Echtzeit, Größe von Anhängen; unter **Portal → Chat-GIFs** die
|
||
eigene GIF-Sammlung (Recht „Nachrichten einrichten“).
|
||
|
||
## Datenschutz
|
||
|
||
- Gespräche sehen nur ihre Mitglieder – **auch die Administration kann nicht mitlesen**. Anhänge liegen außerhalb des
|
||
öffentlichen Ordners und werden nur an Mitglieder ausgeliefert.
|
||
- **GIPHY** ist aus, bis ein Schlüssel eingetragen ist. Dann gehen Suchbegriffe an GIPHY und die Bilder werden von dort
|
||
geladen. Die eigene Sammlung bleibt im Haus.
|
||
- **Echtzeit**: Über den Dienst geht nur das Signal „es gibt Neues“ – keine Inhalte.
|
||
- Beim Entfernen des Plugins mit „Daten löschen“ verschwinden alle Nachrichten und Anhänge.
|
||
|
||
## Echtzeit (optional)
|
||
|
||
Ohne Einrichtung fragt der Chat alle 3 Sekunden (im Hintergrund seltener) nach Neuem – das läuft auf jedem Webspace.
|
||
Für sofortige Zustellung einen Pusher-kompatiblen Dienst eintragen:
|
||
|
||
- **pusher.com**: App anlegen, App-ID, Key, Secret und Cluster eintragen, Server leer lassen.
|
||
- **Laravel Reverb / Soketi** (eigener Server): App-ID, Key, Secret, Server (z. B. `ws.example.org`), Port (443).
|
||
Der Server muss vom Browser (WebSocket) und vom Portal (HTTP) aus erreichbar sein.
|
||
|
||
## Schnittstelle für die App
|
||
|
||
Unter `/api/v1/chat/…` (Token nötig): `GET conversations`, `POST direct {user_id}`,
|
||
`GET conversations/{id}/messages?vor=`, `POST conversations/{id}/messages {body, gif_url, reply_to, files[]}`,
|
||
`POST conversations/{id}/read {message_id}`, `GET unread`.
|
||
|
||
## Entwicklung
|
||
|
||
```bash
|
||
npm install
|
||
npm run build # dist/ – wird mit ins Repository eingecheckt
|
||
npm run package # baut und erzeugt chat-<version>.zip
|
||
```
|
||
|
||
Tests laufen in einer Inhaus-Installation, in der das Plugin unter `plugins/chat` liegt (Kopie oder Symlink):
|
||
|
||
```bash
|
||
vendor-dev/bin/phpunit plugins/chat/tests
|
||
```
|
||
|
||
Release: Version in `plugin.json` erhöhen, `npm run package`, Tag `vX.Y.Z` setzen und
|
||
`tea release create --tag vX.Y.Z --asset chat-X.Y.Z.zip`.
|