{% extends "base.html" %} {% block title %}Dokumentation{% endblock %} {% block content %}
Version {{ app_version }} · Vollständiges Handbuch für Einrichtung, Multi-Wiki, Authentifizierung und API.
pip install -r requirements.txt./start.sh (oder python3 run.py --port 8080)/register umgeleitet, um den ersten Benutzer (Administrator) anzulegen.http://localhost:8080/LLMWikiNG/Das ursprüngliche wiki/ wird beim ersten Start
automatisch nach wikis/main/ verschoben (Daten bleiben erhalten).
Jedes Wiki liegt in wikis/<name>/ und hat einen eigenen
Namen. Über die WebUI lässt sich ein neues Wiki anlegen:
/LLMWikiNG/wikis/new – Wiki über das Formular erstellen./LLMWikiNG/wiki/<Name>//LLMWikiNG/wiki/<Name>/<Seite>Der Basis-Pfad ist über die Umgebungsvariable
LLMWIKI_BASE_PATH konfigurierbar (Standard: /LLMWikiNG),
z. B. für example.com/LLMWikiNG/wiki/<Name>/.
/register (wird nach dem ersten Benutzer automatisch deaktiviert)./LLMWikiNG/users – Benutzer anlegen/löschen (nur Admin)./LLMWikiNG/api-keys – API-Keys verwalten (nur Admin).X-API-Password) mitgesendet wird.Die zentrale Konfigurationsseite /LLMWikiNG/settings ist in Tabs unterteilt:
config.json gespeichert.opencode, hermes, agy). Gespeichert in ai.config.json.config.json)..tar.xz-Backups erstellen, herunterladen, wiederherstellen und löschen.LLMWikiNG enthält eine integrierte Same-Container Tailscale Integration (unter Einstellungen ➜ Tailscale). Damit kannst du deine Instanz im privaten Tailnet-Netzwerk bereitstellen oder per Tailscale Funnel öffentlich im Internet für externe KI-Agenten (z. B. Claude, Grok, Cursor, AGY) erreichbar machen – ohne Port-Forwarding, NGINX oder CGNAT-Probleme.
zerodot1sllmwiking) festlegen, Checkbox „Funnel (öffentlich im Internet)“ aktivieren und auf „Alles einrichten“ klicken.https://<hostname>.<tailnet>.ts.net frei. Die Autorisierung erfolgt weiterhin über API-Keys / MCP-Keys.tailscale cert <dns_name> inklusive eigenem UI-Button unter Einstellungen ➜ Tailscale.data/tailscale.json (chmod 0o600) gespeichert. Die Anzeige erfordert die Eingabe des Admin-Passworts.cap_add: [NET_ADMIN, NET_RAW] und das Device /dev/net/tun sowie Mounts für ts-data und ts-config.LLMWikiNG bietet ein vollständiges Backup-Management unter Einstellungen ➜ Backups (nur Admin). Backups werden als komprimierte .tar.xz-Archive erstellt und im data/-Verzeichnis gespeichert.
Backups können auch programmatisch über die API verwaltet werden (siehe API-Abschnitt unten).
Alle Funktionen sind unter /LLMWikiNG/api/v1 per
X-API-Key-Header erreichbar. Das Browser-Frontend nutzt automatisch Session-Cookie-Auth als Fallback.
Nutze die offizielle Fernbedienung (SKILL.md) für deinen Antigravity-Agenten zur automatischen Steuerung des Wikis.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET | /api/v1/wikis | Alle Wikis |
GET | /api/v1/wikis/<wiki>/pages | Seiten eines Wikis |
GET | /api/v1/wikis/<wiki>/pages/<slug> | Eine Seite |
GET | /api/v1/wikis/<wiki>/tags | Tags mit Seitenanzahl (optionaler Filter via ?tag=) |
POST | /api/v1/wikis/<wiki>/pages | Seite anlegen (Scope write) |
POST | /api/v1/wikis/<wiki>/pages/<slug>/export | Seite exportieren |
POST | /api/v1/wikis/<wiki>/ingest | Datei hochladen (raw/) |
GET | /api/v1/wikis/<wiki>/pending | Ausstehende Ingests |
POST | /api/v1/wikis/<wiki>/ingest/process | Ingest verarbeiten |
GET | /api/v1/search?q=&wiki= | Volltextsuche (Unterstützt wiki=all für Cross-Wiki-Suche) |
GET | /api/v1/graph?wiki= | Graph-Daten |
GET | /api/v1/stats?wiki= | Statistik |
GET | /api/v1/lint?wiki= | Linter |
GET | /api/v1/status | Serverstatus |
GET | /api/v1/system/health | Vollständiger Bereitschaftscheck: Sync-Status, Quellen-Freshness, Qualitätsprobleme, Tools, Cache und aggregierte Nutzung |
GET | /api/v1/wikis/<wiki>/usage | Lokale aggregierte Seitenzugriffe ohne Protokollierung von Suchanfragen oder Inhalten |
GET | /api/v1/system/status | System & Traffic (Admin) |
POST | /api/v1/system/sync | Sync aller Wikis (Admin) |
GET | /api/v1/system/audit | Audit-Logs abrufen – filterbar nach Aktion, Benutzer, Zeitraum (Admin) |
GET | /audit/export?fmt=json|csv | Audit-Logs als JSON oder CSV exportieren (Admin) |
GET | /api/v1/system/backups | Serverseitige Backups auflisten (Admin) |
POST | /api/v1/system/backups | Serverseitiges Backup erstellen (Admin) |
POST | /api/v1/system/backups/<file>/restore | Serverseitiges Backup wiederherstellen (Admin) |
DELETE | /api/v1/system/backups/<file> | Serverseitiges Backup löschen (Admin) |
GET | /api/v1/system/update/check | Update-Verfügbarkeit prüfen (Admin) |
POST | /api/v1/system/update/run | Update ausführen (Admin) |
GET | /api/v1/users | Benutzer (Admin) |
POST | /api/v1/users | Benutzer anlegen (Admin) |
DELETE | /api/v1/users/<id> | Benutzer löschen (Admin) |
GET | /api/v1/api-keys | API-Keys (Admin) |
POST | /api/v1/api-keys | Key erzeugen (Admin) |
DELETE | /api/v1/api-keys/<id> | Key widerrufen (Admin) |
GET | /api/v1/mcp-keys | MCP-Keys auflisten (Admin) |
POST | /api/v1/mcp-keys | MCP-Key mit Tool-Berechtigungen erzeugen (Admin) |
PUT | /api/v1/mcp-keys/<id> | MCP-Key bearbeiten – Name, User, Tools, Status (Admin) |
DELETE | /api/v1/mcp-keys/<id> | MCP-Key widerrufen (Admin) |
POST | /wiki/<wiki>/api/ingest | Direkter Ingest für spezifisches Wiki (API-Key) |
POST | /wiki/<wiki>/api/sync | Direktes Syncen für spezifisches Wiki (API-Key) |
GET | /mcp/sse | MCP SSE-Kanal für KI-Agenten (MCP API-Key) |
POST | /mcp/messages | MCP JSON-RPC Nachrichtenkanal (MCP API-Key) |
Exportiere deine Variablen, um die Befehle direkt zu kopieren:
export API_KEY="llmw_dein_key"
export SERVER_URL="http://localhost:8082/LLMWikiNG"
export WIKI="main"
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/wikis"
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/wikis/$WIKI/pages"
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/wikis/$WIKI/pages/llm-wiki"
curl -X POST -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
-d '{"slug":"api-test","content":"---\ntype: Concept\ntitle: API Test\ntimestamp: 2026-07-14T22:00:00Z\n---\n# API Test\nErfolgreich erstellt!"}' \
"$SERVER_URL/api/v1/wikis/$WIKI/pages"
# URL-Ingest
curl -X POST -H "X-API-Key: $API_KEY" -d "url=https://de.wikipedia.org/wiki/Google" -d "title=Google" "$SERVER_URL/wiki/$WIKI/api/ingest"
# Datei-Upload
curl -X POST -H "X-API-Key: $API_KEY" -F "file=@/pfad/zur/datei.txt" "$SERVER_URL/wiki/$WIKI/api/ingest"
# Text-Paste
curl -X POST -H "X-API-Key: $API_KEY" -d "text=# Mein Text\nInhalt..." -d "title=Text-Paste" "$SERVER_URL/wiki/$WIKI/api/ingest"
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/search?q=Suchbegriff&wiki=$WIKI"
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/wikis/$WIKI/graph"
curl -X POST -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
-d '{"username":"neuer_user","password":"sicheres_passwort","role":"editor"}' \
"$SERVER_URL/api/v1/users"
# Listen
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/api-keys"
# Erzeugen (optional mit require_password: true)
curl -X POST -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
-d '{"name":"Neuer Key","require_password":false,"scopes":["read","write"]}' \
"$SERVER_URL/api/v1/api-keys"
# MCP-Keys auflisten
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/mcp-keys"
# Neuen MCP-Key mit Tool-Berechtigungen erzeugen
curl -X POST -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
-d '{"name":"Cursor Agent","user_id":1,"allowed_tools":["okf_list_wikis","okf_read_concept","okf_search"]}' \
"$SERVER_URL/api/v1/mcp-keys"
# Update-Verfügbarkeit prüfen:
curl -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/system/update/check"
# Update ausführen:
curl -X POST -H "X-API-Key: $API_KEY" "$SERVER_URL/api/v1/system/update/run"
LLMWikiNG stellt einen nativen Model Context Protocol (MCP) Server über HTTP-SSE bereit. Dies ermöglicht es KI-Assistenten (wie Cursor, OpenCode und dem Antigravity agy CLI), das Wiki im Open Knowledge Format (OKF v0.2) zu durchsuchen, zu lesen und zu beschreiben.
Konfiguriere den MCP-Server vor dem Start über Umgebungsvariablen:
# MCP aktivieren (Standard: true)
ENABLE_MCP_SERVER=true
# Endpunkte absichern (X-API-Key erforderlich)
LLMWIKING_MCP_KEY="dein_sicherer_mcp_key_2026"
Dies schaltet die MCP-Endpunkte unter folgenden URLs frei:
http://localhost:8080/LLMWikiNG/mcphttp://localhost:8080/LLMWikiNG/mcp/ssehttp://localhost:8080/LLMWikiNG/mcp/messagesGehe in Cursor zu Settings ➜ Features ➜ MCP und klicke auf "+ Add New MCP Server":
LLMWikiNG-OKFSSEhttp://localhost:8080/LLMWikiNG/mcp/sse{"X-MCP-Key": "dein_sicherer_mcp_key_2026", "X-API-Key": "dein_datenbank_api_schluessel"}Füge den Serverblock in deiner globalen (~/.config/opencode/opencode.json) oder projektspezifischen (opencode.json) Konfiguration hinzu:
{
"mcp": {
"llmwiking-okf": {
"type": "remote",
"url": "http://localhost:8080/LLMWikiNG/mcp/sse",
"enabled": true,
"headers": {
"X-MCP-Key": "dein_sicherer_mcp_key_2026",
"X-API-Key": "dein_datenbank_api_schluessel"
}
}
}
}
agy) & Antigravity IDE
Registriere den SSE-Server in deiner globalen MCP-Konfigurationsdatei unter ~/.gemini/config/mcp_config.json (oder projektbezogen unter .agents/mcp_config.json):
{
"mcpServers": {
"llmwiking-okf": {
"type": "http",
"url": "http://localhost:8080/LLMWikiNG/mcp",
"headers": {
"X-MCP-Key": "dein_sicherer_mcp_key_2026",
"X-API-Key": "dein_datenbank_api_schluessel"
}
}
}
}
Nach der Verbindung mit LLMWikiNG via MCP öffnet die Eingabe von / in unterstützten Clients (AGY, OpenCode, Cursor, Claude Code) das Slash-Command-Menü:
/update
System-Update prüfen und ausführen
/ingest [wiki]
Ausstehende Rohquellen verarbeiten
/backup
Vollständiges Server-Backup erstellen
/search <query> [wiki]
Wiki-Seiten durchsuchen
/status
Systemstatus anzeigen
/lint [wiki]
Wiki-Gesundheitsprüfung ausführen
/read <slug> [wiki]
Wiki-Seite vollständig lesen
/sync [wiki]
Matrix-Index synchronisieren
Der MCP Tool Explorer unter Einstellungen ➜ MCP in der WebUI bietet eine kategorisierte Akkordeon-Ansicht aller 47 Tools mit Beschreibungen, Parametern und fertigen Prompts. Der Interaktive Client-Konfigurator im selben Panel erlaubt es, einen Benutzer und dessen Schlüssel auszuwählen, um mit einem Klick ein fertiges Konfigurations-Snippet für AGY, OpenCode oder Hermes zu generieren.
Wenn beim Anzeigen/Entschlüsseln eines Schlüssels die Meldung "Entschlüsselung fehlgeschlagen. Das kryptografische System-Geheimnis unterscheidet sich..." erscheint, wurde dieser Schlüssel vor einer Änderung des System-Geheimnisses (secret_key in config.json) erstellt.
config.json verschlüsselt und bleiben dauerhaft entschlüsselbar.Kopiere diesen Prompt und füge ihn in deinen KI-Assistenten (z. B. Cursor Chat, Claude Code, OpenCode oder agy) ein, damit dieser sich selbst mit dem MCP-Server verbindet:
Konfiguriere dich so, dass du dich mit dem LLMWikiNG-MCP-Server verbindest. Der Server nutzt SSE (Server-Sent Events) unter der URL: http://localhost:8080/LLMWikiNG/mcp/sse. Du musst die Header 'X-MCP-Key' mit dem Wert '<DEIN_MCP_SERVER_KEY>' und 'X-API-Key' mit dem Wert '<DEIN_AGENT_API_KEY>' mitsenden. In OpenCode füge dies unter 'mcp' in deiner Konfigurationsdatei hinzu. In Antigravity (agy) füge es unter 'mcpServers' in der Datei ~/.gemini/config/mcp_config.json hinzu.
Das System verwendet ein zentrales Geheimnis, um Browser-Sitzungscookies zu signieren und API-Schlüssel zu verschlüsseln. Es wird aus der Umgebungsvariablen LLMWIKI_SECRET ausgelesen oder beim ersten Start automatisch generiert und dauerhaft in der Datei config.json (unter dem Schlüssel "secret_key") gespeichert.
"secret_key" in der config.json ein.Das Aussehen (Dark/Light) wird ausschließlich in den
Einstellungen gesteuert und persistent in config.json gespeichert
("theme": "dark" bzw. "light"). Dark Mode ist Standard
und wird server-seitig geladen – es gibt keine Umschalter-Buttons in der Sidebar.
/LLMWikiNG/settings?tab=theme – Theme über das Tab „Erscheinungsbild“ ändern.POST /LLMWikiNG/theme/set – direkt via Form-Feld value=dark|light (Login nötig)."theme" in config.json auf dark setzen.Das Docker-Setup ist speziell für UGreen NAS-Systeme (UGOS) optimiert, um eine reibungslose Kompatibilität zu gewährleisten. Die Ordnerstruktur wird dabei automatisch unter volume1/docker/llmwiking/ abgelegt.
Beim Importieren des Images in den UGreen Container Manager werden folgende Volumes vordefiniert:
/app/data ➜ /volume1/docker/llmwiking/data (Benutzer und API-Keys)/app/wikis ➜ /volume1/docker/llmwiking/wikis (Wiki-Inhalte)/app/raw ➜ /volume1/docker/llmwiking/raw (Rohquellen)/app/output_docs ➜ /volume1/docker/llmwiking/output_docs (Dokument-Exporte)Um das Setup auf einem anderen Host (z. B. lokal) auszuführen, ohne dass Mount-Fehler (z. B. durch config.json) auftreten, kann die Umgebungsvariable DOCKER_VOLUME_BASE genutzt werden:
.env-Datei im Projektverzeichnis:
DOCKER_VOLUME_BASE=.
docker compose up --build
Das CSS wird über eine CSS-First-Pipeline gebaut
(@theme mit oklch-Design-Tokens, Dark Mode, responsiv):
cd frontend && npm install && npm run build
base.html bindet static/css/tailwind-build.css ein;
das gesamte JavaScript liegt als ES-Module unter static/js/.
/ – Dashboard (Wiki-Übersicht)/login, /logout, /users, /api-keys/wikis/new, /wiki/<Name>/, /wiki/<Name>/<Seite>/graph, /graph/data?wiki=, /search, /tags, /ingest/raw, /pending, /export, /lint, /status/settings, /briefings, /config, /about, /docs