Docker-Installation

In ChatGPT öffnen

Dieser Abschnitt der Dokumentation behandelt die Schritte, die Benutzer befolgen müssen, die mit Docker entwickeln möchten. Änderungen an Ihrem Code werden auf Ihrem Entwicklungsrechner vorgenommen, und die resultierende App wird in Docker ausgeführt.

1. Docker herunterladen

Der Installationsprozess für Docker variiert leicht zwischen Windows-, Mac- und Linux-Benutzern. Sehen Sie sich den Abschnitt an, der Ihrem Betriebssystem entspricht.

Windows

Info

Es wird empfohlen, die neueste Version des Windows Subsystem for Linux herunterzuladen. Weitere Informationen finden Sie unter diesem Link.

1. Docker Desktop herunterladen:

• Besuchen Sie die Download-Seite für Docker Desktop für Windows: Docker Desktop für Windows
• Klicken Sie auf die Schaltfläche "Docker Desktop für Windows herunterladen", um den Installer herunterzuladen.

2. Docker Desktop installieren:

• Führen Sie den Installer aus, den Sie heruntergeladen haben.
• Folgen Sie dem Installationsassistenten und stellen Sie sicher, dass Sie Hyper-V aktivieren (wenn Sie dazu aufgefordert werden), da Docker für Windows Hyper-V für die Virtualisierung verwendet.
• Nach Abschluss der Installation wird Docker Desktop automatisch gestartet.

3. Installation überprüfen:

• Öffnen Sie ein Terminal und führen Sie den Befehl docker --version aus, um zu überprüfen, ob Docker korrekt installiert und funktionsfähig ist.

Mac

1. Docker Desktop herunterladen:

• Besuchen Sie die Download-Seite für Docker Desktop für Mac: Docker Desktop für Mac

2. Docker Desktop installieren:

• Führen Sie den Installer aus, den Sie heruntergeladen haben.
• Nach Abschluss der Installation wird Docker Desktop automatisch gestartet.

3. Installation überprüfen:

• Öffnen Sie ein Terminal und führen Sie den Befehl docker --version aus, um zu überprüfen, ob Docker korrekt installiert und funktionsfähig ist.

2. Konfiguration

Sobald Docker Desktop heruntergeladen wurde, suchen Sie nach dem neuesten webforJ-Image, das derzeit unter dem Namen webforj/sandbox verfügbar ist.

Klicken Sie auf die Liste der Tags, um die verfügbaren Optionen zu sehen.

Wählen Sie für den aktuellsten Build "rc" aus.

Ziehen Sie das Image, um Ihren Container zu starten.

Sobald der Download abgeschlossen ist, klicken Sie auf die Schaltfläche Ausführen, um die Konfigurationseinstellungen zu öffnen.

Öffnen Sie das Menü "Optionale Einstellungen".

Wählen Sie einen gewünschten Host-Port, über den Sie Ihre App innerhalb von Docker sehen können.

Klicken Sie auf "Ausführen", um den Container zu starten.

Wichtig

Stellen Sie sicher, dass Sie die von Ihnen angegebene benutzerdefinierte Host-Portnummer notieren, da diese später benötigt wird.

3. Ihre App ausführen

Sobald der Container erstellt wurde, können webforJ-Anwendungen innerhalb des Containers anstelle lokal ausgeführt werden. Zunächst muss die POM-Datei Ihres Projekts korrekt konfiguriert werden. Wenn dies erledigt ist, zeigt ein Besuch einer bestimmten URL im Browser die App an.

Konfigurieren Ihrer POM-Datei

Das Ausführen eines webforJ-Projekts im Docker-Container erfordert die Verwendung des webforJ Install Plugin, das über Ihre POM-Datei konfiguriert werden kann:

Erstellen Sie einen neuen <plugin>-Eintrag im <plugins>-Abschnitt der POM. Der folgende Code zeigt einen Start-Eintrag, der verwendet und angepasst werden kann, wie erforderlich:

important

Wenn Ihre POM-Datei keinen <plugins>-Abschnitt hat, erstellen Sie einen.

<plugin>
<groupId>com.webforj</groupId>
<artifactId>webforj-install-maven-plugin</artifactId>
<version>${webforj.version}</version>
<executions>
  <execution>
  <goals>
    <goal>install</goal>
  </goals>
  </execution>
</executions>
<configuration>
  <deployurl>http://localhost:8888/webforj-install</deployurl>
  <classname>samples.HelloWorldApp</classname>
  <publishname>hello-world</publishname>
  <debug>true</debug>
</configuration>
</plugin>

Sobald ein Eintrag ähnlich dem obigen erstellt wurde, passen Sie die folgenden Informationen an:

• Ändern Sie den <deployurl>-Eintrag so, dass er die Portnummer verwendet, die Sie mit dem Host-Port abgeglichen haben, den Sie in dem vorherigen Schritt konfiguriert haben.

• Stellen Sie sicher, dass der <classname>-Eintrag mit dem Namen der App übereinstimmt, die Sie ausführen möchten.

• Wenn Ihre <username>- und <password>-Anmeldeinformationen für Ihre Installation von BBj unterschiedlich sind, ändern Sie diese.

Verwendung des Starterprojekts

Um ein neues bbj-hello-world-Projekt zu erstellen und zu scaffolden, folgen Sie diesen Schritten:

1. Navigieren Sie zum richtigen Verzeichnis: Öffnen Sie ein Terminal und wechseln Sie in den Ordner, in dem Sie Ihr neues Projekt erstellen möchten.
2. Führe den Befehl archetype:generate aus: Verwenden Sie den folgenden Maven-Befehl und passen Sie groupId, artifactId und version nach Bedarf für Ihr Projekt an.

Bash/Zsh

mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-bbj-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-DappName=MyApp

PowerShell

mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-DappName="MyApp"

Command Prompt

mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-DappName="MyApp"

Argumentation	Erklärung
archetypeGroupId	Die Gruppen-ID des Archetyps ist com.webforj für webforJ-Archetypen.
archetypeArtifactId	Gibt den Namen des zu verwendenden Archetyps an.
archetypeVersion	Legt die zu verwendende Version des Archetyps fest. Dies stellt sicher, dass das generierte Projekt mit einer bestimmten Archetyp-Version kompatibel ist. Die Auswahl von LATEST wählt die aktuellste verfügbare Version aus.
groupId	Namespace für das generierte Projekt. Typisch strukturiert wie ein Java-Paket, z.B. org.example und wird verwendet, um Ihre Organisation oder Projektdomain eindeutig zu identifizieren.
artifactId	Gibt den Namen des generierten Projekts an. Dies wird der Name des resultierenden Artefakts und des Projektordners sein.
version	Legt die Version des generierten Projekts fest. Eine gängige Konvention ist MAJOR.MINOR-SNAPSHOT, wie 1.0-SNAPSHOT, wobei SNAPSHOT bedeutet, dass sich das Projekt noch in der Entwicklung befindet.
appName	Ein optionaler Parameter, der in der POM-Datei des generierten Projekts verwendet werden kann. Abhängig vom verwendeten webforJ-Archetyp kann er als Standardtitel für die Anwendung genutzt werden.

Nach Ausführung des Befehls wird Maven die benötigten Projektdateien generieren, um das Projekt auszuführen.

Starten der App

Sobald dies erledigt ist, führen Sie mvn install in Ihrem Projektverzeichnis aus. Dies wird das webforJ Install Plugin ausführen und es Ihnen ermöglichen, auf Ihre App zuzugreifen. Um die App zu sehen, möchten Sie die folgende URL besuchen:

http://localhost:YourHostPort/webapp/YourPublishName

Ersetzen Sie YourHostPort durch den Host-Port, den Sie mit Docker konfiguriert haben, und YourPublishName wird durch den Text im <publishname>-Tag der POM ersetzt. Wenn alles korrekt gemacht wurde, sollten Sie Ihre App gerendert sehen.