Romexis-Docker-Wiki
Willkommen im Wiki des Romexis-Docker-Projekts.
Dieses Wiki dokumentiert den Docker-basierten Romexis-Runtime-Stack, das Backend-spezifische Compose-Layout, die lokalen und Drone-Build-Workflows, die Payload-/Runtime-Image-Architektur, die Romexis-Server-, Admin- und Client-Container, den mRomexis-Web-App-Container, die Datenbank-Backends, die Migrationswerkzeuge und den CI/CD-Workflow.
Dieses Projekt stellt eine reproduzierbare Docker-Umgebung für den Betrieb von Planmeca Romexis Server unter Linux, macOS oder WSL mit Windows bereit und hält den Build-Prozess dabei nahe am Layout des ursprünglichen Installers. Romexis-Anwendungsbinärdateien werden nicht im Repository gespeichert. Sie werden während des Build-Prozesses aus offiziellen Installer-Paketen extrahiert.
Hauptbereiche
| Bereich | Beschreibung |
|---|---|
| Projektübersicht | Übergeordnete Ziele, Funktionen und unterstützte Plattformen |
| Architektur | Image-Schichten, Runtime-Container und Datenfluss |
| Schnellstart | Minimale Schritte zum Starten des Stacks |
| Compose-Runtime | Basis-Compose-Datei, Backend-Overrides und .env-Auswahl |
| Konfiguration | Umgebungsvariablen und Runtime-Konfiguration |
| Container-Images | Registry-Images, Tags, Manifeste und Branch-Suffixe |
| Romexis Admin | Browserbasierter RomexisConfig-/Admin-Container über noVNC |
| Romexis Client | Browserbasierter Romexis-Client-Container über noVNC |
| mRomexis Web App | Separater Tomcat-basierter mRomexis-Web-Frontend-Container |
| Build-System | Payload-, Base-, Server-, Admin- und Web-App-Build-Workflow |
| Lokale Build-Skripte | Lokale Build-Hilfsskripte für Linux/macOS und Windows |
| Datenbank-Backends | MSSQL- und Firebird-Backend-Architektur |
| Migrationsdienst | Web-UI, REST-API, SFTP und Wiederherstellungsworkflow |
| Migrationsworkflow | Manueller und Client-gestützter Migrationsprozess |
| CI/CD-Pipeline | Drone-Pipeline und Veröffentlichungsprozess |
| Entwicklerhandbuch | Repository-Struktur und interne Entwicklungshinweise |
| Fehlerbehebung | Häufige Fehler und Lösungen |
Aktuelle Kernkomponenten
romexis-payload/
Builds architecture-independent server/admin and client payload images from the official Windows installer.
romexis-firebird-payload/
Builds a Firebird SQL payload from the official macOS installer.
romexis-common/
Enthält die gemeinsamen PropertyAgent-, RomexisOptionPaneUI-, RxCr2-Patch- und DxService-Kompatibilitätsquellen.
romexis-base/
Builds the reusable Java 11 server runtime image.
romexis-gui-runtime/
Builds the reusable Java 17/X11/noVNC GUI runtime for Admin and Client.
romexis/
Builds the final Romexis Server image.
romexis-admin/
Builds the browser-accessible Romexis Admin / RomexisConfig container.
romexis-client/
Builds the browser-accessible Romexis Client container.
romexis-mromexis-app/
Builds the standalone mRomexis Web App container from the Romexis payload WAR.
migration-service/
Provides browser-based and API-driven migration orchestration.
romexis-control-agent/
Provides restricted container-control operations for migration and service coordination.
migration-client/
Provides the Windows migration helper client.
scripts/
Contains local and CI build helpers.
Aktuelles Runtime-Layout
Die Runtime ist in eine Basis-Compose-Datei und Backend-spezifische Override-Dateien aufgeteilt:
docker-compose.yml
Base runtime services and shared configuration.
docker-compose.mssql.yml
Microsoft SQL Server backend and MSSQL-specific Romexis settings.
docker-compose.firebird.yml
Firebird backend and Firebird-specific Romexis settings.
Das aktive Backend wird in .env über DATABASE_BACKEND und COMPOSE_FILE ausgewählt.
Empfohlene Lesereihenfolge
- Projektübersicht
- Architektur
- Compose-Runtime
- Schnellstart
- Konfiguration
- Romexis Admin
- Romexis Client
- mRomexis Web App
- Datenbank-Backends
- Build-System
- Entwicklerhandbuch
Wichtige Hinweise
- Es werden keine Romexis-Anwendungsbinärdateien in das Repository eingecheckt.
- Offizielle Planmeca-Installer-Pakete werden während der Payload-Builds heruntergeladen.
- Die Auswahl des Runtime-Backends wird über
.envund die Docker-Compose-Dateiauswahl gesteuert. - Microsoft SQL Server bleibt das standardmäßige und am umfassendsten getestete Backend.
- Firebird-Unterstützung ist über ein dediziertes Compose-Override verfügbar.
- Romexis Admin wird über einen separaten Browser-/noVNC-Container bereitgestellt.
- mRomexis Web App wird über einen separaten Tomcat-basierten Container bereitgestellt und benötigt Romexis 6.5.3 oder neuer.
- Der Migrationsdienst ist dafür vorgesehen, vorhandene Windows-basierte Romexis-Installationen in den Docker-Stack zu übertragen.
Romexis Docker Wiki
English
Getting Started
- Project Overview
- Architecture
- Quick Start
- Synology Quick Start
- Use with Docker + WSL in Windows
- Compose Runtime
- Configuration
- Container Images
Runtime Services
- Romexis Admin
- Romexis Client
- mRomexis Web App
- Runtime Layout
- Backup and Restore
- Troubleshooting
- Security
Build System
Database
Migration
Development
Source Documents
Deutsch
Erste Schritte
- Projektübersicht
- Architektur
- Schnellstart
- Synology Quick Start
- Nutzung mit Docker + WSL unter Windows
- Compose-Runtime
- Konfiguration
- Container-Images
Runtime-Dienste
- Romexis Admin
- Romexis Client
- mRomexis Web App
- Runtime-Layout
- Sicherung und Wiederherstellung
- Fehlerbehebung
- Sicherheit
Build-System
Datenbank
Migration
Entwicklung
Quelldokumente
Romexis Docker Project Wiki / Romexis-Docker-Projekt-Wiki
English Home · Deutsche Startseite · English source documents · Deutsche Quelldokumente · Security · Sicherheit
Internal operations and development wiki / Internes Betriebs- und Entwicklungswiki