Upgrade to MetaDefender ICAP Server older than v5.2.0 (Sqlite) to version 5.2.0 -> v5.6.0 (PostgreSQL)

1.Database Migration

1.1.Wizard Installation

After 1.2.Setup database server for local database mode or 1.3.Create an unique instance name for that MetaDefender ICAP Server for shared database mode, if the host has already installed older version of MD ICAP Server (older than v5.2.0) then the migration wizard will be displayed

1.2. Command Line Installation

1.2.1. Without ignition file

The installation will ask to input the option migrate all database or skip ICAP history via console if detect the older ICAP server version has already installed

• hit enter to select default option [false]: migrate all database
• input false: migrate all database
• input true: Only migrate workflow, rules and setting (do not migrate ICAP history)

Running transaction test

Transaction test succeeded

Running transaction

​

​

***********

​

*The upgrade process may take a long time depending on the size of the database.

*In case you find the processing history not essential, you can skip upgrading these data to speed up the upgrade process.

*  Input true to migrate workflow rules and settings (security, network, data retention).

*  Input false to migrate all database.

[false]

1.2.2. With Ignition file

If skip_migrate_processing_history does not input in the ignition file, all database will be migrated

+ Only migrate workflow, rules and setting (do not migrate ICAP history)

[global]

dbmode=1

​

[internal]

skip_migrate_processing_history=true

​

[dbserver] 

type=local 

host=localhost 

port=5433 

user=postgres 

password=non_Unicode_password

+ Migrate all database

set skip_migrate_processing_history to false or remove internal field out of ignition file

[global]

dbmode=1

​

[internal]

skip_migrate_processing_history=false

​

[dbserver] 

type=local 

host=localhost 

port=5433 

user=postgres 

password=non_Unicode_password

2.Database Migration

During migration process, the UI will display the migration status

3.Recommendation for migration

We suggest select Only migrate workflow, rules and setting (do not migrate ICAP history) then the migration process will take short time

After migration, MD ICAP Server 5.2.0 will back to work then the ICAP history can be migrated in background via mdicapsrv-migrate-db tool

• Windows:

#open cmd as administrator

​

#cd to installation folder path

cd C:\Program Files\OPSWAT\Metadefender ICAP Server>

​

#execute command

mdicapsrv-migrate-db.exe IcapHistory -a

• Linux:

sudo  LD_LIBRARY_PATH=/usr/lib/mdicapsrv /usr/sbin/mdicapsrv-migrate-db IcapHistory -a

4. Backup and rollback steps if upgrade failure

Backup steps: Before upgrade, below data and configurations should be backup for recovery purpose

Even during upgrade, the upgrade process will backup the old data automatically, but We need backup manually to avoid an expected behavior:

Step 1: backup the configuration:

• Windows:

  • the registry at path [HKEY_ LOCAL_MACHINE\SOFTWARE\OPSWAT\ICAP Server]
  • (in case enable the TLS): all file *.conf in C:\Program Files\OPSWAT\Metadefender ICAP Server\nginx

• Linux:

  • the config file at path /etc/mdicapsrv/mdicapsrv.conf
  • (in case TLS enable): all file *.conf at path /etc/mdicapsrv/nginx.d/

Step 2: backup the data

• Windows: all install folder (default: C:\Program Files\OPSWAT\Metadefender ICAP Server\data)
• Linux: all data in /var/lib/mdicapsrv/

Restore old version steps:

The steps will be applied incase upgrade failure and want to restore to previous version

Step 1: Uninstall MD ICAP Server and delete all data in installation path

Step 2: delete all configuration:

• Windows: registry setting at path [HKEY_LOCAL_MACHINE\SOFTWARE\OPSWAT\ICAP Server]
• Linux: delete /etc/mdicapsrv/mdicapsrv.conf

Step 3: Install previous ICAP version and stop the service

Step 4: restore config:

• Windows:

  • the registry which was backup at previous steps
  • In case TLS enable: restore NGINX config (*.conf)

• Linux:

  • replace the config file /etc/mdicapsrv/mdicapsrv.conf by the file which was backup
  • In case TLS enable: restore NGINX config (*.conf)

Step 5: restore data:

• Windows: restore the backup data to install folder (default: C:\Program Files\OPSWAT\Metadefender ICAP Server\data)
• Linux: In case TLS enable: restore NGINX config (*.conf)

Step 6: start the mdicap server service