Table of Contents

Quick Start

Deutsch | English

Quick Start

1. Prepare environment

Copy the sample environment file:

cp .env.sample .env

Edit .env and set at least the Romexis version, registry namespace, backend selection and passwords.

Minimal MSSQL example:

REGISTRY=gitea.buchhorster.de/planmeca
ROMEXIS_VERSION=6.5.3.444.203
IMAGE_SUFFIX=

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

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

HOST_IP=192.168.65.100

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

ROMEXIS_DB_NAME=Romexis_db
ROMEXIS_DB_USER=romexis
ROMEXIS_DB_PASSWORD=romexis

SERVER_RMI_LOW_PORT=1100
SERVER_RMI_HIGH_PORT=1120

ROMEXIS_DATA_ROOT=/srv/romexis-data
DATABASE_BACKUP_DIR=/srv/romexis-data/sql-backup

ADMIN_NOVNC_PORT=6080
ADMIN_VNC_PORT=5900
ADMIN_VNC_PASSWORD=promax
ADMIN_RESOLUTION=1280x900x24
ADMIN_LANGUAGE=de
DEBUG_XTERM=false
ADMIN_VNC_LIFECYCLE=true

MROMEXIS_WEB_PORT=8081

MIGRATION_HTTP_PORT=8080
MIGRATION_SFTP_PORT=2222
MIGRATION_API_TOKEN=change-me

For Firebird, change the backend selection:

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

2. Start the selected stack

After .env is configured, the same command is used for MSSQL and Firebird:

docker compose up -d

Show the effective Compose configuration:

docker compose config

3. Show logs

docker compose logs -f romexis

Database backend logs:

docker compose logs -f mssql
# or
docker compose logs -f firebird

Admin container logs:

docker compose logs -f romexis-admin

mRomexis Web App logs:

docker compose logs -f romexis-app

4. Open browser-based services

Romexis Admin / RomexisConfig through noVNC:

http://localhost:6080/vnc.html?host=localhost&port=6080&autoconnect=true

mRomexis Web App through the proxy:

http://localhost:8081

Adjust the ports if ADMIN_NOVNC_PORT or MROMEXIS_WEB_PORT were changed in .env.

5. Recreate after image changes

docker compose up -d --force-recreate

Pull and recreate:

docker compose pull
docker compose up -d --force-recreate

6. Open shells for debugging

Romexis server:

docker compose exec romexis bash

Admin image shell:

docker compose run --rm --entrypoint /bin/bash romexis-admin

mRomexis Web App shell:

docker compose run --rm --entrypoint /bin/bash romexis-app

7. Local image builds

Linux/macOS:

chmod +x scripts/build-local.sh
./scripts/build-local.sh all

Windows PowerShell:

.\scripts\build-local.ps1 -Targets all

Build individual targets:

./scripts/build-local.sh base server
./scripts/build-local.sh admin mromexis
./scripts/build-local.sh migration

8. Stop the stack

docker compose down

Stop and remove volumes:

docker compose down -v

Use volume removal carefully because it deletes persistent database and application data.

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