Wie man Wiki.js auf Debian 12 installiert

Wiki.js ist eine kostenlose und Open-Source-Wiki-Software, die auf Node.js, Git und Markdown basiert. Sie wird unter der AGPL-v3-Lizenz veröffentlicht und ist für Leistung und Ressourcenschonung konzipiert. Wiki.js ist eine leistungsstarke Wiki-Software, die überall auf Ihrem System installiert werden kann. Sie können es auf Ihrem Betriebssystem installieren oder Cloud-Dienste wie Heroku nutzen und Wiki.js auch in Ihren Container-Umgebungen wie Docker und Kubernetes bereitstellen.

Wiki.js ist mit der PostgreSQL-Datenbank kompatibel und bietet über 50 Integrationen für zusätzliche Authentifizierung, Protokollierung, Suchmaschinen, Rendering und Speicherung. Es ist eine leistungsstarke Wiki-Software, die auf schönen und intuitiven Oberflächen sowohl für das Administrations-Dashboard als auch für die Seiten basiert. Es ist vollständig anpassbare Wiki-Software zur Dokumentation Ihres Tech-Stacks.

In diesem Artikel zeigen wir Ihnen, wie Sie Wiki.js auf einem Debian 12-System installieren. Wir führen Sie durch die Installation von Wiki.js, nutzen einen PostgreSQL-Datenbankserver, Nginx als Reverse-Proxy und sichern dann Ihre Wiki.js-Instanz mit SSL/TLS-Zertifikaten von Let’s Encrypt.

Voraussetzungen

Bevor Sie fortfahren, stellen Sie sicher, dass Sie haben:

• Einen Debian 12-Server.
• Einen Nicht-Root-Benutzer mit Administratorrechten.
• Einen Domainnamen, der auf die IP-Adresse Ihres Servers zeigt. In diesem Beispiel verwenden wir die Domain wiki.howtoforge.local.

Abhängigkeiten installieren

Im ersten Schritt installieren Sie einige der Abhängigkeiten, die von Wiki.js verwendet werden, darunter:

• PostgreSQL-Datenbankserver: Dies wird als Datenbank für Ihr Wiki.js verwendet.
• Nginx-Webserver: Der Nginx-Webserver wird als Reverse-Proxy für Wiki.js verwendet.
• Node.js und NPM: Die JavaScript-Laufzeitumgebung Node.js und der NPM-Paketmanager.
• Certbot und Nginx Certbot-Plugin: Certbot zum Generieren von SSL/TLS-Zertifikaten über Let’s Encrypt und das Nginx Certbot-Plugin, das automatisch Ihren Nginx-Serverblock mit HTTPS bestätigt.

Um zu beginnen, aktualisieren und aktualisieren Sie das Debian-Repository mit dem folgenden Befehl, bevor Sie Pakete installieren.

sudo apt update

Jetzt installieren Sie die Paketabhängigkeiten für Wiki.js über den folgenden apt install-Befehl. Mit dem folgenden Befehl installieren Sie den PostgreSQL-Datenbankserver, Node.js und NPM, den Nginx-Webserver, Certbot und das Certbot Nginx-Plugin.

sudo apt install postgresql postgresql-common nodejs npm nginx certbot python3-certbot-nginx

Geben Sie y ein, um zu bestätigen und mit der Installation fortzufahren.

Sobald die Abhängigkeiten installiert sind, überprüfen Sie jede von ihnen mit den folgenden Befehlen.

Überprüfen Sie den Status des PostgreSQL-Dienstes mit dem folgenden systemctl-Befehl.

sudo systemctl is-enabled postgresql  
sudo systemctl status postgresql

Eine ähnliche Ausgabe wird angezeigt.

Überprüfen Sie den Status des Nginx-Dienstes, um sicherzustellen, dass er läuft und aktiviert ist.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Wenn Nginx läuft und aktiviert ist, wird die folgende Ausgabe in Ihrem Terminal angezeigt.

Überprüfen Sie schließlich Node.js und NPM, indem Sie den folgenden Befehl ausführen. Die Ausgabe zeigt die aktuellen installierten Versionen von Node.js und NPM auf Ihrem System an.

node --version  
npm --version

Erstellen einer PostgreSQL-Datenbank und eines Benutzers

Nach der Installation der Abhängigkeiten besteht der nächste Schritt darin, eine neue Datenbank und einen Benutzer für Ihre Wiki.js-Installation zu erstellen. Dazu müssen Sie sich über den psql-Client bei PostgreSQL anmelden.

Melden Sie sich beim PostgreSQL-Server an, indem Sie den folgenden Befehl ausführen.

sudo -u postgres psql

Sobald Sie angemeldet sind, führen Sie die folgenden Abfragen aus, um eine neue PostgreSQL-Datenbank und den Benutzer wikijs zu erstellen. Stellen Sie sicher, dass Sie das Passwort in den folgenden Abfragen ändern.

CREATE USER wikijs WITH PASSWORD 'p4ssw0rd';  
CREATE DATABASE wikijs OWNER wikijs;

Nachdem die Datenbank und der Benutzer erstellt wurden, überprüfen Sie deren Existenz mit den folgenden Abfragen, um die verfügbaren Datenbanken und Benutzer in Ihrer PostgreSQL-Instanz aufzulisten.

du  

l

Sie sollten die Datenbank und den Benutzer wikijs in PostgreSQL sehen.

Geben Sie quit ein, um den PostgreSQL-Server zu verlassen.

Herunterladen des Wiki.js-Quellcodes

Im folgenden Abschnitt laden Sie den Wiki.js-Quellcode auf Ihren Server herunter und richten das Installationsverzeichnis mit den richtigen Berechtigungen und dem richtigen Eigentum ein.

Erstellen Sie einen neuen Benutzer wikijs, indem Sie den folgenden Befehl ausführen.

sudo useradd -m -s /bin/false wikijs

Erstellen Sie jetzt ein neues Verzeichnis /opt/wikijs und wechseln Sie in dieses Verzeichnis. Laden Sie dann den Wiki.js-Quellcode über den folgenden wget-Befehl herunter.

mkdir -p /opt/wikijs; cd /opt/wikijs  
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Sobald der Download abgeschlossen ist, extrahieren Sie den Wiki.js-Quellcode und ändern Sie den Eigentum des Verzeichnisses /opt/wikijs auf den Benutzer wikijs.

tar -xf wiki-js.tar.gz  
sudo chown -R wikijs:wikijs /opt/wikijs

Konfigurieren von Wiki.js

Nachdem Wiki.js heruntergeladen wurde, konfigurieren Sie Ihre Wiki.js-Installation mit der PostgreSQL-Datenbank und dem Benutzer, und Sie konfigurieren auch die Bind-IP-Adresse für Wiki.js.

Kopieren Sie die Standardkonfiguration von Wiki.js config.sample.yml nach config.yml und öffnen Sie sie mit dem folgenden Nano-Editor.

sudo -u wikijs cp config.sample.yml config.yml  
sudo -u wikijs nano config.yml

Ändern Sie die Standarddatenbankkonfiguration mit Ihrer PostgreSQL-Datenbank, Ihrem Benutzer und Ihrem Passwort.

  # PostgreSQL / MySQL / MariaDB / MS SQL Server nur:  
  host: localhost  
  port: 5432  
  user: wikijs  
  pass: p4ssw0rd  
  db: wikijs  
  ssl: false

Ändern Sie die Standardoption bindIP auf localhost oder 127.0.0.1. Dadurch wird Wiki.js auf dem localhost ausgeführt.

bindIP: 127.0.0.1

Speichern Sie die Datei und beenden Sie den Editor, wenn Sie fertig sind.

Führen Sie als Nächstes den folgenden Befehl aus, um Ihre Wiki.js-Installation zu starten und zu testen.

sudo -u wikijs node server

Sie sollten die Bestätigung sehen, dass Wiki.js auf localhost mit dem Standardport 3000 läuft.

Drücken Sie zuletzt Strg+c, um den Wiki.js-Prozess zu beenden.

Ausführen von Wiki.js im Hintergrund als Dienst

Nachdem Sie die Konfiguration von Wiki.js abgeschlossen haben, besteht der nächste Schritt darin, Wiki.js so einzurichten, dass es im Hintergrund als systemd-Dienst ausgeführt wird. Mit dem folgenden Ansatz können Sie Wiki.js einfach über das systemctl-Dienstprogramm verwalten.

Erstellen Sie eine neue systemd-Dienstdatei für Wiki.js /etc/systemd/system/wikijs.service mit dem folgenden Nano-Editor-Befehl.

sudo nano /etc/systemd/system/wikijs.service

Fügen Sie die folgende Konfiguration ein, die es Wiki.js ermöglicht, im Hintergrund als Dienst zu laufen.

[Unit]  
Description=Wiki.js  
After=network.target postgresql.service  
  
[Service]  
Type=simple  
ExecStart=/usr/bin/node server  
Restart=always  
  
User=wikijs  
Environment=NODE_ENV=production  
WorkingDirectory=/opt/wikijs  
  
[Install]  
WantedBy=multi-user.target

Speichern Sie die Datei und beenden Sie den Editor, wenn Sie fertig sind.

Führen Sie als Nächstes den systemctl-Befehl aus, um den systemd-Manager neu zu laden und die neue Dienstdatei für Wiki.js anzuwenden.

sudo systemctl daemon-reload

Sie können jetzt den Wiki.js-Dienst mit dem folgenden Befehl starten und aktivieren. Dadurch wird Wiki.js im Hintergrund auf localhost mit dem Standardport 3000 gestartet und es wird aktiviert, dass es beim Booten automatisch ausgeführt wird.

sudo systemctl start wikijs  
sudo systemctl enable wikijs

Überprüfen Sie den wikijs-Dienst mit dem folgenden Befehl, um sicherzustellen, dass der Dienst läuft.

sudo systemctl status wikijs

Eine Ausgabe sollte angezeigt werden.

Führen Sie zuletzt den ss-Befehl aus, um den Port 3000 zu überprüfen, der von der Wiki.js-Anwendung verwendet wird.

ss -tulpn | grep 3000

Wenn Wiki.js läuft, sollten Sie sehen, dass die Node.js-Anwendung den Port 3000 verwendet.

Konfigurieren von Nginx als Reverse-Proxy

Jetzt, da Wiki.js auf localhost mit dem Standardport 3000 läuft. Im nächsten Schritt erstellen Sie eine neue Nginx-Serverblockkonfiguration, die als Reverse-Proxy für Wiki.js verwendet wird. Stellen Sie vor dem Start sicher, dass Sie einen Domainnamen haben, der auf Ihre Server-IP-Adresse zeigt.

Erstellen Sie eine neue Nginx-Serverblockkonfiguration /etc/nginx/sites-available/wikijs mit dem folgenden Nano-Editor-Befehl.

sudo nano /etc/nginx/sites-available/wikijs

Fügen Sie die folgende Konfiguration ein und ändern Sie den Domainnamen Ihrer Wiki.js-Installation.

server {  
    listen 80;  
    server_name wiki.howtoforge.local;  
  
    root /opt/wikijs;  
  
    access_log  /var/log/nginx/wikijs.access.log;  
    error_log   /var/log/nginx/wikijs.error.log;  
  
    location / {  
        proxy_http_version 1.1;  
        proxy_set_header Upgrade $http_upgrade;  
        proxy_set_header Connection "upgrade";  
        proxy_set_header Host $http_host;  
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header X-Forwarded-Proto $scheme;  
        proxy_pass http://127.0.0.1:3000;  
    }  
}

Speichern Sie die Datei und beenden Sie den Editor, wenn Sie fertig sind.

Führen Sie als Nächstes den folgenden Befehl aus, um die Wiki.js-Serverblockkonfiguration zu aktivieren und die Nginx-Syntax zu überprüfen.

sudo ln -s /etc/nginx/sites-available/wikijs /etc/nginx/sites-enabled  
sudo nginx -t

Wenn Sie die richtige Nginx-Syntax haben, sollten Sie die Ausgabe Test erfolgreich - Syntax ist in Ordnung erhalten.

Starten Sie jetzt den Nginx-Dienst mit dem folgenden Befehl neu, um den neuen Serverblock anzuwenden, den Sie konfiguriert haben.

sudo systemctl restart nginx

Sobald Nginx neu gestartet wurde, öffnen Sie Ihren bevorzugten Webbrowser und besuchen Sie den Domainnamen Ihrer Wiki.js-Installation, z. B. http://wiki.howtoforge.local/. Wenn alles gut geht, sollten Sie die Installationsseite von Wiki.js wie folgt sehen:

Sichern von Wiki.js mit SSL/TLS-Zertifikaten

Im nächsten Schritt sichern Sie Ihre Wiki.js-Installation mit SSL/TLS-Zertifikaten von Letsencrypt. Außerdem richten Sie eine automatische HTTP-zu-HTTPS-Umleitung über das Certbot Nginx-Plugin ein.

Führen Sie den folgenden Certbot-Befehl aus, um neue SSL/TLS-Zertifikate von Letsencrypt zu generieren. Stellen Sie sicher, dass Sie die Details des Domainnamens und die E-Mail-Adresse mit Ihren Informationen ändern.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d wiki.howtoforge.local

Nachdem der Prozess abgeschlossen ist, sind Ihre SSL-Zertifikate im Verzeichnis /etc/letsencrypt/live/wiki.howtoforge.local/ verfügbar. Was die Wiki.js-Serverblockkonfiguration betrifft, wird sie automatisch über das Certbot Nginx-Plugin mit HTTPS konfiguriert.

Starten der Wiki.js-Installation

Gehen Sie zurück zu Ihrem Webbrowser und besuchen Sie Ihren Wiki.js-Domainnamen, z. B. http://wiki.howtoforge.local/. Sie sollten automatisch zu einer sicheren HTTPS-Verbindung umgeleitet werden.

Erstellen Sie jetzt den Administrationsbenutzer für Wiki.js und geben Sie Ihre E-Mail-Adresse und Ihr Passwort ein. Klicken Sie dann auf INSTALLIEREN, um die Installation zu bestätigen.

Sobald die Installation abgeschlossen ist, sollten Sie zur Anmeldeseite von Wiki.js umgeleitet werden. Geben Sie Ihre Admin-E-Mail-Adresse und Ihr Passwort ein und klicken Sie auf ANMELDEN.

Wenn Ihre Installation erfolgreich war, sollten Sie die Willkommensseite von Wiki.js sehen. Von hier aus können Sie eine neue Startseite erstellen oder auf das Administrations-Dashboard von Wiki.js zugreifen.

Wenn Sie auf ADMINISTRATION klicken, sollten Sie die Administrationsseite von Wiki.js wie folgt sehen:

Im Abschnitt SYSTEM klicken Sie im Menü Systeminfo, um detaillierte Informationen über Ihre Wiki.js-Installation zu erhalten. Unten sollten Sie sehen, dass Wiki.js 2.5 mit Node.js 18.x und PostgreSQL 15.x installiert ist.

Fazit

Das war’s! Sie haben alle Schritte befolgt und Wiki.js auf Ihrem Debian 12-System installiert, komplett mit einem PostgreSQL-Datenbankserver, Nginx als Reverse-Proxy und die Installation über SSL/TLS-Zertifikate von Let’s Encrypt gesichert. Sie können jetzt beginnen, die Dokumentation Ihres Unternehmens mit Wiki.js zu erstellen.