IRIS Installation (Docker): Unterschied zwischen den Versionen

Aus Wiki - Heidler Strichcode GmbH
Zur Navigation springen Zur Suche springen
(+ IRIS Installation (Docker))
 
 
(18 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
=== Hinweise ===
+
[[en:IRIS installation (Docker)]]
 +
== Hinweise ==
  
−
==== IRIS Version ====
+
=== IRIS Version ===
−
Im folgenden Text finden Sie viele Befehle, die die aktuelle Version von IRIS enthalten.
+
Im folgenden Text finden Sie viele Befehle, die die aktuelle Version von [[IRIS Cloudsystem|IRIS]] enthalten.
  
 
Bitte ersetzen Sie die Version durch die jeweils verfügbare aktuellste Version von IRIS.
 
Bitte ersetzen Sie die Version durch die jeweils verfügbare aktuellste Version von IRIS.
Zeile 10: Zeile 11:
 
  docker load -i iris-1.X.X.tar.gz
 
  docker load -i iris-1.X.X.tar.gz
 
zu
 
zu
−
  docker load -i iris-1.0.8.tar.gz
+
  docker load -i iris-1.0.18.tar.gz
 
bzw. die jeweils aktuellste Version
 
bzw. die jeweils aktuellste Version
  
−
==== Docker auf Linux ====
+
=== Docker auf Linux ===
 
Diese Beschreibung nimmt eine Installation von Docker auf Linux an.
 
Diese Beschreibung nimmt eine Installation von Docker auf Linux an.
  
Zeile 20: Zeile 21:
 
Üblicherweise sind für Docker-Installationen auf Linux Admin-Berechtigungen erforderlich.
 
Üblicherweise sind für Docker-Installationen auf Linux Admin-Berechtigungen erforderlich.
  
−
Die meisten Befehle benötigen deshalb ein "sudo" davor haben oder müssen als root User ausgeführt werden.
+
Die meisten Befehle benötigen deshalb ein "sudo" davor oder müssen als root User ausgeführt werden.
  
−
=== Erstinstallation ===
 
  
−
==== Herunterladen / Kopieren von IRIS ====
+
 
−
Sie erhalten den Downloadlink von IRIS von unserem Support
+
== Erstinstallation ==
 +
 
 +
=== Herunterladen / Kopieren von IRIS ===
 +
Sie erhalten den Downloadlink für IRIS von unserem Support
  
  
Zeile 35: Zeile 38:
 
  wget <Downloadlink>
 
  wget <Downloadlink>
  
−
==== IRIS Docker Image laden ====
+
=== IRIS Docker Image laden ===
 
  docker load -i iris-1.X.X.tar.gz
 
  docker load -i iris-1.X.X.tar.gz
  
−
==== Volumes und Netzwerke vorbereiten ====
+
=== Volumes und Netzwerke vorbereiten ===
 
  docker volume create hsc-db
 
  docker volume create hsc-db
  
 
  docker volume create hsc-config
 
  docker volume create hsc-config
  
−
  docker network create hsc-network
+
=== Container aus Image erstellen ===
 +
  docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 +
 
 +
=== Container starten ===
 +
docker start iris
 +
 
 +
=== Logs des Containers prüfen ===
 +
docker logs iris
 +
In den Logs sollte ein Eintrag erscheinen, der so ähnlich lautet:<syntaxhighlight lang="text" line="1" start="1">
 +
2023-02-08 17:22:38.926 -08 WARN  [main] (init.ServiceInitializer:166) - A new user has been created.:
 +
Username: root@localhost
 +
Password: P6oV-GK3GYsdnn_5usDg1tBmn00
 +
Please login with this user and change your password immediately!
 +
</syntaxhighlight>Bitte notieren Sie sich diesen Benutzer + Passwort umgehend.
 +
 
 +
Sollte dieser Eintrag nicht erscheinen, warten Sie einen Moment und führen Sie den Befehl "docker logs iris" erneut aus.
 +
 
 +
=== Option 1: Eigenes SSL Zertifikat konfigurieren ===
 +
Im Standard wird der Docker Container einen HTTPS Server mit selbst signiertem Zertifikat veröffentlichen.
 +
 
 +
Das muss noch durch ein öffentliches, durch eine anerkannte Zertifizierungsstelle ausgestelltes, Zertifikat ersetzt werden.
 +
 
 +
Sie benötigen hierzu folgende Dateien:
 +
{| class="wikitable"
 +
|+
 +
!Datei
 +
!Format
 +
!Encoding
 +
!Beschreibung
 +
|-
 +
|ca.pem
 +
|[[wikipedia:X.509|X.509]]
 +
|[[wikipedia:Privacy-Enhanced_Mail|PEM]]
 +
|Das Zertifikat der anerkannten Zertifizierungsstelle
 +
|-
 +
|server-cert.pem
 +
|[[wikipedia:X.509|X.509]]
 +
|[[wikipedia:Privacy-Enhanced_Mail|PEM]]
 +
|Das ausgestellte Zertifikat für Ihren Server
 +
|-
 +
|server-privatekey-pkcs8.pem
 +
|[[wikipedia:PKCS_8|PKCS#8]]
 +
|[[wikipedia:Privacy-Enhanced_Mail|PEM]]
 +
|Der Private Key für Ihren Server
 +
|}
  
−
==== Container aus Image erstellen ====
 
  
−
===== Option 1 - Integrierter HTTPS Server =====
+
Die Dateien platzieren Sie bitte mit dem o.g. Dateinamen unter folgendem Ordner aus Container-Sicht:
−
Es wird der interne HTTPS-Server innerhalb des Docker-Containers verwendet
 
−
docker create --name iris --network bridge --hostname iris --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 
  
−
===== Option 2 - Externer Reverse Proxy =====
+
/etc/heidler/ssl/public
−
Ein externer Reverse Proxy wird verwendet, nimmt alle externen Anfragen entgegen, und gibt diese an den Docker-Container an Port 8080 weiter
 
−
docker create --name iris --network bridge --hostname iris --publish 127.0.0.1:8080:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 
  
−
==== Netzwerk verbinden ====
+
Dieses Verzeichnis wird über das Docker Volume "hsc-config" bereitgestellt.
−
docker network connect hsc-network iris
 
  
−
==== Container starten ====
+
Um herauszufinden, welchem Ordner auf der Host-Maschine das entspricht, können Sie folgenden Befehl verwenden:
−
docker start iris
+
docker volume inspect hsc-config
 +
 
 +
Unter dem Parameter "Mountpoint" finden Sie dann den lokalen Pfad.
 +
 
 +
Beispiel:
 +
 
 +
"Mountpoint": "/var/lib/docker/volumes/hsc-config/_data"
 +
 
 +
Dann wäre in diesem Beispiel der Pfad, wo die Dateien zu hinterlegen sind:
 +
 
 +
/var/lib/docker/volumes/hsc-config/_data/ssl/public
 +
 
 +
=== Option 2: Zertifikat mit Let's Encrypt™ generieren ===
 +
Beachten: Durch das Verwenden dieser Option stimmen Sie den Terms of Service Let's Encrypt zu. Die TOS können hier eingesehen werden: https://letsencrypt.org/repository/
 +
 
 +
Das öffentliche HTTPS Zertifikat wird mithilfe des Tools certbot angefragt: https://certbot.eff.org/
  
−
==== Logs des Containers prüfen ====
+
Um diesen Dienst zu nutzen, fügen Sie einfach zwei Umgebungsvariablen hinzu, wenn Sie den Docker Container erstellen:
−
  docker logs iris
+
--env LETSENCRYPT=<Ihre öffentliche Domain> --env LETSENCRYPTEMAIL=<Ihre E-Mail Adresse für Benachrichtigungen für Ihr Zertifikat>
 +
Gesamt-Beispiel:
 +
  docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --env LETSENCRYPT=iris.yourcompany.com --env LETSENCRYPTEMAIL=it@yourcompany.com --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 +
Sie müssen natürlich die Werte in diesem Beispiel mit Ihrer Domain und Ihrer E-Mail Adresse ersetzen.
  
−
=== Updates ===
+
== Updates ==
  
−
==== Herunterladen / Kopieren von IRIS ====
+
=== Herunterladen / Kopieren von IRIS ===
−
Sie erhalten den Downloadlink von IRIS von unserem Support
+
Sie erhalten den Downloadlink für IRIS von unserem Support
  
  
Zeile 77: Zeile 136:
 
  wget <Downloadlink>
 
  wget <Downloadlink>
  
−
==== Docker Image laden ====
+
=== Docker Image laden ===
 
  docker load -i iris-1.X.X.tar.gz
 
  docker load -i iris-1.X.X.tar.gz
  
−
==== IRIS stoppen ====
+
=== IRIS stoppen ===
 
Achtung: Ab hier ist IRIS für ca. 1 Minute nicht erreichbar
 
Achtung: Ab hier ist IRIS für ca. 1 Minute nicht erreichbar
−
  sudo docker stop iris
+
  docker stop iris
−
 
 
−
==== IRIS Container löschen ====
 
−
sudo docker rm iris
 
−
 
 
−
==== Neuen IRIS Container mit neuer Version erstellen ====
 
−
 
 
−
===== Option 1 - Integrierter HTTPS Server =====
 
−
Es wird der interne HTTPS-Server innerhalb des Docker-Containers verwendet
 
−
docker create --name iris --network bridge --hostname iris --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 
  
−
===== Option 2 - Externer Reverse Proxy =====
+
=== IRIS Container löschen ===
−
Ein externer Reverse Proxy wird verwendet, nimmt alle externen Anfragen entgegen, und gibt diese an den Docker-Container an Port 8080 weiter
+
  docker rm iris
−
  docker create --name iris --network bridge --hostname iris --publish 127.0.0.1:8080:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
 
  
−
==== Netzwerk verbinden ====
+
=== Neuen IRIS Container mit neuer Version erstellen ===
−
  docker network connect hsc-network iris
+
  docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X
  
−
==== Container starten ====
+
=== Container starten ===
 
  docker start iris
 
  docker start iris
  
−
==== Altes Container-Image entfernen ====
+
=== Altes Container-Image entfernen ===
 
Achtung! Im folgenden Befehl die Version 1.X.X durch die vorherige (nicht aktuelle) Version von IRIS ersetzen
 
Achtung! Im folgenden Befehl die Version 1.X.X durch die vorherige (nicht aktuelle) Version von IRIS ersetzen
 
  docker image rm iris:1.X.X
 
  docker image rm iris:1.X.X

Aktuelle Version vom 26. April 2023, 14:42 Uhr

Hinweise

IRIS Version

Im folgenden Text finden Sie viele Befehle, die die aktuelle Version von IRIS enthalten.

Bitte ersetzen Sie die Version durch die jeweils verfügbare aktuellste Version von IRIS.


Beispiel: 

docker load -i iris-1.X.X.tar.gz

zu 

docker load -i iris-1.0.18.tar.gz

bzw. die jeweils aktuellste Version

Docker auf Linux

Diese Beschreibung nimmt eine Installation von Docker auf Linux an.

Für andere Betriebssysteme müssen die Befehle oder Schritte entsprechend abgeändert werden.

Üblicherweise sind für Docker-Installationen auf Linux Admin-Berechtigungen erforderlich.

Die meisten Befehle benötigen deshalb ein "sudo" davor oder müssen als root User ausgeführt werden.


Erstinstallation

Herunterladen / Kopieren von IRIS

Sie erhalten den Downloadlink für IRIS von unserem Support


Zum Hochladen des Container-Images können Sie die Datei per scp in das Home-Verzeichnis des Docker-Hosts hochladen: 

scp iris-1.X.X.tar.gz <Benutzername>@<Servername>:~/


Alternativ direkt über den Downloadlink auf der Maschine herunterladen: 

wget <Downloadlink>

IRIS Docker Image laden

docker load -i iris-1.X.X.tar.gz

Volumes und Netzwerke vorbereiten

docker volume create hsc-db

docker volume create hsc-config

Container aus Image erstellen

docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X

Container starten

docker start iris

Logs des Containers prüfen

docker logs iris

In den Logs sollte ein Eintrag erscheinen, der so ähnlich lautet:

2023-02-08 17:22:38.926 -08 WARN  [main] (init.ServiceInitializer:166) - A new user has been created.:
Username: root@localhost
Password: P6oV-GK3GYsdnn_5usDg1tBmn00
Please login with this user and change your password immediately!

Bitte notieren Sie sich diesen Benutzer + Passwort umgehend.

Sollte dieser Eintrag nicht erscheinen, warten Sie einen Moment und führen Sie den Befehl "docker logs iris" erneut aus.

Option 1: Eigenes SSL Zertifikat konfigurieren

Im Standard wird der Docker Container einen HTTPS Server mit selbst signiertem Zertifikat veröffentlichen.

Das muss noch durch ein öffentliches, durch eine anerkannte Zertifizierungsstelle ausgestelltes, Zertifikat ersetzt werden.

Sie benötigen hierzu folgende Dateien:

Datei Format Encoding Beschreibung
ca.pem X.509 PEM Das Zertifikat der anerkannten Zertifizierungsstelle
server-cert.pem X.509 PEM Das ausgestellte Zertifikat für Ihren Server
server-privatekey-pkcs8.pem PKCS#8 PEM Der Private Key für Ihren Server


Die Dateien platzieren Sie bitte mit dem o.g. Dateinamen unter folgendem Ordner aus Container-Sicht:

/etc/heidler/ssl/public

Dieses Verzeichnis wird über das Docker Volume "hsc-config" bereitgestellt.

Um herauszufinden, welchem Ordner auf der Host-Maschine das entspricht, können Sie folgenden Befehl verwenden: 

docker volume inspect hsc-config

Unter dem Parameter "Mountpoint" finden Sie dann den lokalen Pfad.

Beispiel:

"Mountpoint": "/var/lib/docker/volumes/hsc-config/_data"

Dann wäre in diesem Beispiel der Pfad, wo die Dateien zu hinterlegen sind:

/var/lib/docker/volumes/hsc-config/_data/ssl/public

Option 2: Zertifikat mit Let's Encrypt™ generieren

Beachten: Durch das Verwenden dieser Option stimmen Sie den Terms of Service Let's Encrypt zu. Die TOS können hier eingesehen werden: https://letsencrypt.org/repository/

Das öffentliche HTTPS Zertifikat wird mithilfe des Tools certbot angefragt: https://certbot.eff.org/

Um diesen Dienst zu nutzen, fügen Sie einfach zwei Umgebungsvariablen hinzu, wenn Sie den Docker Container erstellen: 

--env LETSENCRYPT=<Ihre öffentliche Domain> --env LETSENCRYPTEMAIL=<Ihre E-Mail Adresse für Benachrichtigungen für Ihr Zertifikat>

Gesamt-Beispiel: 

docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --env LETSENCRYPT=iris.yourcompany.com --env LETSENCRYPTEMAIL=it@yourcompany.com --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X

Sie müssen natürlich die Werte in diesem Beispiel mit Ihrer Domain und Ihrer E-Mail Adresse ersetzen.

Updates

Herunterladen / Kopieren von IRIS

Sie erhalten den Downloadlink für IRIS von unserem Support


Zum Hochladen des Container-Images können Sie die Datei per scp in das Home-Verzeichnis des Docker-Hosts hochladen: 

scp iris-1.X.X.tar.gz <Benutzername>@<Servername>:~/


Alternativ direkt über den Downloadlink auf der Maschine herunterladen: 

wget <Downloadlink>

Docker Image laden

docker load -i iris-1.X.X.tar.gz

IRIS stoppen

Achtung: Ab hier ist IRIS für ca. 1 Minute nicht erreichbar 

docker stop iris

IRIS Container löschen

docker rm iris

Neuen IRIS Container mit neuer Version erstellen

docker create --name iris --hostname iris --network bridge --publish 80:80 --publish 443:443 --volume hsc-db:/var/lib/mysql --volume hsc-config:/etc/heidler --restart unless-stopped iris:1.X.X

Container starten

docker start iris

Altes Container-Image entfernen

Achtung! Im folgenden Befehl die Version 1.X.X durch die vorherige (nicht aktuelle) Version von IRIS ersetzen 

docker image rm iris:1.X.X
Abgerufen von „https://wiki.heidler-strichcode.de/w/index.php?title=IRIS_Installation_(Docker)&oldid=5031“