TLDR

Soße: https://github.com/mbround18/wikijs-module-meilisearch

Die Software

Was ist Meilisearch?

Meilisearch ist eine Open-Source-Suchmaschine, die auf Geschwindigkeit und Einfachheit ausgelegt ist. Es ist in Rust geschrieben und darauf ausgelegt, schnelle, relevante Suchergebnisse mit minimaler Konfiguration zu liefern. Meilisearch zeichnet sich durch Volltextsuche aus und ist selbst bei großen Datensätzen auf Leistung optimiert. Es unterstützt Funktionen wie Tippfehlertoleranz und anpassbares Relevanzranking direkt nach dem Auspacken.

Link zu Meilisearch

Was ist WikiJS?

Wiki.js ist eine moderne Open-Source-Wiki-Software, die eine leistungsstarke und flexible Plattform zum Verwalten und Teilen von Inhalten bietet. Es basiert auf Node.js und ist so konzipiert, dass es leichtgewichtig, schnell und benutzerfreundlich ist, mit einer eleganten und intuitiven Benutzeroberfläche, die es für Benutzer aller Erfahrungsstufen zugänglich macht.

Link zu Wikijs

Wie man beides integriert

Voraussetzungen

• Instanz von Meilisearch wird ausgeführt
• Instanz von Wikijs wird ausgeführt

Wenn Sie diese nicht haben, können Sie dieses Docker Compose verwenden.

Mit dem Docker Compose

1. Laden Sie den Docker Compose in ein Verzeichnis herunter.
2. Erstellen Sie einen Ordner namens pkg
3. Erstellen Sie einen Ordner namens tmp
4. Erstellen Sie einen Ordner namens config.
5. Laden Sie im Konfigurationsordner für diese Demo diese Konfiguration herunter
6. Führen Sie Docker Compose Up aus, damit es die Dateien nach Bedarf generiert.

Installation des Moduls

1. Navigieren Sie zu dem Modul, das sie auf github.com/mbround18/wikijs-module-meilisearch integriert
2. Navigieren Sie zur Registerkarte „Releases“
3. Laden Sie bei der neuesten Version die Datei Meilisearch.zip herunter.
4. Extrahieren Sie die ZIP-Datei nach /wiki/server/modules/search/meilisearch auf Ihrem Wikijs-Server. Wenn Sie Compose verwenden, laden Sie Docker Compose herunter und extrahieren Sie die ZIP-Datei in Ihren ./pkg-Ordner.
5. Starten Sie Ihren Wikijs-Server neu.

Einrichten des Moduls.

Für eine Produktionsinstanz wird empfohlen, meilisearch einen neuen Schlüssel generieren zu lassen, den Ihre App verwenden kann. Sie können dies über diesen Curl-Befehl tun:

curl --request POST \
  --url http://localhost:7700/keys \
  --header 'Authorization: Bearer demo' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Wikijs Integration",
    "actions": ["*"],
    "indexes": ["wiki_index"],
    "expiresAt": "2042-04-02T00:42:42Z"
}'

Ändern Sie das Wort Demo in Ihren Hauptschlüssel. Wenn Sie Docker Compose verwenden, funktioniert dies nur mit der Demo. Es sei denn, Sie haben es in der Compose-Datei geändert. Verwenden Sie dann das, was Sie für $MEILI_MASTER_KEY festgelegt haben.

1. Melden Sie sich bei Ihrer Wikijs-Instanz an. Zum Verfassen einer Demo müssen Sie möglicherweise den ersten Login erstellen. Denken Sie daran, die URL auf dem Ersteinrichtungsbildschirm auf http://localhost:3000 festzulegen.
2. Navigieren Sie zum Admin-Dashboard.
3. Klicken Sie auf Suchmaschine
4. Meilisearch aktivieren
5. Passen Sie den API-Schlüssel und den Host nach Bedarf an.
6. Klicken Sie auf „Übernehmen“. Wenn Sie keine grüne Toastnachricht erhalten, klicken Sie einfach erneut auf „Übernehmen“. Dies kann passieren, weil die Aufgabe in Meilisearch beim Erstellen des Index blockiert.

Was ist nun die Einrichtung?

Jetzt können Sie Meilisearch verwenden, um Ihr Wiki zu durchsuchen! Wenn Sie über vorhandenen Inhalt verfügen, können Sie auf „Neu erstellen“ klicken. Dadurch sollten alle Ihre Inhalte zu meilisearch hinzugefügt werden! :)

Da Sie Wikijs normalerweise verwenden, werden im Rahmen der normalen Seitendarstellung Dokumente in Meilisearch erstellt, aktualisiert und gelöscht.

Wenn Sie ein Live-Beispiel davon sehen möchten, haben wir es in meinem Dungeons and Dragons-Wiki bereits integriert. Es war erstaunlich, Charakterdaten oder Szenendaten im Handumdrehen abrufen zu können.

Hinweis zur Implementierung, derzeit stimmen die Vorschläge mit den Who-Zeilen überein. In Zukunft werde ich dieses Segment umschreiben, um es zu kürzen und kleinere Vorschläge zu haben.