6

Home

Patrick Gniza edited this page 2026-08-22 15:46:50 +02:00

Table of Contents

• Romexis Docker Wiki
• Main Areas
• Current Core Components
• Current Runtime Layout
• Recommended Reading Order
• Important Notes

Deutsch | English

Romexis Docker Wiki

Welcome to the Romexis Docker project wiki.

This wiki documents the Docker-based Romexis runtime stack, the backend-specific Compose layout, the local and Drone build workflows, the payload/runtime image architecture, the Romexis Server, Admin and Client containers, the mRomexis Web App container, database backends, migration tooling and CI/CD workflow.

This project provides a reproducible Docker environment for running Planmeca Romexis Server on Linux, macOS or WSL with Windows while keeping the build process close to the original installer layout. Romexis application binaries are not stored in the repository. They are extracted from official installer packages during the build process.

---

Main Areas

Area	Description
Project Overview	High-level goals, features and supported platforms
Architecture	Image layers, runtime containers and data flow
Quick Start	Minimal steps to run the stack
Compose Runtime	Base Compose file, backend overrides and .env selection
Configuration	Environment variables and runtime configuration
Container Images	Registry images, tags, manifests and branch suffixes
Romexis Admin	Browser-based RomexisConfig/Admin container via noVNC
Romexis Client	Browser-based Romexis Client container via noVNC
mRomexis Web App	Separate Tomcat-based mRomexis Web frontend container
Build System	Payload, base, server, admin and web app build workflow
Local Build Scripts	Local build helper scripts for Linux/macOS and Windows
Database Backends	MSSQL and Firebird backend architecture
Migration Service	Web UI, REST API, SFTP and restore workflow
Migration Workflow	Manual and client-assisted migration process
CI/CD Pipeline	Drone pipeline and publishing process
Developer Guide	Repository structure and internal development notes
Troubleshooting	Common errors and fixes

---

Current Core Components

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/
  Contains the shared PropertyAgent, RomexisOptionPaneUI and RxCr2 patch sources, and DxService compatibility source.

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.

---

Current Runtime Layout

The runtime is split into a base Compose file and backend-specific override files:

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.

The active backend is selected in .env through DATABASE_BACKEND and COMPOSE_FILE.

---

Recommended Reading Order

1. Project Overview
2. Architecture
3. Compose Runtime
4. Quick Start
5. Configuration
6. Romexis Admin
7. Romexis Client
8. mRomexis Web App
9. Database Backends
10. Build System
11. Developer Guide

---

Important Notes

• No Romexis application binaries are committed to the repository.
• Official Planmeca installer packages are downloaded during payload builds.
• Runtime backend selection is controlled through .env and Docker Compose file selection.
• Microsoft SQL Server remains the default and most tested backend.
• Firebird support is available through a dedicated Compose override.
• Romexis Admin is provided through a separate browser/noVNC container.
• mRomexis Web App is provided through a separate Tomcat-based container and requires Romexis 6.5.3 or newer.
• The migration service is designed for moving existing Windows-based Romexis installations into the Docker stack.

Romexis Docker Wiki

English · Deutsch

English

• Home

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

• Build System
• Local Build Scripts
• Payload Images
• Base Image
• Server Image
• CI/CD Pipeline

Database

• Database Backends
• Microsoft SQL Server
• Firebird

Migration

• Migration Service
• Migration Workflow
• Migration Client

Development

• Developer Guide
• Java Property Agent
• Project Structure
• Release Process
• FAQ

Source Documents

• Source README References

Deutsch

• Startseite

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

• Build-System
• Lokale Build-Skripte
• Payload-Images
• Base-Image
• Server-Image
• CI/CD-Pipeline

Datenbank

• Datenbank-Backends
• Microsoft SQL Server
• Firebird

Migration

• Migrationsdienst
• Migrationsworkflow
• Migrationsclient

Entwicklung

• Entwicklerhandbuch
• Java Property Agent
• Projektstruktur
• Release-Prozess
• FAQ

Quelldokumente

• README-Quellreferenzen

---

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