OpenPaw Dokumentation
Diese Dokumentation beschreibt die Nutzung und Vorbereitung des
OpenPaw-Memory-Servers mit Website, Login-Bereich und unabhängiger Memory-API.
Einstieg
- Projekt-README: Architektur, Setup, Sicherheit,
Backup-Konzept und Deployment-Schritte.
- Installation: Schrittweise Installation aus dem
release/
Paket auf einem PHP-Webspace.
- Releases: Version erhöhen und das
release/ Paket neu bauen.
- Website-Struktur: Startseite, Login, geschützter Chat-Bereich
und Trennung von Website und API.
- API-Nutzung: Endpunkte, Authentifizierung, Memory-Datenmodell,
curl-Beispiele und Fehlercodes.
Häufige Aufgaben
- Projekt verstehen: zuerst die Projekt-README lesen.
- Installation planen: danach Installation durcharbeiten.
- Release bauen:
release/ mit Releases aktualisieren.
- Website vorbereiten: anschließend Website-Struktur prüfen.
- API anbinden: danach API-Nutzung verwenden.
- Deployment absichern: Sicherheits- und Backup-Abschnitte in der
Projekt-README durcharbeiten.
Wichtige Pfade
- Website:
/
- Login:
/login
- geschützter Chat-Platzhalter:
/chat
- API-Basis:
/api
- API-Health:
/api/health
- Memory-Endpunkte:
/api/memories
Hinweise
- Keine echten Tokens, Domains, Hoster-Details oder Zugangsdaten in die
Dokumentation schreiben.
- Die API bleibt unabhängig von der Landing-Page erreichbar.
- Die aktuelle Chat-Seite ist nur vorbereitet; die OpenPaw-Anbindung folgt
später.