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

Wiki.js ist eine vielseitige Open-Source-Wiki-Plattform, die mit Docker schnell eingerichtet werden kann. Der Leitfaden erklärt die Installation, Seitenverwaltung und Benutzerrechte effizient.

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, damit Sie Ihr Wiki in nur wenigen Minuten zum Laufen bringen können.

Installation von Wiki.js mit Docker Compose

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

mkdir wikijs-docker && cd wikijs-docker

Erstellen Sie anschließend 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 und schließen Sie die Datei, 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 mit der Installation zu beginnen:

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

Seiten in Wiki.js erstellen und verwalten

Jetzt können Sie die Startseite erstellen, um Inhalte hinzuzufügen, oder auf das Administrationspanel zugreifen, 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 basierend auf Ihren Vorlieben und Anforderungen:

Geben Sie die Seitenattribute 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

Im Dashboard können Sie vorhandene Seiten anzeigen und bearbeiten, neue Seiten mit Ihrem bevorzugten Editor erstellen und Ihre Inhalte durch Verschieben, Umbenennen oder Löschen von Seiten organisieren. 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 in Ihrem Wiki:

Einstellungen der Wiki.js-Website

Im Administrationspanel von Wiki.js können Sie die Einstellungen der Seite wie Gebietsschema, Navigation, Themes und Tags konfigurieren. Diese Optionen helfen dabei, die globale Konfiguration Ihrer Wiki.js-Instanz zu definieren.

Sie können grundlegende, standortübergreifende Einstellungen im Tab Allgemein konfigurieren, wie den Seitentitel, die Beschreibung, die Standardstartseite und die Sichtbarkeit der Seite (öffentlich oder privat):

Wechseln Sie zum Tab Gebietsschema, um die Standardsprache, die Zeitzone und die Datums-/Uhrzeitformate für die gesamte Website festzulegen:

Um die Struktur der Menüs Ihres Wikis zu verwalten und zu steuern, wie Benutzer Inhalte durchsuchen, 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 unter dem Tab Tags verwalten, um Seiten zu kategorisieren und die Suchbarkeit zu verbessern. Ähnlich können Sie das Aussehen und das Gefühl Ihres Wikis im Tab Theme anpassen. Beispielsweise können Sie das Logo, die Farben, Schriftarten und Layouts der Site ändern.

Gruppen in Ihrem Wiki verwalten

Im Abschnitt 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 deren Zugriff konsistent in Ihrem 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 Einstellungen-Tab ermöglicht es Ihnen, Optionen wie die Weiterleitungs-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.

Benutzermanagement in Wiki.js

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

Danach klicken Sie auf die Schaltfläche ERSTELLEN oder ERSTELLEN UND SCHLIEßEN, 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 sowie seinen Status mit Aktionen wie Deaktivieren, Überprüfen oder Löschen zu verwalten:

Sie können auch seine grundlegenden Informationen, erweiterte Metadaten (wie Standort und Jobtitel) aktualisieren und seinen Aktivitätsverlauf überwachen:

Verwalten Sie Ihre Wiki-Module

Module sind optionale Funktionen, die die Funktionalität von Wiki.js erweitern. Zum Beispiel ermöglicht das Analytics-Modul die Aktivierung und Konfiguration von Integrationen wie Google Analytics, um das Nutzerverhalten und den Verkehr auf Ihrem Wiki zu verfolgen.

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

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

Systemkonfiguration

Sie können auch verwalten, wie Inhalte gerendert, durchsucht und gespeichert werden, indem Sie Render-Engines, Suchindexierung und Speichermöglichkeiten konfigurieren. Zum Beispiel können Sie zum Rendering-Tab navigieren, um anzupassen, wie Inhalte gerendert werden, wie z.B. Markdown-Engine-Einstellungen oder Unterstützung für Diagramme, mathematische Ausdrücke usw.

Im Suchmaschine-Bereich können Sie die internen Suchindexierungsoptionen und Integrationen mit Suchmaschinen konfigurieren:

Gehen Sie zum Speicher-Bereich, 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 und Konnektivität verwalten

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

Wir können ausgehende E-Mail-Einstellungen einrichten, um Benachrichtigungen, Einladungen und Passwortwiederherstellungen in Wiki.js zu verwalten.

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

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

Außerdem können Sie Ihre Wiki-Informationen bestätigen, wie z.B. Systemdiagnosen, Serverdetails und Runtime-Umgebungsstatistiken im Systeminfo-Bereich.

Sie können Wartungsaktionen wie das Neuindizieren der Suche, das Löschen von Caches oder das Zurücksetzen von Konfigurationen über den Tools-Tab durchführen.

Schließlich ermöglichen die Entwicklerwerkzeuge den Zugriff auf erweiterte Tools wie GraphQL-Playground, Debugging-Protokolle oder benutzerdefinierte Skripte:

Jetzt, da Sie gelernt haben, wie Sie Wiki.js mit Docker einrichten, können Sie es verwenden, um interne Dokumentationen, Teamwikis oder sogar öffentliche Wissensdatenbanken mühelos zu erstellen. Wenn Sie noch Ihre Optionen abwägen, werfen Sie einen Blick auf unseren Vergleich zwischen DokuWiki und Wiki.js, um zu sehen, welche Plattform am besten zu Ihrem Projekt passt.