Docker

Das nachfolgend beschriebene Docker-Setup gilt ausschließlich für UNIX-basierte Systeme. Wenn Sie auf einem Windows-Rechner arbeiten, konsultieren Sie bitte andere Anleitungen zur Einrichtung einer Docker-Umgebung und zum Ausführen von Docker-Images unter Windows.

Um einen benutzerdefinierten Docker-Container zu erstellen, laden Sie bitte die VC Publisher Linux-Installationsdatei herunter. In der ZIP-Datei sind das verwendete Dockerfile sowie das Startskript enthalten.

Systemvoraussetzungen

Bevor das VC Publisher-Image gestartet werden kann, muss Docker auf Ihrem System installiert sein.

Aktualisierung

Überspringen Sie diesen Schritt, wenn Sie den VC Publisher zum ersten Mal installieren!

Dieser Abschnitt richtet sich an Benutzer, die eine bestehende 5.3-Installation des VC Publishers auf Version 6 aktualisieren möchten.

  • Erstellen Sie ein Backup Ihrer Daten!: Sichern Sie die Datenbank und andere relevante Dateien, siehe Kapitel Datensicherung weiter unten.

  • Aktualisierung: Wenn Sie von einer Version älter als v5.3 aktualisieren möchten, kontaktieren Sie bitte <support@vc.systems>. Für alle Aktualisierungspfade erstellen Sie zuerst ein Backup Ihrer Daten und installieren Sie dann den neueren VC Publisher:

  1. Laden Sie das neueste Docker-Image des VC Publishers.

  2. Löschen Sie den alten Container wie im Abschnitt Deinstallation weiter unten beschrieben.

  3. Starten Sie das neue Docker-Image mit Verweisen auf die zuvor verwendeten Daten- und Datenbankordner, wie in Schritt 6 des Abschnitts Installation weiter unten beschrieben.

Installation

  1. Entpacken Sie die heruntergeladene ZIP-Datei von der Download-Seite.

  2. Image laden:

    docker load -i vcPUBLISHER.tar.gz

  3. Erstellen Sie für persistente Installationen lokale Datenordner für die internen Docker-Mountpunkte. Andernfalls werden die Daten nur im Container gespeichert. Der VC Publisher Docker-Container kann über drei Mountpunkte oder Volumes verfügen:

    1. /vcs/data: Hier werden die öffentlichen und privaten Ordner des VC Publishers angelegt, z. B. /home/user/data/

    2. /vcs/database: MongoDB-Datenbankdateien werden hier gespeichert, z. B. /home/user/database/

  4. Erstellen Sie eine Benutzer:Gruppe für den internen VC Publisher-Benutzer, mit dem der Container ausgeführt wird:

    sudo groupadd -g 1005 vcpublisher
sudo useradd -g 1005 -u 1005 vcpublisher

  5. Ändern Sie den Besitzer der erstellten Ordner auf diese Benutzer:Gruppe, um die Zugriffsberechtigungen für den internen VC Publisher-Benutzer zu setzen:

    sudo chown -R vcpublisher:vcpublisher /home/user/database
sudo chown -R vcpublisher:vcpublisher /home/user/data

  6. Starten Sie den Container mit folgendem Befehl:

    docker run --user 1005:1005 \
-e "ROOT_URL=http://localhost:3333" \
-e "VCS_INITIAL_USER=admin" \
-e "VCS_INITIAL_PASSWORD=admin123" \
--name publisher \
-p 3333:3000 \
-v /home/user/database:/vcs/database \
-v /home/user/data:/vcs/data \
publisher:$VERSION

    1. ROOT_URL: interne URL, unter der der VC Publisher erreichbar ist

    2. VCS_INITIAL_USER: initialer Benutzer für den VC Publisher

    3. VCS_INITIAL_PASSWORD: Passwort für den initialen Benutzer

    4. --name: Name des zu erstellenden Docker-Containers

    5. -p externalPort:3000: auf welchem externen Port der interne Docker-Port (3000, darf nicht geändert werden) abgebildet werden soll (hier Port 3333)

    6. -v local/folder/path/:/vcs/path/: auf welche lokalen Ordner die internen Docker-Pfade abgebildet werden sollen (interne VCS-Pfade sind /vcs/data/ und /vcs/database/, diese dürfen nicht umbenannt werden). /vcs/database/ wird nur benötigt, wenn die interne Datenbank verwendet wird und kein MONGO_URL angegeben ist.

    7. $VERSION: Version des verwendeten VC Publisher-Images (z. B. v6.0.0). Die Version des zu installierenden Docker-Images ist in der Dateibeschreibung zu finden (vcPUBLISHER-DockerImage-$VERSION-$BUILD.tar.gz).

  1. Um den Container auf Port 80 zu betreiben, verwenden Sie -p 80:3000 und ändern Sie den Port in ROOT_URL (“ROOT_URL=http://localhost:80”)

  2. Um den Container dauerhaft zu betreiben, fügen Sie --restart always hinzu, damit der Container beim Neustart des Servers automatisch neu startet

  3. Um eine externe MongoDB zu verwenden, nutzen Sie die Umgebungsvariable MONGO_URL. Wenn die Variable nicht gesetzt ist, startet der Container einen MongoDB-Prozess. Beispiel: -e "MONGO_URL=mongodb://mongodb:27017/publisher".

Eine detaillierte Liste aller Umgebungsvariablen finden Sie im Kapitel Umgebungsvariablen.

Datensicherung

  1. Stoppen Sie den VC Publisher-Container, z. B. mit dem Container-Namen "publisher":

    docker stop publisher

  2. Sichern Sie das Volume /vcs/database.

  3. Wenn Sie ein vollständiges Backup der VC Publisher-Daten wünschen, empfiehlt es sich, eine Sicherungskopie sowohl des public als auch des private Ordners im /vcs/data-Volume anzulegen.

Deinstallation

Um einen alten VC Publisher-Container zu löschen, führen Sie bitte die folgenden Schritte aus:

  1. Rufen Sie eine Liste der aktuell laufenden Docker-Container ab:

    docker ps -a

  2. Notieren Sie sich die Image-ID sowie den Container-Namen oder die Container-ID zur Löschung.

  3. Stoppen Sie den Container, z. B. für den Container mit dem Namen "publisher":

    docker stop publisher

  4. Der gestoppte Container kann nun gelöscht werden:

    docker rm publisher

  5. Optional können Sie auch das Image entfernen, z. B. für ein Image mit der ID "abc123":

    docker rmi abc123

Wenn Sie Ihren Container mit Volumes zur Datenpersistenz ausgeführt haben, werden die Daten durch das Entfernen des Containers nicht gelöscht. Wenn Sie eine vollständige Deinstallation durchführen möchten, stellen Sie sicher, dass Sie auch die lokalen Ordner löschen (siehe Schritt 3 der Installation).