Wiki.js Smart-Home-Integration, kostenlos und Open Source
Dein Wiki.js in Gladys: Seitenzähler, geänderte Seiten, Seiten und Journal aus Szenen.
Veröffentlicht von guim31
- Geräte
- Version 1.0.0
- Erfordert Gladys >=5.1.0
- ★ 0
Verbinde Gladys mit Wiki.js, dem selbst gehosteten Wiki: Verfolge seine Zähler, reagiere, wenn eine Seite erstellt oder geändert wird, schreibe Seiten aus deinen Szenen und führe ein Journal (Heizung, Alarmanlage, Garten…), das Gladys Zeile für Zeile füllt. Alles bleibt in deinem lokalen Netzwerk: Gladys spricht direkt mit deinem Wiki.js.
Getestet mit einem echten Wiki.js 2.5.317 (dem offiziellen Docker-Image). Rückmeldungen sind im Gladys-Forum willkommen.
Voraussetzungen
- Gladys Assistant 5.1 oder neuer.
- Wiki.js 2.x, erreichbar vom Gladys-Rechner. Wiki.js 3 wird nicht unterstützt.
- Ein API-Schlüssel: Öffne in Wiki.js Administration → API Access, klicke auf Enable API, falls sie aus ist, dann auf New API Key. Ein Full Access-Schlüssel passt. Ein auf eine Gruppe beschränkter Schlüssel sieht, was die Gruppe sieht: Er muss die Seiten lesen und, für die Szenenaktionen, schreiben dürfen. Kopiere den Schlüssel: Er wird nur einmal angezeigt.
Konfiguration
- Öffne den Tab Konfiguration der Integration.
- Gib unter Wiki.js-Adresse die Adresse ein, unter der du Wiki.js öffnest,
zum Beispiel
192.168.1.50:3000oderhttps://wiki.example.org. - Füge den API-Schlüssel ein.
- Wiki.js lesen alle: 5, 15 (Standard), 30 oder 60 Minuten. Geänderte Seiten werden beim nächsten Lesen gemeldet.
- Sprache der Namen und Meldungen legt die Namen der Funktionen (beim Hinzufügen eines Geräts festgelegt) und die Texte der Integration fest. Standardmäßig Französisch.
- Speichere und nutze dann Verbindung testen: Das zeigt die Anzahl der Seiten.
- Füge im Tab Entdecken das Gerät Wiki.js hinzu.
Geräte
Wiki.js (ein Gerät):
| Funktion | Wert |
|---|---|
| Seiten | Anzahl der Seiten |
| Heute geänderte Seiten | seit Mitternacht erstellte oder gespeicherte Seiten |
| Zuletzt geänderte Seite | Titel der zuletzt erstellten oder gespeicherten Seite |
Die Zähler behalten ihren Verlauf. Das Gerät behält seine Identität, wenn sich die Adresse von Wiki.js ändert.
Dashboard-Widget
Wiki.js: zwei Kacheln (Seiten, heute geänderte Seiten) und die acht zuletzt
geänderten Seiten mit ihrem Pfad und der Uhrzeit der Änderung. In den
Widget-Einstellungen behält Ordner die Seiten unter einem Pfad (z. B.
haus) und Tag die Seiten mit diesem Tag; die Kachel zählt sie dann.
Zähler ausblenden behält nur die Liste. Wenn Wiki.js über https erreichbar
ist, öffnet sich jede Seite in Wiki.js.
Szenen-Auslöser
- Wiki.js-Seite erstellt oder geändert: Eine Seite wird in Wiki.js erstellt
oder gespeichert. Filter: Ordner (der erste Teil des Pfads, z. B.
hausfürhaus/heizung), Seitenpfad (eine einzelne Seite, z. B.haus/heizung) und Änderung (erstellt, aktualisiert oder leer: beide). Leere Filter lassen jede Seite durch. - Wiki.js-Seite mit Tag geändert: dasselbe für Seiten mit einem Tag:
Tag (Pflicht, kleingeschrieben, wie Wiki.js ihn speichert, z. B.
journal), Ordner und Änderung. Eine Seite mit mehreren Tags löst einmal pro Tag aus, sodass eine Szene auf einen Tag nur einmal läuft.
Pfade werden wie in der Adresse der Seite geschrieben, ohne Sprache (/de/) und
ohne Schrägstriche an den Enden.
Variablen: Seitentitel, Seitenpfad, Ordner, Änderung (created
oder updated), Adresse der Seite, Aktualisiert von, Tags (durch
Kommas getrennt), Seiten-ID und Tag für den zweiten Auslöser.
Das erste Lesen nach der Installation ist still: Bereits vorhandene Seiten werden nicht gemeldet. Seiten, die diese Integration schreibt, werden nie gemeldet. Pro Lesen werden höchstens zehn Seiten gemeldet, die ältesten zuerst; die nächsten warten auf das nächste Lesen. Bei mehr als 50 Änderungen zwischen zwei Lesevorgängen (ein Import) werden zehn gemeldet und der Rest gilt als gesehen.
Szenenaktionen
- Wiki.js-Seite erstellen: Seitenpfad (z. B.
berichte/2026-10), Titel und optional Inhalt (Markdown) und Tags (durch Kommas getrennt). Die Seite wird veröffentlicht, in der Sprache der meisten Seiten des Wikis. Eine Seite unter diesem Pfad ist ein Fehler: Diese wird nie überschrieben. - Zeile zu einer Wiki.js-Seite hinzufügen: Seitenpfad und Zeile. Die Zeile wird am Ende der Seite als neuer Absatz angefügt, mit Datum und Uhrzeit davor, außer Mit Datum und Uhrzeit beginnen ist aus. Die Seite wird bei ihrer ersten Zeile erstellt, mit dem Ende ihres Pfads als Titel, außer Titel, falls die Seite erstellt wird ist ausgefüllt. Markdown-Seiten erhalten die Zeile als Markdown, Seiten des visuellen Editors als reinen Text. Alles andere der Seite (Titel, Tags, Veröffentlichung, Skripte) bleibt erhalten.
Beide liefern Seiten-ID, Seitenpfad und Adresse der Seite; die zweite auch Seite erstellt.
Szenenbeispiele
- Heizungs-Journal: Wenn der Heizungsdruck unter 1 bar fällt → Zeile zu
einer Wiki.js-Seite hinzufügen, Pfad
journal/heizung, Zeile „Druck unter 1 bar“. - Wissen, was sich geändert hat: Auslöser Wiki.js-Seite erstellt oder
geändert, Ordner
anleitungen→ Nachricht senden „{{triggerEvent.data.updated_by}} hat {{triggerEvent.data.title}} geändert“. - Einkaufsliste im Wiki: Auslöser Wiki.js-Seite erstellt oder geändert,
Seitenpfad
haus/einkauf→ die Adresse der Seite an die Familie senden. - Urlaubsbericht: Wenn die Alarmanlage nach dem Urlaub ausgeschaltet wird →
Wiki.js-Seite erstellen unter
berichte/urlaub-2026, mit dem Tagbericht.
Fehlerbehebung
- „Wiki.js hat den API-Schlüssel nicht akzeptiert“: Der Schlüssel wurde widerrufen, ist abgelaufen oder falsch abgetippt, oder die API ist deaktiviert. Wiki.js antwortet dann wie einem nicht angemeldeten Besucher: Prüfe Administration → API Access.
- „Der API-Schlüssel darf diese Seite nicht schreiben“: Der Gruppe des Schlüssels fehlt das Schreibrecht auf diesen Pfad. Nutze einen Full Access-Schlüssel oder erweitere die Gruppe.
- „Wiki.js antwortet nicht“: Prüfe Adresse und Port vom Gladys-Rechner aus.
Der Container nutzt ein Bridge-Netzwerk:
localhostist der Container selbst, gib stattdessen die IP-Adresse des Servers ein. - „Diese Adresse antwortet nicht wie Wiki.js“: Eine Anmeldeseite eines Proxys antwortet statt Wiki.js, oder die Adresse enthält den Pfad einer Seite. Gib die Adresse der Startseite des Wikis ein.
- Die Version zeigt
?am Gerät: Der Schlüssel darf die Systeminformationen nicht lesen (nur ein Full Access-Schlüssel darf das). Sonst ändert sich nichts. - Für mehr Details in den Logs der Integration setze
LOG_LEVEL=debug.
Grenzen
- Ein Wiki.js, gesehen mit den Rechten seines API-Schlüssels.
- Die Auslöser feuern beim nächsten Lesen (standardmäßig 15 Minuten), nicht sofort: Wiki.js meldet nichts von sich aus. Gelöschte, verschobene oder nur kommentierte Seiten werden nicht gemeldet; eine zwischen zwei Lesevorgängen mehrmals gespeicherte Seite wird einmal gemeldet.
- Ein Lesevorgang ist eine Anfrage, die alle Seiten auflistet (einige hundert kB bei Tausenden von Seiten), plus eine pro gemeldeter Seite. Wiki.js setzt kein Anfragekontingent.
- Nicht veröffentlichte Seiten werden wie die anderen gezählt und gemeldet: Der Schlüssel sieht sie.
- Die Integration löscht oder verschiebt nie etwas in Wiki.js.
- Nicht mit Wiki.js oder Requarks verbunden.
Konfigurationseinstellungen
Diese Einstellungen fragt Wiki.js in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| Wiki.js verbinden | section | Nein | Gib die Adresse deines Wiki.js (Version 2) und einen API-Schlüssel ein: Öffne in Wiki.js Administration → API Access, aktiviere die API und erstelle einen Schlüssel. Ein „Full Access“-Schlüssel passt; ein Gruppenschlüssel muss Seiten lesen und, für die Szenenaktionen, schreiben dürfen. |
| Wiki.js-Adresse | string | Ja | Die Adresse, unter der du Wiki.js öffnest. |
| API-Schlüssel | secret | Ja | Wird nur einmal angezeigt, beim Erstellen des Schlüssels. |
| Wiki.js lesen alle | select | Nein | Geänderte Seiten werden beim nächsten Lesen gemeldet. |
| Sprache der Namen und Meldungen | select | Nein | Die Namen der Funktionen werden beim Hinzufügen eines Geräts zu Gladys festgelegt. |
So installierst du Wiki.js in Gladys
- Öffne in Gladys Integrationen: Wiki.js erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/guim31/gladys-wikijs:1.0.0) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration). - Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
- Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/guim31/gladys-wikijs.
Wiki.js benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.
Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.
Über externe Integrationen
Wiki.js ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von guim31 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.
- Alle Integrationen durchsuchen, native und aus der Community
- Deine eigene externe Integration bauen und veröffentlichen
- Quellcode auf GitHub — Quelle dieser Dokumentation