Wiki.js mit Docker Compose installieren

Einleitung

Dieses Tutorial beschreibt, wie Sie Wiki.js mithilfe von Docker Compose installieren können. Nach erfolgreicher Installation verfügen Sie über eine voll funktionsfähige Wiki.js-Instanz, die in einem Docker-Container läuft.

Für dieses Tutorial wird der Beispiel-Hostname v11111111.quicksrv.de verwendet. Dieser Hostname muss durch den Namen Ihres eigenen Servers ersetzt werden, wenn Sie den in diesem Tutorial beschriebenen Workflow durchführen.

Voraussetzungen

• Linux-Server mit installiertem Docker
• Grundkenntnisse in Shell-Befehlen.

Der einfachste VPS von netcup erfüllt diese Anforderungen.

Schritt 1 - Docker Compose installieren

Wenn Sie Docker und Docker Compose noch nicht auf Ihrem Server installiert haben, verwenden Sie die folgenden Befehle:

## Docker Compose installieren
apt install docker-compose

Schritt 2 - Erstellen Sie eine Docker Compose-Datei für Wiki.js

Erstellen Sie ein neues Verzeichnis für Ihre Wiki.js-Installation und wechseln Sie in das Verzeichnis:

mkdir wikijs && cd wikijs

Erstellen Sie jetzt eine docker-compose.yml Datei mit Ihrem bevorzugten Texteditor (z.B. nano):

nano docker-compose.yml

Fügen Sie den folgenden Text in die Datei ein:

version: '3'
services:
  db:
    image: postgres:11-alpine
    environment:
      POSTGRES_DB: wiki
      POSTGRES_USER: wikijs
      POSTGRES_PASSWORD: wikijsrocks
    volumes:
      - db-data:/var/lib/postgresql/data
  wiki:
    image: 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
    ports:
      - "80:3000"
volumes:
  db-data:

In dieser Konfiguration ist folgendes enthalten:

• Wir leiten den Port 3000 innerhalb des Wiki-Containers zum Port 80 auf dem Host um, sodass unsere Wiki.js-Instanz unter http://v11111111.quicksrv.de erreichbar ist.
• environment: Liste von Umgebungsvariablen, die im Container gesetzt sind.
• POSTGRES_DB: Name der zu erstellenden Datenbank.
• POSTGRES_USER: Benutzername für die Datenbank.
• POSTGRES_PASSWORD: Passwort für den Datenbankbenutzer.
• Hinweis: Sie sollten das Passwort wikijsrocks durch ein sicheres Passwort Ihrer Wahl ersetzen.
• DB_TYPE: Typ der Datenbank, hier postgres.
• DB_HOST: Hostname der Datenbank. Da die Datenbank im selben Docker-Netzwerk ist, verwenden wir den Dienstnamen db.
• DB_PORT: Port der Datenbank, standardmäßig 5432 für PostgreSQL.
• DB_USER und DB_PASS: Anmeldedaten für den Zugriff auf die Datenbank. Diese sollten den Umgebungsvariablen des db-Dienstes entsprechen.
• DB_NAME: Name der zu verwendenden Datenbank.
• ports: Bestimmt, welche Ports vom Host zum Container weitergeleitet werden.
  • 80:3000: Leitet den Port 80 des Hosts an den Port 3000 im Container weiter.

Wenn Sie diese Docker Compose-Datei verwenden, sollten Sie zumindest das Datenbankpasswort durch ein sicheres Passwort Ihrer Wahl ersetzen. Alle anderen Konfigurationen können je nach Ihren Anforderungen und Ihrer Infrastruktur angepasst werden.

Schritt 3 - Starten Sie den Wiki.js-Container

Führen Sie nun den folgenden Befehl aus, um Wiki.js und den dazugehörigen Datenbank-Container zu starten:

docker-compose up -d

Dieser Befehl lädt die notwendigen Images herunter und startet die Container im Hintergrundmodus.

Schritt 4 - Zugriff auf die Wiki.js-Installation

Sobald die Container laufen, öffnen Sie Ihren Webbrowser und navigieren Sie zur Adresse Ihres Servers, z.B. http://v11111111.quicksrv.de. Sie sollten nun den Setup-Assistenten von Wiki.js sehen. Befolgen Sie die Anweisungen auf dem Bildschirm, um die Installation abzuschließen.

Fazit

Herzlichen Glückwunsch! Sie haben Wiki.js erfolgreich mit Docker Compose installiert. Sie können nun Ihre Dokumentation oder Wissensdatenbank ganz mühelos erstellen und organisieren. Denken Sie aber daran, Ihre Daten regelmäßig zu sichern und Ihre Software aus Sicherheitsgründen aktuell zu halten.

License

MIT

Copyright (c) 2021 netcup

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributor's Certificate of Origin

By making a contribution to this project, I certify that:

1. The contribution was created in whole or in part by me and I have the right to submit it under the license indicated in the file; or

2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same license (unless I am permitted to submit under a different license), as indicated in the file; or

3. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

4. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the license(s) involved.