MySQL legacy support

Note: MySQL is legacy and support will be limited going forward..

The MySQL database running in the Docker container has been decommissioned.

This guide explains how to point the iTDS to use an external MySQL instance.

The iTDS MySQL legacy support follows these high-level steps:

• Step 1: Create a backup of the existing iTDS
• Step 2: Create your database
• Step 3: Update the existing iTDS
• Step 4: Activate server
• Step 5: Restore the backup on the new iTDS

Step 1: Create a backup of the existing iTDS

Always create a backup before updating your iTDS. 

The iTDS includes the functionality to create a full backup of the server.

The backup will include all server information, including paired configs uploaded to the server.

To access the backup menu, open the iTDS admin interface (https://:/itds/backup).

Step 2: Create your database

The iTDS now relies on an external MySQL database instance and you will need to create your own database. Please name the database itds as this is what the iTDS expects.

Step 3: Update the existing iTDS

Login to Docker registry

Log in to our Docker registry with the credentials from your iTDS delivery email: 

docker login registry.paterva.com

Stop your iTDS:

docker compose –f itds.yml down

Run the MySQL migration helper

Create a file named docker-compose.itds-mysql.yml in the same directory as your main iTDS docker compose file, with the following content:

Please populate the following environment variables to connect to the your own managed MySQL instance.

DB_HOST: "<DB_HOST>" # The hostname of your database server. 
DB_USER: "<DB_USER>" # The username used to connect to the database.
DB_PORT: "<DB_PORT>" # The database port number.
DB_PASS: "<DB_PASS>" # The password used to connect to the database.

Pull the new docker images

docker compose –f docker-compose.itds-mysql.yml pull

Start your updated iTDS:

docker compose -f docker-compose.itds-mysql.yml up -d

Step 4: Activate server

Navigating to https://{server_name / IP (IPv4 or IPv6) }:8000/itds/activate will display a UI for activating your server. 

From the activation page under the Upload License Certificate section, click the Choose File button and browse to select your license certificate (.pfx file). Click Submit in order to activate your server. 

Step 5: Restore the backup on the new iTDS

With the backup file created on the old server, we now want to import the backup onto our new server.

On the new server, navigate to the Backup and Restore page in the admin interface (https://:/itds/backup).

Under the Restore Backup heading, select the file that was exported from the old server.

With the file selected, click Restore Backup to restore the information from your old server onto your new server.