Wie man Wiki.js einrichtet und in wenigen Minuten sein eigenes Wiki hat

Wiki.js ist eine leistungsstarke Open-Source-Wiki-Plattform, die auf Node.js basiert. Sie unterstützt sowohl Markdown- als auch WYSIWYG-Bearbeitung, Echtzeit-Zusammenarbeit, Versionskontrolle und flexible Authentifizierungsoptionen, einschließlich Google und LDAP. In diesem Leitfaden zeigen wir Ihnen, wie Sie Wiki.js mit Docker einrichten können, sodass Sie Ihr Wiki in nur wenigen Minuten betriebsbereit haben.

Installieren von Wiki.js mit Docker Compose

Mit Docker und Docker Compose ist es unglaublich einfach, Wiki.js einzurichten. Zuerst erstellen Sie ein Verzeichnis mit dem Namen „wikijs-docker“ und wechseln mit dem Befehl cd hinein:

mkdir wikijs-docker && cd wikijs-docker

Anschließend erstellen Sie eine Datei „docker-compose.yml“ in einem Texteditor:

nano docker-compose.yml

Fügen Sie dann den folgenden Inhalt in diese 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:

Speichern Sie die Datei und schließen Sie sie, und starten Sie dann die Container mit dem folgenden Befehl:

docker compose up -d

Sobald die Einrichtung abgeschlossen ist, öffnen Sie Wiki.js in Ihrem Browser unter http://localhost. Geben Sie die Anmeldedaten für das Administratorkonto ein und klicken Sie auf die Schaltfläche Installieren, um die Installation zu starten:

Nach der Installation geben Sie Ihre Anmeldedaten ein, um sich anzumelden.

Erstellen und Verwalten von Seiten in Wiki.js

Jetzt können Sie die Startseite erstellen, um Inhalte hinzuzufügen oder auf das Administrationspanel zuzugreifen, um Einstellungen, Benutzer und Funktionen zu verwalten:

Wenn Sie auf die Schaltfläche Startseite erstellen klicken, werden Sie aufgefordert, einen Editor für die Seite auszuwählen. Wählen Sie den nach Ihren Vorlieben und Anforderungen aus:

Geben Sie die Seiteneigenschaften an und klicken Sie auf die Schaltfläche OK, um eine neue Seite zu erstellen:

Schreiben Sie, was Sie möchten, und klicken Sie auf die Schaltfläche Erstellen, um die Seite zu erstellen:

Inhalte verwalten und organisieren

Auf dem Dashboard können Sie vorhandene Seiten anzeigen und bearbeiten, neue Seiten mit Ihrem bevorzugten Editor erstellen und Ihre Inhalte organisieren, indem Sie Seiten verschieben, umbenennen oder löschen. Sie können auch Tags hinzufügen, um Inhalte effektiv zu kategorisieren. Darüber hinaus erleichtern die Seitenleiste und die Suchleiste die schnelle Navigation zu bestimmten Seiten innerhalb Ihres Wikis:

Einstellungen für die Wiki.js-Website

Im Administrationspanel von Wiki.js können Sie die Website-Einstellungen wie Lokalisierung, Navigation, Themen und Tags konfigurieren. Diese Optionen helfen, die globale Konfiguration Ihrer Wiki.js-Instanz zu definieren.

Sie können grundlegende sitzungsweite Einstellungen im Tab Allgemein konfigurieren, wie z.B. den Seitentitel, die Beschreibung, die Standard-Startseite und die Sichtbarkeit der Seite (öffentlich oder privat):

Navigieren Sie zum Tab Lokalisierung, um die Standardsprache, die Zeitzone und die Datums-/Uhrzeitformate, die auf der gesamten Website verwendet werden, festzulegen:

Um die Struktur der Menüs Ihrer Wiki zu verwalten und zu steuern, wie Benutzer auf Inhalte zugreifen, gehen Sie zur Navigationsleiste.

Im Tab Seiten können Sie alle Wiki-Seiten anzeigen, verwalten und organisieren. Sie können neue Seiten erstellen, vorhandene bearbeiten oder die Seitenhierarchie verwalten.

Sie können auch Inhalte in Tags im Tab Tags kategorisieren, um die Suche zu verbessern. Ebenso können Sie das Aussehen und Gefühl Ihres Wikis im Tab Thema ändern. Zum Beispiel können Sie das Seitenlogo, Farben, Schriftarten und Layout-Themen ändern.

Gruppen in Ihrem Wiki verwalten

Im Bereich Gruppen können Sie Benutzergruppen erstellen, Mitglieder zuweisen und Berechtigungen auf Gruppenebene festlegen, um den Zugriff zu steuern. Verwenden Sie Gruppen, um Benutzer nach Rolle zu organisieren und ihren Zugriff konsistent über Ihr Wiki zu verwalten.

Sie können auf eine bestimmte Gruppe klicken, um deren Einstellungen, Berechtigungen, Seitenregeln zu aktualisieren und Benutzer innerhalb dieser Gruppe zu verwalten. Der Tab Einstellungen ermöglicht es Ihnen, Optionen wie die Umleitungs-URL nach dem Login zu konfigurieren.

Darüber hinaus können Sie durch die Tabs Berechtigungen, Seitenregeln und Benutzer navigieren, um zu steuern, auf was die Gruppe zugreifen kann und welche Benutzer ihr zugewiesen sind.

Benutzerverwaltung in Wiki.js

Um einen neuen Benutzer zu erstellen, gehen Sie zum Abschnitt Benutzer, klicken Sie auf die Schaltfläche NEUER BENUTZER und geben Sie die erforderlichen Daten an.

Danach klicken Sie auf die Schaltfläche ERSTELLEN oder ERSTELLEN UND SCHLIESSEN, um einen neuen Benutzer zu erstellen:

Klicken Sie auf einen bestimmten Benutzer, um dessen Profil anzuzeigen und zu bearbeiten, ihn Benutzergruppen zuzuweisen, Authentifizierungsmethoden wie Passwörter und Zwei-Faktor-Authentifizierung festzulegen und seinen Status mit Aktionen wie Deaktivieren, Überprüfen oder Löschen zu verwalten:

Sie können auch seine grundlegenden Informationen, erweiterten Metadaten (wie Standort und Berufsbezeichnung) aktualisieren und seine Aktivitätsgeschichte überwachen:

Verwalten Sie Ihre Wiki-Module

Module sind optionale Funktionen, die die Funktionalität von Wiki.js erweitern. Beispielsweise ermöglicht das Analytics-Modul, Integrationen wie Google Analytics zu aktivieren und zu konfigurieren, um das Nutzerverhalten und den Datenverkehr auf Ihrem Wiki zu verfolgen.

Verwenden Sie den Tab Authentifizierung, um Authentifizierungsanbieter (wie lokale Anmeldung, LDAP, OAuth) einzurichten und Anmeldeoptionen zu konfigurieren.

Sie können das Kommentarsystem aktivieren oder deaktivieren und wählen, wie Benutzer mit Seiten-Diskussionen interagieren.

Systemkonfiguration

Sie können auch verwalten, wie Inhalte gerendert, durchsucht und gespeichert werden, indem Sie Rendering-Engines, Suchindizes und Speicheroptionen konfigurieren. Beispielsweise können Sie zum Tab Rendering navigieren, um zu personalisieren, wie Inhalte gerendert werden, wie z.B. Einstellungen für die Markdown-Engine oder Unterstützung für Diagramme, mathematische Ausdrücke usw.

Im Abschnitt Suchmaschine können Sie interne Suchindexierungsoptionen und Integrationen mit Suchmaschinen konfigurieren:

Gehen Sie zum Abschnitt Speicher, um Backup- und Synchronisationsziele für Ihre Inhalte festzulegen. Hier können Sie verwalten, wo und wie Medien und Seitenanhänge gespeichert werden (lokales Dateisystem, AWS S3 usw.):

Sicherheit & Konnektivität verwalten

Sie können Sicherheit und Konnektivität verwalten, indem Sie API-Zugriff konfigurieren, E-Mail für Benachrichtigungen einrichten, Sicherheitsrichtlinien anpassen und SSL aktivieren, um Ihre Wiki.js-Website zu sichern. Beispielsweise können Sie API-Token verwalten, um Wiki.js mit externen Systemen oder Ihren eigenen benutzerdefinierten Anwendungen zu integrieren:

Wir können die E-Mail-Einstellungen für Benachrichtigungen, Einladungen und Passwortwiederherstellung in Wiki.js einrichten.

Sie können Sicherheits-Einstellungen wie Sitzungszeitüberschreitungen, Passwortrichtlinien und Zugriffsrestriktionen konfigurieren.

Darüber hinaus können Sie SSL/TLS-Zertifikate einrichten, um Ihre Wiki.js-Website mit HTTPS zu sichern.

Darüber hinaus können Sie Informationen zu Ihrem Wiki bestätigen, wie z.B. Systemdiagnosen, Serverdetails und Statistiken zur Laufzeitumgebung im Abschnitt Systeminfo einsehen.

Sie können Wartungsaktionen durchführen, wie z.B. die Indizierung der Suche neu durchzuführen, Cache zu leeren oder Konfigurationen aus dem Tab Dienstprogramme zurückzusetzen.

Schließlich können Sie mit den Entwicklungstools auf erweiterte Tools wie den GraphQL Playground, Debug-Logs oder benutzerdefinierte Skripte zugreifen:

Jetzt, wo Sie gelernt haben, wie man Wiki.js mit Docker einrichtet, können Sie es verwenden, um interne Dokumentationen, Team-Wikis oder sogar öffentliche Wissensdatenbanken ganz einfach zu erstellen. Wenn Sie Ihre Optionen immer noch abwägen, sehen Sie sich unseren Vergleich von DokuWiki vs. Wiki.js an, um herauszufinden, welche Plattform am besten für Ihr Projekt geeignet ist.