Migration Workflow

This page describes the target migration workflow from an existing Romexis server into the Docker-based Romexis stack.

Source System

The source system is usually a Windows-based Romexis server.

Required data:

SQL Server database backup (.bak)
Romexis image directory
Romexis ergo data directory
optional Romexis cache directory

The cache directory is optional because it can usually be regenerated.

Target System

The target system runs:

Romexis Server container
Database backend container
Migration Service container
Persistent data volumes

Workflow Overview

Existing Romexis Server
        |
        | database backup
        | image data
        | ergo data
        v
Romexis Migration Service
        |
        | validation
        | database restore
        | data restore
        v
Docker-based Romexis Server

Manual Workflow

Open the migration Web UI.
Create a new migration job.
Upload the database backup in the browser.
Let the service create manifest.json.
Trigger database restore.
Upload images and ergo data via SFTP.
Mark upload complete.
Validate uploaded data.
Run restore.
Complete migration.
SFTP credentials are removed or disabled.

Client-Assisted Workflow

The migration client is intended to automate most source-side steps:

detect Romexis installation
detect database configuration
detect data directories
create or use a migration job
create database backup
upload data through rclone/SFTP
call API endpoints to advance the workflow
show logs and restore status

Expected Upload Layout

/upload/
├── meta/
│   └── manifest.json
├── database/
│   └── Romexis_db.bak
├── romexis_images/
├── romexis_ergodata/
└── romexis_cache/

Manifest

The manifest describes the uploaded migration data.

Example:

{
  "migration_id": "example",
  "name": "Example Migration",
  "source_host": "old-romexis-server",
  "database": {
    "backup": "database/Romexis_db.bak"
  },
  "romexis_images": true,
  "romexis_ergodata": true,
  "romexis_cache": false
}