Table of Contents

Configuration

MSSQL
Firebird

Microsoft SQL Server Settings
Firebird Settings
RMI Ports
Romexis Admin Settings
mRomexis Web App Settings
Migration Service Settings
Database Initialization Version Limit
Property Agent

Deutsch | English

Configuration

Configuration is mostly handled through environment variables in .env and Docker Compose.

Core Variables

Variable	Description
`REGISTRY`	Container registry namespace
`ROMEXIS_VERSION`	Romexis version to run
`IMAGE_SUFFIX`	Optional branch-specific image suffix
`DATABASE_BACKEND`	Selected backend, usually `mssql` or `firebird`
`COMPOSE_FILE`	Compose file chain based on selected backend
`HOST_IP`	Host IP address exposed to Romexis clients
`ROMEXIS_DATA_ROOT`	Root directory for persistent Romexis data

Example:

REGISTRY=gitea.buchhorster.de/planmeca
ROMEXIS_VERSION=6.5.3.444.203
IMAGE_SUFFIX=
DATABASE_BACKEND=mssql
COMPOSE_PATH_SEPARATOR=:
COMPOSE_FILE=docker-compose.yml:docker-compose.${DATABASE_BACKEND}.yml
HOST_IP=192.168.65.177
ROMEXIS_DATA_ROOT=/srv/romexis-data

Image Name Variables

ROMEXIS_IMAGE=romexis-server
MIGRATION_IMAGE=romexis-migration-service
ADMINISTRATION_IMAGE=romexis-admin
MROMEXIS_WEBAPP_IMAGE=romexis-mromexis-app

These are combined with REGISTRY, ROMEXIS_VERSION and IMAGE_SUFFIX by the Compose files.

Database Backend Selection

Backend selection is controlled by Compose file selection, not only by SERVER_DB.

MSSQL

DATABASE_BACKEND=mssql
COMPOSE_PATH_SEPARATOR=:
COMPOSE_FILE=docker-compose.yml:docker-compose.${DATABASE_BACKEND}.yml

The MSSQL override then sets the Romexis backend values, for example:

SERVER_DB=5
MSSQL_HOST=mssql

Firebird

DATABASE_BACKEND=firebird
COMPOSE_PATH_SEPARATOR=:
COMPOSE_FILE=docker-compose.yml:docker-compose.${DATABASE_BACKEND}.yml

The Firebird override then sets the Romexis backend values, for example:

SERVER_DB=4
FIREBIRD_HOST=firebird

Microsoft SQL Server Settings

MSSQL_PORT=1433
MSSQL_SA_PASSWORD=Pwr0mex!s!!!
MSSQL_PID=Express

ROMEXIS_DB_NAME=Romexis_db
ROMEXIS_DB_USER=romexis
ROMEXIS_DB_PASSWORD=romexis

Generated JDBC URL:

jdbc:sqlserver://mssql:1433;databaseName=Romexis_db;encrypt=true;trustServerCertificate=true;

Firebird Settings

FIREBIRD_PORT=3050
FIREBIRD_USER=sysdba
FIREBIRD_PASSWORD=pwr0mex!
FIREBIRD_DB_PATH=/firebird/data/romexis.fdb

Generated JDBC URL:

jdbc:firebirdsql://firebird:3050//firebird/data/romexis.fdb

For Romexis authentication:

ROMEXIS_DB_USER=sysdba
ROMEXIS_DB_PASSWORD=pwr0mex!

RMI Ports

SERVER_RMI_LOW_PORT=1100
SERVER_RMI_HIGH_PORT=1120

These ports must be reachable from Romexis clients.

Romexis Admin Settings

ADMIN_NOVNC_PORT=6080
ADMIN_VNC_PORT=5900
ADMIN_VNC_PASSWORD=promax
ADMIN_RESOLUTION=1280x900x24
ADMIN_JAVA_OPTS=-Xms256m -Xmx1024m
ADMIN_LANGUAGE=de
DEBUG_XTERM=false
ADMIN_VNC_LIFECYCLE=true
ENABLE_PROPERTY_AGENT=true

Important behavior:

ADMIN_LANGUAGE is used for the splash screen and as the language= parameter for RomexisConfig.
DEBUG_XTERM=true starts an optional debug terminal inside the noVNC session.
ADMIN_VNC_LIFECYCLE=true starts RomexisConfig on first VNC/noVNC connect and stops it after the last disconnect.
The Admin container uses Openbox and xcompmgr as required runtime components.

mRomexis Web App Settings

MROMEXIS_WEB_PORT=8081

The mRomexis Web App container is exposed through the proxy service. The backend proxy target is rewritten internally to the Romexis server service.

Migration Service Settings

MIGRATION_HTTP_PORT=8080
MIGRATION_SFTP_PORT=2222
MIGRATION_API_TOKEN=change-me
DATABASE_BACKUP_DIR=/srv/romexis-data/sql-backup

DATABASE_BACKUP_DIR is shared between the migration service and the database backend for database restore workflows.

Database Initialization Version Limit

The database initializer derives the schema target from:

/opt/romexis/version

Example:

6.5.3.444.203 -> 653

To force initialization only up to a maximum schema marker:

ROMEXIS_DB_MAX_VERSION=653

If the container Romexis version is newer than the configured max, the script prints a warning and initializes only up to the configured marker.

Property Agent

The Java Property Agent can set Romexis RxProperties from environment variables.

Syntax:

PROPERTY_AGENT_SET_<RXPROPERTY_NAME>=<value>

The server uses the agent for runtime properties and the RxCr2 replacement. Admin enables the agent by default for its service-INI integration and the Java 17 RomexisOptionPaneUI null guard. The Client loads the same GUI-runtime agent, disables RxCr2 and enables the OptionPane patch by default.

ROMEXIS_AGENT_RXCR2_PATCH=true
ROMEXIS_AGENT_OPTIONPANE_PATCH=true

Romexis Docker Wiki

English · Deutsch

English

Home

Getting Started

Runtime Services

Build System

Database

Migration

Development

Source Documents

Source README References

Deutsch

Startseite

Erste Schritte

Runtime-Dienste

Build-System

Datenbank

Migration

Entwicklung

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