Planmeca/romexis-server-docker
Private
Public Access
5
1
Packages Wiki

update synology site with client feature and demovideo

patrick
2026-08-23 20:15:07 +02:00
parent 36668be1af
commit 0328bf20ae
2 changed files with 124 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Synology-ContainerStation.de.md
+62 -17
@@ -2,12 +2,22 @@
[English](Synology-ContainerStation) [English](Synology-ContainerStation)
Diese Anleitung beschreibt die Einrichtung von **Romexis im Docker-Container** auf einer **Synology NAS** mit dem Synology **Container Manager** beziehungsweise der älteren **Container Station**. > **Demo:** Im folgenden Video laufen **Romexis Server und Romexis Client gleichzeitig auf der Synology NAS**. Der vollständige Romexis Client wird im Container ausgeführt und über **VNC/noVNC direkt im Webbrowser** bedient. Das Demo wurde auf einer **Synology DS-218+ mit 10 GB RAM und 2 × 4 TB HDD** erstellt. Der Client-Container enthält außerdem die für Romexis benötigte **3D-Unterstützung über Java3D/JogAmp**; im aktuellen Container erfolgt das OpenGL-Rendering softwarebasiert, sodass die 3D-Performance von der CPU-Leistung der NAS abhängt.
<video controls preload="metadata" style="max-width:100%; height:auto;"
poster="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/poster.png"
src="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/Romexis%20auf%20Synology%20NAS%20DS-218%2B(10GB%20RAM%202xHDD).mp4"
type="video/mp4">
Dein Browser unterstützt das Video-Element nicht.
</video>
Diese Anleitung beschreibt die Einrichtung von **Romexis im Docker-Container** auf einer **Synology NAS** mit dem Synology **Container Manager** beziehungsweise dem älteren Synology-**Docker-Paket**.
Das Setup startet die folgenden Komponenten auf der NAS: Das Setup startet die folgenden Komponenten auf der NAS:
- Romexis Server im Docker-Container - Romexis Server im Docker-Container
- Microsoft SQL Server 2017 im Docker-Container - Microsoft SQL Server 2017 im Docker-Container
- Romexis Client im Docker-Container mit Browserzugriff über VNC/noVNC und 3D-Unterstützung
- Romexis Configuration über Webzugriff - Romexis Configuration über Webzugriff
Die Einrichtung erfolgt über die Synology-Oberfläche, insbesondere über **File Station**, den **Synology Text Editor** und den **Container Manager**. Die Einrichtung erfolgt über die Synology-Oberfläche, insbesondere über **File Station**, den **Synology Text Editor** und den **Container Manager**.
@@ -19,7 +29,7 @@ Die Einrichtung erfolgt über die Synology-Oberfläche, insbesondere über **Fil
Benötigt wird: Benötigt wird:
- eine Synology NAS mit Docker-Unterstützung - eine Synology NAS mit Docker-Unterstützung
- installierter Synology **Container Manager** oder **Container Station** - installierter Synology **Container Manager** oder das ältere Synology-**Docker-Paket**
- Zugriff auf die **File Station** - Zugriff auf die **File Station**
- Zugriff auf den **Synology Text Editor** - Zugriff auf den **Synology Text Editor**
- das bereitgestellte ZIP-Paket mit den Docker-Compose-Dateien und der Ordnerstruktur - das bereitgestellte ZIP-Paket mit den Docker-Compose-Dateien und der Ordnerstruktur
@@ -27,7 +37,7 @@ Benötigt wird:
Download-Link: Download-Link:
```text ```text
https://nextcloud.buchhorster.de/s/dXQzkCcfNCKBtik https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/synology-romexis-server-and-client.zip
``` ```
Passwort: Passwort:
@@ -35,15 +45,6 @@ Passwort:
Plandent2026! Plandent2026!
``` ```
Beispiel:
<video controls preload="metadata" style="max-width:100%; height:auto;"
poster="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/poster.png"
src="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/Romexis%20auf%20Synology%20NAS%20DS-218%2B(10GB%20RAM%202xHDD).mp4"
type="video/mp4">
Your Browser not support Video-Element
</video>
--- ---
## 1. Zielverzeichnis auf der NAS erstellen ## 1. Zielverzeichnis auf der NAS erstellen
@@ -67,7 +68,7 @@ Dieses Verzeichnis wird später als Projektverzeichnis im Container Manager verw
Lade das bereitgestellte ZIP-Paket herunter: Lade das bereitgestellte ZIP-Paket herunter:
```text ```text
https://nextcloud.test.de/orizgirgihc https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/synology-romexis-server-and-client.zip
``` ```
Speichere die ZIP-Datei über die **File Station** in dem zuvor erstellten Verzeichnis, zum Beispiel: Speichere die ZIP-Datei über die **File Station** in dem zuvor erstellten Verzeichnis, zum Beispiel:
@@ -85,7 +86,7 @@ docker-compose.yml
.env .env
``` ```
sowie die benötigten Unterordner für die Romexis- und SQL-Server-Container. sowie die benötigten Unterordner für die Romexis-Server-, Romexis-Client- und SQL-Server-Container.
--- ---
@@ -192,6 +193,8 @@ Beispiel:
Die genaue Verwendung hängt vom jeweiligen Romexis-Client beziehungsweise von der vorhandenen Romexis-Umgebung ab. Die genaue Verwendung hängt vom jeweiligen Romexis-Client beziehungsweise von der vorhandenen Romexis-Umgebung ab.
Neben lokal installierten Romexis-Clients enthält das Paket auch einen **Romexis-Client-Container**, der direkt auf der NAS ausgeführt und über den Browser bedient werden kann. Dieser Zugriff wird in Abschnitt 8 beschrieben.
--- ---
## 7. Romexis Configuration öffnen ## 7. Romexis Configuration öffnen
@@ -218,7 +221,29 @@ Wichtig: Die Adresse wird mit `http://` aufgerufen, nicht mit `https://`.
--- ---
## 8. Typische Fehlerquellen ## 8. Romexis Client im Browser öffnen
Das Paket enthält zusätzlich den Container **`romexis-client`**. Darin läuft der vollständige Romexis Client auf der NAS. Die grafische Sitzung wird über VNC bereitgestellt und über **noVNC im Webbrowser** angezeigt. Dadurch kann der Client verwendet werden, ohne Romexis auf dem Arbeitsplatzrechner lokal zu installieren.
Öffne im Browser die IP-Adresse der NAS zusammen mit dem für den Romexis-Client veröffentlichten noVNC-Port:
```text
http://NAS-IP:<CLIENT-NOVNC-PORT>
```
Der tatsächlich verwendete Port ergibt sich aus der mitgelieferten `.env`- beziehungsweise `docker-compose.yml`-Konfiguration. Wird der Port dort geändert, muss beim Browserzugriff entsprechend der geänderte Port verwendet werden.
### 3D-Unterstützung im Client-Container
Der Client-Container enthält die Linux-Unterstützung für **Java3D, JOGL und GlueGen/JogAmp**. Beim Image-Build wird die in der jeweiligen `Romexis.jar` enthaltene JogAmp-Version erkannt und es werden die dazu passenden nativen Linux-Bibliotheken für die Zielarchitektur eingebunden. Damit stehen auch die Romexis-Funktionen zur Verfügung, die auf der Java3D-/JogAmp-3D-Darstellung aufbauen.
Das OpenGL-Rendering des aktuellen Client-Containers ist softwarebasiert. Dadurch ist kein direkt an den Container durchgereichter Grafikadapter erforderlich; bei aufwendigen 3D-Darstellungen hängt die Geschwindigkeit jedoch stärker von der CPU-Leistung der NAS ab.
Das oben eingebettete Demo wurde vollständig auf einer **Synology DS-218+ mit 10 GB RAM und 2 × 4 TB HDD** aufgenommen. Dabei liefen sowohl der Romexis Server als auch der Romexis Client auf derselben NAS, während der Client über noVNC im Browser bedient wurde.
---
## 9. Typische Fehlerquellen
### Romexis ist nicht erreichbar ### Romexis ist nicht erreichbar
@@ -253,6 +278,18 @@ Außerdem prüfen:
- wird Port `6080` nicht durch einen anderen Dienst blockiert? - wird Port `6080` nicht durch einen anderen Dienst blockiert?
- wurde die richtige NAS-IP verwendet? - wurde die richtige NAS-IP verwendet?
### Romexis Client oder 3D-Darstellung funktioniert nicht
Prüfe:
- läuft der Container `romexis-client`?
- wird der für den Client konfigurierte noVNC-Port von der NAS veröffentlicht und nicht durch einen anderen Dienst blockiert?
- wurde beim Aufbau des Client-Images eine JogAmp-Version erfolgreich erkannt?
- wurden die passenden nativen JogAmp-Bibliotheken für die Architektur der NAS in das Image übernommen?
- zeigt der Browser die noVNC-Oberfläche und lässt sich eine VNC-Verbindung zum Client aufbauen?
Bei softwarebasiertem OpenGL kann eine aufwendige 3D-Darstellung auf schwächerer NAS-Hardware deutlich langsamer sein als auf einem Arbeitsplatzrechner mit dedizierter GPU.
### MSSQL startet langsam ### MSSQL startet langsam
Das ist beim ersten Start normal. Das ist beim ersten Start normal.
@@ -275,7 +312,7 @@ docker logs -f romexis-mssql
--- ---
## 9. Nützliche Prüfungen per SSH ## 10. Nützliche Prüfungen per SSH
Containerstatus anzeigen: Containerstatus anzeigen:
@@ -289,6 +326,12 @@ Logs des MSSQL-Containers anzeigen:
docker logs --tail 300 romexis-mssql docker logs --tail 300 romexis-mssql
``` ```
Logs des Romexis-Client-Containers anzeigen:
```bash
docker logs --tail 300 romexis-client
```
Logs live verfolgen: Logs live verfolgen:
```bash ```bash
@@ -313,7 +356,7 @@ Hinweis: Bei SQL Server 2017 liegt `sqlcmd` normalerweise unter:
--- ---
## 10. Kurzfassung ## 11. Kurzfassung
```text ```text
1. ZIP-Paket herunterladen. 1. ZIP-Paket herunterladen.
@@ -331,6 +374,8 @@ Hinweis: Bei SQL Server 2017 liegt `sqlcmd` normalerweise unter:
13. Einige Minuten warten, bis MSSQL initialisiert ist. 13. Einige Minuten warten, bis MSSQL initialisiert ist.
14. Romexis über die NAS-IP verwenden. 14. Romexis über die NAS-IP verwenden.
15. Romexis Configuration über http://NAS-IP:6080 öffnen. 15. Romexis Configuration über http://NAS-IP:6080 öffnen.
16. Optional den Romexis-Client-Container über den veröffentlichten noVNC-Port im Browser öffnen.
17. Für 3D-Funktionen den Client-Container verwenden; die passenden JogAmp-Native-Bibliotheken sind im Image enthalten.
``` ```
--- ---
Synology-ContainerStation.md
+62 -18
@@ -2,12 +2,22 @@
[Deutsch](Synology-ContainerStation.de) [Deutsch](Synology-ContainerStation.de)
This guide describes how to run **Romexis in Docker containers** on a **Synology NAS** using Synology **Container Manager** or the older **Container Station**. > **Demo:** In the following video, **Romexis Server and Romexis Client are both running on the Synology NAS at the same time**. The full Romexis Client runs inside a container and is operated through **VNC/noVNC directly in a web browser**. The demo was recorded on a **Synology DS-218+ with 10 GB RAM and 2 × 4 TB HDDs**. The client container also includes the **3D support required by Romexis through Java3D/JogAmp**; in the current container, OpenGL rendering is software-based, so 3D performance depends on the CPU performance of the NAS.
<video controls preload="metadata" style="max-width:100%; height:auto;"
poster="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/poster.png"
src="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/Romexis%20auf%20Synology%20NAS%20DS-218%2B(10GB%20RAM%202xHDD).mp4"
type="video/mp4">
Your browser does not support the video element.
</video>
This guide describes how to run **Romexis in Docker containers** on a **Synology NAS** using Synology **Container Manager** or the older Synology **Docker package**.
The setup starts the following components on the NAS: The setup starts the following components on the NAS:
- Romexis Server in a Docker container - Romexis Server in a Docker container
- Microsoft SQL Server 2017 in a Docker container - Microsoft SQL Server 2017 in a Docker container
- Romexis Client in a Docker container with browser access through VNC/noVNC and 3D support
- Romexis Configuration via browser access - Romexis Configuration via browser access
The installation is done through the Synology web interface, mainly using **File Station**, the **Synology Text Editor**, and **Container Manager**. The installation is done through the Synology web interface, mainly using **File Station**, the **Synology Text Editor**, and **Container Manager**.
@@ -19,7 +29,7 @@ The installation is done through the Synology web interface, mainly using **File
You need: You need:
- a Synology NAS with Docker support - a Synology NAS with Docker support
- Synology **Container Manager** or **Container Station** - Synology **Container Manager** or the older Synology **Docker package**
- access to **File Station** - access to **File Station**
- access to the **Synology Text Editor** - access to the **Synology Text Editor**
- the provided ZIP package containing the Docker Compose files and folder structure - the provided ZIP package containing the Docker Compose files and folder structure
@@ -27,7 +37,7 @@ You need:
Download link: Download link:
```text ```text
https://nextcloud.buchhorster.de/s/dXQzkCcfNCKBtik https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/synology-romexis-server-and-client.zip
``` ```
Password: Password:
@@ -35,16 +45,6 @@ Password:
Plandent2026! Plandent2026!
``` ```
Sample:
<video controls preload="metadata" style="max-width:100%; height:auto;"
poster="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/poster.png"
src="https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/Romexis%20auf%20Synology%20NAS%20DS-218%2B(10GB%20RAM%202xHDD).mp4"
type="video/mp4">
Dein Browser unterstützt das Video-Element nicht.
</video>
--- ---
## 1. Create the target directory on the NAS ## 1. Create the target directory on the NAS
@@ -68,7 +68,7 @@ This directory will later be used as the project directory in Container Manager.
Download the provided ZIP package: Download the provided ZIP package:
```text ```text
https://nextcloud.test.de/orizgirgihc https://nextcloud.buchhorster.de/public.php/dav/files/8ByCodK2rL6FZQ7/synology-romexis-server-and-client.zip
``` ```
Save the ZIP file via **File Station** into the previously created directory, for example: Save the ZIP file via **File Station** into the previously created directory, for example:
@@ -86,7 +86,7 @@ docker-compose.yml
.env .env
``` ```
as well as the required subdirectories for the Romexis and SQL Server containers. as well as the required subdirectories for the Romexis Server, Romexis Client, and SQL Server containers.
--- ---
@@ -193,6 +193,8 @@ Example:
The exact usage depends on the Romexis client and the existing Romexis environment. The exact usage depends on the Romexis client and the existing Romexis environment.
In addition to locally installed Romexis clients, the package also contains a **Romexis Client container** that runs directly on the NAS and can be operated from a browser. This access method is described in section 8.
--- ---
## 7. Open Romexis Configuration ## 7. Open Romexis Configuration
@@ -219,7 +221,29 @@ Important: Use `http://`, not `https://`.
--- ---
## 8. Common issues ## 8. Open Romexis Client in the browser
The package additionally contains the **`romexis-client`** container. It runs the full Romexis Client on the NAS. The graphical session is provided through VNC and displayed through **noVNC in a web browser**. This allows the client to be used without installing Romexis locally on the workstation.
In a browser, open the NAS IP address together with the noVNC port published for the Romexis Client:
```text
http://NAS-IP:<CLIENT-NOVNC-PORT>
```
The actual port is defined by the supplied `.env` or `docker-compose.yml` configuration. If the port is changed there, use the corresponding changed port for browser access.
### 3D support in the client container
The client container includes Linux support for **Java3D, JOGL, and GlueGen/JogAmp**. During the image build, the JogAmp version embedded in the respective `Romexis.jar` is detected and the matching native Linux libraries for the target architecture are included. This makes the Romexis functions that rely on Java3D/JogAmp 3D rendering available in the container as well.
OpenGL rendering in the current client container is software-based. This means that a graphics adapter does not have to be passed directly through to the container; however, demanding 3D views depend more strongly on the CPU performance of the NAS.
The demo embedded at the top of this page was recorded entirely on a **Synology DS-218+ with 10 GB RAM and 2 × 4 TB HDDs**. Both the Romexis Server and the Romexis Client were running on the same NAS while the client was operated through noVNC in the browser.
---
## 9. Common issues
### Romexis is not reachable ### Romexis is not reachable
@@ -254,6 +278,18 @@ Also check:
- port `6080` is not blocked by another service - port `6080` is not blocked by another service
- the correct NAS IP address is being used - the correct NAS IP address is being used
### Romexis Client or 3D rendering does not work
Check the following:
- is the `romexis-client` container running?
- is the noVNC port configured for the client published by the NAS and not blocked by another service?
- was a JogAmp version detected successfully when the client image was built?
- were the matching native JogAmp libraries for the NAS architecture included in the image?
- does the browser show the noVNC interface and can it establish a VNC connection to the client?
With software-based OpenGL, demanding 3D rendering can be noticeably slower on lower-performance NAS hardware than on a workstation with a dedicated GPU.
### MSSQL starts slowly ### MSSQL starts slowly
This is normal during the first start. This is normal during the first start.
@@ -276,7 +312,7 @@ docker logs -f romexis-mssql
--- ---
## 9. Useful SSH checks ## 10. Useful SSH checks
Show running containers: Show running containers:
@@ -290,6 +326,12 @@ Show logs of the MSSQL container:
docker logs --tail 300 romexis-mssql docker logs --tail 300 romexis-mssql
``` ```
Show logs of the Romexis Client container:
```bash
docker logs --tail 300 romexis-client
```
Follow logs live: Follow logs live:
```bash ```bash
@@ -314,7 +356,7 @@ Note: With SQL Server 2017, `sqlcmd` is usually located at:
--- ---
## 10. Quick summary ## 11. Quick summary
```text ```text
1. Download the ZIP package. 1. Download the ZIP package.
@@ -332,6 +374,8 @@ Note: With SQL Server 2017, `sqlcmd` is usually located at:
13. Wait a few minutes until MSSQL is initialized. 13. Wait a few minutes until MSSQL is initialized.
14. Use Romexis with the NAS IP address. 14. Use Romexis with the NAS IP address.
15. Open Romexis Configuration at http://NAS-IP:6080. 15. Open Romexis Configuration at http://NAS-IP:6080.
16. Optionally open the Romexis Client container in the browser through its published noVNC port.
17. Use the client container for 3D functions; the matching JogAmp native libraries are included in the image.
``` ```
--- ---