From 4f0f60b3d6c6f73bb7cdaf43fca35f84ce34fc68 Mon Sep 17 00:00:00 2001
From: Patrick Gniza <pgniza@gmx.de>
Date: Sun, 28 Jun 2026 19:45:36 +0000
Subject: [PATCH] =?UTF-8?q?Configuration=20hinzugef=C3=BCgt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Configuration.md | 141 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 141 insertions(+)
 create mode 100644 Configuration.md

diff --git a/Configuration.md b/Configuration.md
new file mode 100644
index 0000000..f02c74e
--- /dev/null
+++ b/Configuration.md
@@ -0,0 +1,141 @@
+# Configuration
+
+Configuration is mostly handled through environment variables in `.env` and Docker Compose.
+
+---
+
+## Core Variables
+
+| Variable | Description |
+|---|---|
+| `ROMEXIS_VERSION` | Romexis version to run |
+| `TARGETARCH` | Target architecture suffix, e.g. `amd64` or `arm64` |
+| `REGISTRY` | Container registry namespace |
+| `ROMEXIS_IMAGE` | Romexis Server image name |
+| `HOST_IP` | Host IP address exposed to Romexis clients |
+| `ROMEXIS_DATA_ROOT` | Root directory for persistent Romexis data |
+
+Example:
+
+```env
+ROMEXIS_VERSION=6.5.3.444.203
+TARGETARCH=amd64
+REGISTRY=gitea.buchhorster.de/patrick
+ROMEXIS_IMAGE=romexis-server
+HOST_IP=192.168.65.177
+ROMEXIS_DATA_ROOT=/srv/romexis-data
+```
+
+---
+
+## Database Backend Selection
+
+Romexis uses `SERVER_DB` to identify the database backend.
+
+| Value | Backend |
+|---|---|
+| `5` | Microsoft SQL Server |
+| `4` | Firebird |
+
+```env
+SERVER_DB=5
+```
+
+or:
+
+```env
+SERVER_DB=4
+```
+
+---
+
+## Microsoft SQL Server Settings
+
+```env
+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:
+
+```text
+jdbc:sqlserver://mssql:1433;databaseName=Romexis_db;encrypt=true;trustServerCertificate=true;
+```
+
+---
+
+## Firebird Settings
+
+```env
+SERVER_DB=4
+FIREBIRD_PORT=3050
+FIREBIRD_USER=sysdba
+FIREBIRD_PASSWORD=pwr0mex!
+FIREBIRD_DB_PATH=/firebird/data/romexis.fdb
+```
+
+Generated JDBC URL:
+
+```text
+jdbc:firebirdsql://firebird:3050//firebird/data/romexis.fdb
+```
+
+For Romexis authentication:
+
+```env
+ROMEXIS_DB_USER=sysdba
+ROMEXIS_DB_PASSWORD=pwr0mex!
+```
+
+---
+
+## Database Initialization Version Limit
+
+The database initializer derives the schema target from:
+
+```text
+/opt/romexis/version
+```
+
+Example:
+
+```text
+6.5.3.444.203 -> 653
+```
+
+To force initialization only up to a maximum schema marker:
+
+```env
+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.
+
+---
+
+## RMI Ports
+
+```env
+SERVER_RMI_LOW_PORT=1100
+SERVER_RMI_HIGH_PORT=1120
+```
+
+These ports must be reachable from Romexis clients.
+
+---
+
+## Migration Service Settings
+
+```env
+MIGRATION_HTTP_PORT=8080
+MIGRATION_SFTP_PORT=2222
+MIGRATION_API_TOKEN=change-me
+DATABASE_BACKUP_DIR=/srv/mssql-backup
+```
+
+`DATABASE_BACKUP_DIR` is shared between the migration service and the database backend for database restore workflows.