Wie man Wiki.js - NodeJS-basierte Wiki-Software auf Debian 9 installiert

Wiki.js ist eine Open-Source, moderne und leistungsstarke Wiki-App, die auf Node.js, Git und Markdown basiert. Wiki.js läuft auf der extrem schnellen Node.js-Engine und ist optimiert, um CPU-Ressourcen zu sparen. Einige der erwähnenswerten Funktionen von Wiki.js sind:

• Markdown-Bearbeitung, unterstützt von Git
• Leichtgewichtig, aber extrem leistungsstark
• Schön gestaltet für das moderne Web
• Integrierte Zugriffskontrolle
• Intuitive Verwaltung von Assets
• Eingebauter Suchmaschine

In diesem Tutorial führen wir Sie durch den Installationsprozess von Wiki.js Version 1 auf einem Debian 9-Betriebssystem, indem wir NGINX als Reverse-Proxy-Server, MongoDB als Datenbankserver, PM2 als Prozessmanager verwenden und optional können Sie die Transportebene mit dem acme.sh-Client und der Let’s Encrypt-Zertifizierungsstelle absichern, um SSL-Unterstützung hinzuzufügen.

Anforderungen

Die Anforderungen zum Ausführen von Wiki.js sind die folgenden:

• Node.js 6.11.1 bis 10.x ist erforderlich.
• MongoDB-Version 3.2 oder höher.
• Git-Version 2.7.4 oder höher.
• Webserver-Software wie NGINX, Apache, Caddy, H2O…
• Ein leeres Git-Repository (optional).
• Mindestens 512 MB RAM. 1 GB RAM empfohlen.
• Etwa 300 MB Speicherplatz.
• Domainname mit eingerichteten A/AAAA-DNS-Einträgen.

Voraussetzungen

• Ein Debian 9-Betriebssystem.
• Ein Nicht-Root-Benutzer mit sudo-Rechten.

Erste Schritte

Überprüfen Sie die Version Ihres Debian-Systems:

lsb_release -ds  
# Debian GNU/Linux 9.8 (stretch)

Richten Sie die Zeitzone ein:

dpkg-reconfigure tzdata

Aktualisieren Sie die Pakete Ihres Betriebssystems (Software). Dies ist ein wichtiger erster Schritt, da er sicherstellt, dass Sie die neuesten Updates und Sicherheitsfixes für die Standardsoftwarepakete Ihres Betriebssystems haben:

apt update && apt upgrade -y

Installieren Sie einige essentielle Pakete, die für die grundlegende Verwaltung des Debian-Betriebssystems erforderlich sind:

apt install -y curl wget vim git unzip socat sudo bash-completion apt-transport-https build-essential dirmngr

Schritt 1 - Node.js und npm installieren

Wiki.js basiert auf Node.js. Wir werden die zum Zeitpunkt des Schreibens empfohlene neueste Version für Wiki.js installieren, die Version 10 ist. Unter Linux haben Sie einige Installationsoptionen für Node.js: Linux-Binärdateien (x86/x64), Quellcode oder über Paketmanager. Wir werden eine Paketmanagement-Option verwenden, die die Installation und Aktualisierung von Node.js zum Kinderspiel macht.

Laden Sie die neueste empfohlene Version von Node.js aus dem NodeSource-Repository herunter und installieren Sie sie:

`curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -  
sudo apt install -y nodejs `

HINWEIS: npm wird mit Node.js verteilt - das bedeutet, dass Sie npm automatisch auf Ihrem System installiert haben, wenn Sie Node.js herunterladen.

Überprüfen Sie die Version von Node.js und npm:

`node -v && npm -v  
# v10.15.1  
# 6.4.1  
`

Npm ist ein separates Projekt von Node.js und wird tendenziell häufiger aktualisiert. Daher müssen Sie, selbst wenn Sie gerade Node.js (und damit npm) heruntergeladen haben, wahrscheinlich npm aktualisieren. Glücklicherweise weiß npm, wie man sich selbst aktualisiert! Um npm zu aktualisieren, geben Sie dies in Ihr Terminal ein:

sudo npm install -g npm@latest

Dieser Befehl aktualisiert npm auf die neueste stabile Version.

Überprüfen Sie die npm-Version erneut mit:

npm -v  
# 6.8.0  

Und es sollte die neueste Versionsnummer zurückgeben.

Schritt 2 - MongoDB-Datenbank installieren

Wiki.js benötigt eine Datenbank, um seine Daten zu speichern, und die aktuelle stabile Version von Wiki.js unterstützt nur die MongoDB-Datenbank-Engine. Daher müssen wir die MongoDB-Datenbank installieren.

Laden Sie die MongoDB-Datenbank herunter und installieren Sie sie:

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4  
echo "deb http://repo.mongodb.org/apt/debian stretch/mongodb-org/4.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list  
sudo apt-get update  
sudo apt-get install -y mongodb-org  

Überprüfen Sie die MongoDB-Version:

mongo --version | head -n 1 && mongod --version | head -n 1  

Starten und aktivieren Sie ( setzen Sie es so, dass es beim Neustart gestartet wird) den MongoDB-Dienst, falls er noch nicht gestartet und aktiviert ist:

sudo systemctl start mongod.service  
sudo systemctl enable mongod.service  

Schritt 3 - acme.sh-Client installieren und Let’s Encrypt-Zertifikat erhalten ( optional)

Die Sicherung Ihrer Website mit HTTPS ist nicht notwendig, aber es ist eine gute Praxis, den Datenverkehr Ihrer Website abzusichern. Um ein SSL-Zertifikat von Let’s Encrypt zu erhalten, verwenden wir den acme.sh-Client. Acme.sh ist eine reine UNIX-Shell-Software zum Abrufen von SSL-Zertifikaten von Let’s Encrypt mit null Abhängigkeiten.

Laden Sie acme.sh herunter und installieren Sie es:

sudo su - root  
git clone https://github.com/Neilpang/acme.sh.git  
cd acme.sh  
./acme.sh --install --accountemail [email protected]  
source ~/.bashrc  
cd ~

Überprüfen Sie die acme.sh-Version:

acme.sh --version  
# v2.8.1

Erhalten Sie RSA- und ECC/ECDSA-Zertifikate für Ihre Domain/Ihren Hostnamen:

# RSA 2048  
acme.sh --issue --standalone -d example.com --keylength 2048  
# ECDSA  
acme.sh --issue --standalone -d example.com --keylength ec-256

Wenn Sie gefälschte Zertifikate zu Testzwecken möchten, können Sie das --staging-Flag zu den obigen Befehlen hinzufügen.

Um Ihre ausgestellten Zertifikate aufzulisten, können Sie Folgendes ausführen:

acme.sh --list

Erstellen Sie Ordner, um Ihre Zertifikate zu speichern. Wir werden /etc/letsencrypt verwenden, aber es kann alles sein, was Sie bevorzugen, um SSL-Zertifikate zu speichern.

mkdir -p /etc/letsencrypt/example.com  
mkdir -p /etc/letsencrypt/example.com_ecc

Installieren/kopieren Sie Zertifikate in das Verzeichnis /etc/letsencrypt.

# RSA  
acme.sh --install-cert -d example.com \   
        --cert-file /etc/letsencrypt/example.com/cert.pem \  
        --key-file /etc/letsencrypt/example.com/private.key \  
        --fullchain-file /etc/letsencrypt/example.com/fullchain.pem \  
        --reloadcmd "sudo systemctl reload nginx.service"  
  
# ECC/ECDSA  
acme.sh --install-cert -d example.com --ecc \  
        --cert-file /etc/letsencrypt/example.com_ecc/cert.pem \  
        --key-file /etc/letsencrypt/example.com_ecc/private.key \  
        --fullchain-file /etc/letsencrypt/example.com_ecc/fullchain.pem \  
        --reloadcmd "sudo systemctl reload nginx.service"

Nach dem Ausführen der obigen Befehle befinden sich Ihre Zertifikate und Schlüssel in:

• Für RSA: /etc/letsencrypt /example.com-Verzeichnis.
• Für ECC/ECDSA: /etc/letsencrypt /example.com_ecc-Verzeichnis.

Alle Zertifikate werden alle 60 Tage automatisch erneuert.

Nachdem Sie die Zertifikate erhalten haben, melden Sie sich vom Root-Benutzer ab und kehren Sie zu Ihrem normalen Sudo-Benutzer zurück:

exit

Schritt 4 - NGINX installieren und konfigurieren

Wiki.js (oder jede HTTP Node.js-App) kann ohne einen tatsächlichen Webserver (wie NGINX oder Apache) betrieben werden. Es wird jedoch dringend empfohlen, einen Standard-Webserver vor Wiki.js zu setzen. Dies stellt sicher, dass Sie Funktionen wie SSL, mehrere Websites, Caching usw. nutzen können. Wir werden in diesem Tutorial NGINX verwenden, aber jeder andere Server funktioniert, Sie müssen ihn nur richtig konfigurieren.

Laden Sie NGINX aus dem offiziellen NGINX-Repository herunter und installieren Sie es, indem Sie die folgenden Befehle ausführen:

wget https://nginx.org/keys/nginx_signing.key  
sudo apt-key add nginx_signing.key  
rm nginx_signing.key  
sudo -s  
printf "deb https://nginx.org/packages/mainline/debian/ $(lsb_release -sc) nginx\ndeb-src https://nginx.org/packages/mainline/debian/ $(lsb_release -sc) nginx\n" >> /etc/apt/sources.list.d/nginx_mainline.list  
exit  
sudo apt update  
sudo apt install -y nginx

Überprüfen Sie die NGINX-Version:

sudo nginx -v  
# nginx version: nginx/1.15.8

Aktivieren und starten Sie den NGINX-Dienst:

sudo systemctl enable nginx.service  
sudo systemctl start nginx.service

Führen Sie sudo vim /etc/nginx/conf.d/wiki.js.conf aus und konfigurieren Sie NGINX als HTTPS-Reverse-Proxy.

server {
      
    listen [::]:443 ssl http2;  
    listen 443 ssl http2;
    listen [::]:80;
    listen 80;
    
    server_name example.com;

    charset utf-8;
    client_max_body_size 50M;  
    
    ssl_certificate /etc/letsencrypt/example.com/fullchain.pem;  
    ssl_certificate_key /etc/letsencrypt/example.com/private.key;  
    ssl_certificate /etc/letsencrypt/example.com_ecc/fullchain.pem;  
    ssl_certificate_key /etc/letsencrypt/example.com_ecc/private.key;
    
    location / {
        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_pass http://127.0.0.1:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_next_upstream error timeout http_502 http_503 http_504;
    }
    
}

Das einzige, was Sie in der obigen Konfiguration ändern müssen, ist die server_name-Direktive und möglicherweise die proxy_pass-Direktive, wenn Sie einen anderen als den Port 3000 konfigurieren möchten. Wiki.js verwendet standardmäßig den Port 3000.

Überprüfen Sie die NGINX-Konfiguration:

sudo nginx -t  

Schließlich müssen wir NGINX neu laden, damit die Änderungen wirksam werden:

sudo systemctl reload nginx.service

Schritt 5 - Wiki.js installieren und einrichten

Erstellen Sie ein Dokumentenstammverzeichnis, in dem Wiki.js untergebracht werden soll:

sudo mkdir -p /var/www/wiki.js

Navigieren Sie zum Dokumentenstammverzeichnis:

cd /var/www/wiki.js

Ändern Sie den Besitz des Verzeichnisses /var/www/wiki.js in Ihren Benutzer:

sudo chown -R [your_user]:[your_user] /var/www/wiki.js

HINWEIS: Ersetzen Sie your_user in dem obigen Befehl durch Ihren Nicht-Root-Benutzer, den Sie als Voraussetzung für dieses Tutorial erstellt haben. *.

Führen Sie aus dem Verzeichnis /var/www/wiki.js den folgenden Befehl aus, um die neueste Wiki.js-Anwendung abzurufen und zu installieren:

curl -sSo- https://wiki.js.org/install.sh | bash

Sobald die Installation abgeschlossen ist, können Sie den folgenden Befehl ausführen, um die aktuell installierte Version von Wiki.js anzuzeigen:

node wiki --version  
# 1.0.117

Sobald die Installation abgeschlossen ist, werden Sie aufgefordert, den Konfigurationsassistenten zu starten.

Starten Sie den Konfigurationsassistenten, indem Sie Folgendes ausführen:

node wiki configure

Navigieren Sie mit Ihrem Webbrowser zu http://example.com und folgen Sie den Anweisungen auf dem Bildschirm. Alle während des Konfigurationsassistenten eingegebenen Einstellungen werden in der Datei config.yml gespeichert. Der Konfigurationsassistent startet Wiki.js automatisch für Sie.

Zuerst sehen Sie eine Willkommensnachricht. Klicken Sie auf die Schaltfläche „ Start “:

Als nächstes erscheint die Seite „Systemcheck“. Wenn alle Anforderungen erfüllt sind, klicken Sie auf die Schaltfläche „ Weiter “.

Geben Sie allgemeine Informationen über Ihr Wiki ein und klicken Sie auf die Schaltfläche „ Weiter “:

Lesen Sie die Mitteilung „Wichtige Überlegungen“ und klicken Sie auf „ Weiter “ für den nächsten Schritt:

Verbinden Sie sich als Nächstes mit der Datenbank und fahren Sie fort:

Sie sollten eine Nachricht sehen, dass Wiki.js erfolgreich mit der Datenbank verbunden wurde. Klicken Sie auf die Schaltfläche „ Weiter “:

Setzen Sie die Pfade und fahren Sie fort:

Richten Sie ein Remote-Git-Repo ein, wenn Sie möchten, oder überspringen Sie diesen Schritt. Dieser Schritt ist optional, wird jedoch dringend empfohlen:

Klicken Sie als Nächstes auf die Schaltfläche „Weiter“:

Erstellen Sie ein Administratorkonto und klicken Sie auf die Schaltfläche „ Weiter “:

Und schließlich starten Sie Wiki.js:

Warten Sie etwa 30 Sekunden, und Sie sollten zur Wiki.js-Startseite weitergeleitet werden:

Die Installation ist abgeschlossen. Sie sollten die Willkommensseite von Wiki sehen:

Schritt 6 - PM2-Prozessmanager einrichten

Standardmäßig wird Wiki.js nach einem Systemneustart nicht automatisch gestartet. Um es beim Booten zu starten, müssen wir den PM2-Prozessmanager einrichten. PM2 wird als lokales npm-Modul mit Wiki.js gebündelt, sodass wir PM2 nicht global installieren müssen.

Sagen Sie PM2, dass es sich als Startdienst konfigurieren soll, indem Sie Folgendes ausführen:

/var/www/wiki.js/node_modules/pm2/bin/pm2 startup

Speichern Sie schließlich die aktuelle PM2-Konfiguration, indem Sie den Befehl ausführen:

/var/www/wiki.js/node_modules/pm2/bin/pm2 save

Ihr Wiki.js läuft jetzt als Hintergrundprozess, wobei PM2 als Prozessmanager verwendet wird.

Links

• https://wiki.js.org/
• https://github.com/Requarks/wiki-v1
• https://github.com/Requarks/wiki