Clone
1
Quick Start.de
Patrick Gniza edited this page 2026-08-17 10:48:39 +02:00

Deutsch | English

Schnellstart

1. Umgebung vorbereiten

Die Beispiel-Umgebungsdatei kopieren:

cp .env.sample .env

.env bearbeiten und mindestens Romexis-Version, Registry-Namespace, Backend-Auswahl und Passwörter festlegen.

Minimales MSSQL-Beispiel:

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

Für Firebird die Backend-Auswahl ändern:

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

2. Ausgewählten Stack starten

Nach der Konfiguration von .env wird für MSSQL und Firebird derselbe Befehl verwendet:

docker compose up -d

Die wirksame Compose-Konfiguration anzeigen:

docker compose config

3. Protokolle anzeigen

docker compose logs -f romexis

Protokolle des Datenbank-Backends:

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

Protokolle des Admin-Containers:

docker compose logs -f romexis-admin

Protokolle der mRomexis Web App:

docker compose logs -f romexis-app

4. Browserbasierte Dienste öffnen

Romexis Admin / RomexisConfig über noVNC:

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

mRomexis Web App über den Proxy:

http://localhost:8081

Die Ports entsprechend anpassen, wenn ADMIN_NOVNC_PORT oder MROMEXIS_WEB_PORT in .env geändert wurden.


5. Nach Image-Änderungen neu erstellen

docker compose up -d --force-recreate

Abrufen und neu erstellen:

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

6. Shells zum Debuggen öffnen

Romexis-Server:

docker compose exec romexis bash

Shell des Admin-Images:

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

Shell der mRomexis Web App:

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

7. Lokale Image-Builds

Linux/macOS:

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

Windows PowerShell:

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

Einzelne Ziele bauen:

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

8. Stack stoppen

docker compose down

Stoppen und Volumes entfernen:

docker compose down -v

Das Entfernen von Volumes mit Vorsicht verwenden, weil dadurch persistente Datenbank- und Anwendungsdaten gelöscht werden.