https://valoryx.org/de/docs/reference/ Recent content in Referenz on Valoryx Hugo de https://valoryx.org/de/docs/reference/api/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/de/docs/reference/api/ REST-API-Referenz DocPlatform stellt eine RESTful-JSON-API unter /api/v1/ bereit. Alle Endpunkte erfordern Authentifizierung, sofern nicht anders angegeben. Basis-URL http://localhost:3000/api/v1 Authentifizierung Die meisten Endpunkte erfordern einen JWT-Access-Token im Authorization-Header: Authorization: Bearer eyJhbGciOiJSUzI1NiIs... Token erhalten Sie über die Login- oder OIDC-Endpunkte. Token-Lebenszyklus Token Lebensdauer Zweck Access-Token 15 Minuten API-Authentifizierung Refresh-Token 30 Tage Neue Access-Token erhalten Auth-Endpunkte Registrieren POST /api/v1/auth/register Erstellt ein neues Benutzerkonto. Der erste Benutzer wird zum Super Admin. Anfrage: { "name": "Jane Smith", "email": "jane@example. https://valoryx.org/de/docs/reference/cli/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/de/docs/reference/cli/ CLI-Referenz DocPlatform bietet 5 CLI-Befehle für Serververwaltung, Workspace-Initialisierung, Diagnose und Wartung. Globale Optionen Diese Optionen gelten für alle Befehle: Flag Beschreibung --help, -h Hilfe für jeden Befehl anzeigen --version, -v Versionsinformationen ausgeben docplatform serve HTTP-Server starten. docplatform serve [flags] Flags Flag Standard Beschreibung --port 3000 HTTP-Listening-Port (überschreibt Umgebungsvariable PORT) --host 0.0.0.0 HTTP-Listening-Adresse (überschreibt Umgebungsvariable HOST) --data-dir .docplatform Datenverzeichnispfad (überschreibt Umgebungsvariable DATA_DIR) Verhalten Lädt Umgebungsvariablen aus der .env-Datei (falls vorhanden) Initialisiert die SQLite-Datenbank im WAL-Modus Führt ausstehende Datenbankmigrationen aus Lädt Casbin-Berechtigungsrichtlinien in den Speicher Baut den Bleve-Suchindex auf oder öffnet ihn Startet die Git-Sync-Engine für alle konfigurierten Workspaces Startet den Backup-Scheduler (wenn aktiviert) Stellt den Web-Editor und die API auf dem konfigurierten Port bereit Startsequenz Wenn docplatform serve ausgeführt wird, geschieht Folgendes der Reihe nach: https://valoryx.org/de/docs/reference/troubleshooting/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/de/docs/reference/troubleshooting/ Fehlerbehebung Dieser Leitfaden behandelt häufige Probleme und deren Lösungen. Für Diagnoseinformationen starten Sie immer mit: docplatform doctor Serverstart Server startet nicht: „address already in use" Ursache: Ein anderer Prozess belegt den konfigurierten Port. Lösung: # Herausfinden, was Port 3000 belegt lsof -i :3000 # macOS/Linux ss -tlnp | grep 3000 # Linux # Option 1: Den anderen Prozess stoppen # Option 2: Einen anderen Port verwenden docplatform serve --port 8080 Server startet nicht: „permission denied" Ursache: Der Prozess hat keine Lese-/Schreibrechte für das Datenverzeichnis.