Kurzanleitung zum Einrichten Ihres eigenen Wikis mit Wiki.js in nur wenigen Minuten

Wiki.js ist eine funktionsreiche Open-Source-Wiki-Anwendung, die auf dem Node.js-Framework basiert. Sie bietet ein vielseitiges Bearbeitungserlebnis mit Unterstützung für Markdown- und WYSIWYG-Oberflächen. Darüber hinaus ermöglicht sie Echtzeit-Zusammenarbeit, Versionskontrolle und verschiedene Authentifizierungsmethoden, darunter Google- und LDAP-Integrationen. Diese umfassende Anleitung führt Sie durch die notwendigen Schritte zur Einrichtung von Wiki.js mit Docker, sodass Sie Ihr eigenes Wiki in nur wenigen Minuten bereitstellen können.

Einrichten von Wiki.js über Docker Compose

Der Einrichtungsprozess für Wiki.js mit Docker und Docker Compose ist unkompliziert. Erstellen Sie zunächst ein neues Verzeichnis mit dem Namen wikijs-dockerund navigieren Sie dorthin:

mkdir wikijs-docker && cd wikijs-docker

docker-compose.ymlErstellen Sie als Nächstes mit Ihrem bevorzugten Texteditor eine Datei mit dem Namen :

nano docker-compose.yml

Fügen Sie dann die folgende Konfiguration in die Datei ein:

services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:

Nachdem Sie die Datei gespeichert und geschlossen haben, starten Sie die Container, indem Sie den folgenden Befehl ausführen:

docker compose up -d

Sobald der Einrichtungsvorgang abgeschlossen ist, navigieren Sie in Ihrem Webbrowser zu http://localhost. Geben Sie hier die Administratordaten ein und klicken Sie auf die Schaltfläche „Installieren“, um die Installation zu starten:

Starten Sie die Installation von Wiki.js

Melden Sie sich nach Abschluss der Installation mit Ihren Anmeldeinformationen an.

Erstellen und Verwalten von Seiten in Wiki.js

Wenn die Ersteinrichtung abgeschlossen ist, können Sie Ihre Homepage einrichten, um mit der Eingabe Ihrer Inhalte zu beginnen, oder auf das Administrationspanel zugreifen, um Ihre Einstellungen, Benutzer und verfügbaren Funktionen zu verwalten:

Wenn Sie auf die Option „Startseite erstellen“ klicken, werden Sie aufgefordert, einen Editor auszuwählen, der Ihren Präferenzen entspricht:

Definieren Sie als Nächstes die Eigenschaften Ihrer Seite und klicken Sie auf die Schaltfläche „OK“, um mit der Erstellung einer neuen Seite fortzufahren:

Schreiben Sie den gewünschten Inhalt und klicken Sie auf die Schaltfläche „Erstellen“, um die Seitenerstellung abzuschließen:

Verwalten und Organisieren von Inhalten

Über Ihr Dashboard können Sie bequem vorhandene Seiten anzeigen und bearbeiten sowie mit Ihrem gewählten Editor neue Seiten erstellen. Sie können Ihre Inhalte organisieren, indem Sie Seiten umbenennen, verschieben oder löschen und Tags für eine effektive Kategorisierung verwenden. Die Seitenleiste und die Suchfunktion erleichtern zudem die Navigation zu bestimmten Seiten in Ihrem Wiki:

Konfigurieren der Wiki.js-Site-Einstellungen

Im Wiki.js-Administrationspanel können Sie Site-Einstellungen wie Gebietsschema, Navigationsstrukturen, Designs und Tags flexibel konfigurieren. Diese Einstellungen spielen eine entscheidende Rolle bei der Definition der Gesamtkonfiguration Ihrer Wiki.js-Instanz.

Auf der Registerkarte „Allgemein“ können Sie grundlegende Site-Einstellungen anpassen, darunter Site-Titel, Beschreibung, Standard-Homepage und Sichtbarkeitseinstellungen (öffentlich oder privat):

Wechseln Sie zur Registerkarte „Gebietsschema“, um die Standardsprache, Zeitzone und Datums-/Uhrzeitformate für Ihre Site anzugeben:

Um die Menüstruktur Ihres Wikis zu verwalten und die Benutzernavigation zu verbessern, besuchen Sie den Abschnitt Navigationsleiste :

Auf der Registerkarte „Seiten“ können Sie alle Wiki-Seiten überwachen, bearbeiten und organisieren, neue Seiten erstellen und die Hierarchie Ihrer Inhalte verwalten:

Darüber hinaus können Sie unter der Registerkarte „Tags“ Inhalts-Tags erstellen und verwalten und so die Seitensuche verbessern.Über die Registerkarte „Design“ können Sie außerdem die ästhetischen Elemente Ihres Wikis anpassen. Dort können Sie das Site-Logo, Farben, Schriftarten und Layoutstile ändern.

Verwalten von Gruppen in Ihrem Wiki

Im Bereich „Gruppen“ können Sie Benutzergruppen erstellen, Mitglieder benennen und Berechtigungen auf Gruppenebene festlegen, um den Zugriff zu regeln. Diese Organisationsmethode vereinfacht die Benutzerrollen und sorgt für eine konsistente Zugriffsverwaltung im gesamten Wiki.

Durch Klicken auf eine bestimmte Gruppe können Sie deren Einstellungen, Berechtigungen, Seitenregeln und Benutzerverwaltung innerhalb dieser Gruppe aktualisieren.Über die Registerkarte „Einstellungen“ können Sie Optionen anpassen, einschließlich der URL zur Anmeldeumleitung.

Sie können auch durch die Abschnitte „ Berechtigungen“, „Seitenregeln“ und „Benutzer“ navigieren, um den Zugriff der Gruppe zu verfeinern und Benutzer entsprechend zuzuweisen.

Benutzerverwaltung in Wiki.js

Um einen neuen Benutzer hinzuzufügen, gehen Sie zum Abschnitt „Benutzer“, klicken Sie auf die Schaltfläche „NEUER BENUTZER“ und füllen Sie die erforderlichen Felder aus.

Wählen Sie nach Abschluss ERSTELLEN oder ERSTELLEN UND SCHLIESSEN aus, um die Einrichtung des neuen Benutzers abzuschließen:

Wenn Sie einen bestimmten Benutzer auswählen, können Sie dessen Profil anzeigen und bearbeiten, Benutzergruppen zuweisen, Authentifizierungsmethoden (wie Passwörter oder Zwei-Faktor-Authentifizierung) definieren und seinen Status mit Aktionen wie Deaktivieren, Überprüfen oder Löschen verwalten :

Darüber hinaus können Sie ihre grundlegenden Informationen und erweiterten Metadaten (einschließlich Standort und Berufsbezeichnung) aktualisieren und ihren Aktivitätsverlauf anzeigen:

Verwalten Ihrer Wiki-Module

Module sind Erweiterungen, die die Funktionen von Wiki.js erweitern. Mit dem Analytics- Modul können Sie beispielsweise Tools wie Google Analytics integrieren, um Benutzerinteraktion und Traffic-Metriken zu verfolgen:

Verwenden Sie die Registerkarte „Authentifizierung“, um Authentifizierungsanbieter (lokale Anmeldung, LDAP, OAuth) einzurichten und zu verwalten und gleichzeitig verschiedene Anmeldeoptionen zu konfigurieren:

Konfigurieren der Authentifizierungseinstellungen

Sie können das Kommentarsystem auch ein- oder ausschalten und bestimmen, wie sich Benutzer an Seitendiskussionen beteiligen:

Systemkonfiguration

Verwalten Sie, wie Inhalte gerendert, für die Suche indexiert und gespeichert werden, indem Sie Rendering-Engines, Suchindexierung und Speichereinstellungen konfigurieren. Greifen Sie beispielsweise auf die Registerkarte „Rendering “ zu, um das Rendering von Inhalten anzupassen, z. B.durch Anpassen der Markdown-Engine-Einstellungen oder Aktivieren der Unterstützung für Diagramme und mathematische Ausdrücke:

Im Abschnitt „Suchmaschine“ können Sie interne Suchindexierungsoptionen und Suchmaschinenintegrationen von Drittanbietern verwalten:

Geben Sie im Abschnitt „Speicher“ Sicherungs- und Synchronisierungsziele für Ihre Inhalte an, sodass Sie verwalten können, wo und wie Medien- und Seitenanhänge gespeichert werden (z. B.im lokalen Dateisystem oder AWS S3):

Verwalten von Sicherheit und Konnektivität

Sie können Ihre Wiki.js-Instanz sichern, indem Sie den API-Zugriff konfigurieren, E-Mail-Benachrichtigungen einrichten, Sicherheitsrichtlinien anpassen und SSL für ein sicheres Erlebnis aktivieren. Verwenden Sie beispielsweise API-Token, um Wiki.js in andere Anwendungen zu integrieren:

Richten Sie E-Mail -Konfigurationen für die Verwaltung von Benachrichtigungen, Einladungen und Kennwortwiederherstellungsprozessen in Wiki.js ein:

Auch die Sicherheitseinstellungen können feinabgestimmt werden und Aspekte wie Sitzungs-Timeouts, Kennwortrichtlinien und Zugriffsbeschränkungen abdecken:

Darüber hinaus können Sie SSL/TLS -Zertifikate einrichten, um sicherzustellen, dass Ihre Wiki.js-Instanz sicher über HTTPS funktioniert:

Überprüfen Sie außerdem Ihre Wiki-Informationen wie Systemdiagnose, Serverspezifikationen und Statistiken zur Laufzeitumgebung im Abschnitt „Systeminformationen“ :

Führen Sie Wartungsaktivitäten wie die Neuindizierung von Suchergebnissen, das Löschen zwischengespeicherter Daten oder das Zurücksetzen von Konfigurationen über die Registerkarte „ Dienstprogramme“ durch:

Schließlich bieten die Entwicklertools erweiterte Ressourcen wie GraphQL-Spielplatz, Protokoll-Debugging-Funktionen oder benutzerdefinierte Skriptintegrationen:

Da Sie nun über das Wissen verfügen, Wiki.js mit Docker einzurichten, können Sie diese Plattform sicher nutzen, um mühelos interne Dokumentationen, kollaborative Team-Wikis oder öffentliche Wissensdatenbanken zu erstellen.

Quelle & Bilder