TDM Installation
The installation process is provided separately for Linux and Windows. Select the appropriate section based on your operating system and follow the steps.
TDM Installation for Linux¶
Extracting Packages¶
You will receive a .tar.gz package (e.g., tdm-standalone-26.2.0.tar.gz). Follow the steps below to extract it:
mkdir tdm-standalone
tar -xvzf tdm-standalone-26.2.0.tar.gz -C tdm-standalone
This will create a folder named tdm-standalone containing multiple files and subfolders. The exact folder structure may vary depending on the setup. The extraction process may take approximately 5–10 minutes.
Loading Docker Images¶
Inside the packages folder, you will find .tar and .tar.gz files. These compressed Docker images are created using the docker save command, with compression reducing the package size by over 70%.
To load the Docker images:
1. Run the following script to import all images:
./config.sh load_images
2. After successful execution, you will see a confirmation message:
“All Docker images have been loaded successfully!”
3. Verify the imported images using:
docker image ls
Note
If you only need to import a single image, you can use the following command:
docker load -i package-name
Init Configuration¶
Ensure that the config.sh file exists in the same directory as the docker-compose file. This script is used to configure TDM.
- The script creates a backup of the
docker-composefile each time it runs. - Previous versions can be found in the
backupfolder and restored if needed. - Configuration is handled automatically by the script.
If advanced configuration is required, you can manually edit the docker-compose file using tools such as Vim or Nano.
Hostname Configuration¶
Since TDM is a client-side application, hostname parameters must be configured for each service.
Run the following command and follow the prompts:
./config.sh set_hostname
After configuring hostname parameters, press y to update the docker-compose.yml file.
Provide the appropriate hostname (an IP address for a VM or DNS). The application will be configured to use this hostname, allowing client access.
Note
Since TLS 1.0 support has been discontinued, the hostname (IP address / DNS) must use HTTPS.
Example: https://192.168.x.x
Database Credentials¶
TDM is a containerized application that allows extensive configuration through various parameters. As part of our security measures, we require the use of encrypted passwords for sensitive data, such as database credentials.
To securely configure the database credentials, you must first encrypt the database password. A provided script automates this process by encrypting the specified username and password, and then setting the necessary configuration values. The TDM application will automatically decrypt these values during runtime.
./config.sh set_dbcreds
TDM Installation for Windows¶
Prerequisites¶
- 7zip
- Text Editor (Notepad++ recommended)
Extracting Packages¶
You will receive a .tar.gz package (e.g., tdm-26.2.0.tar.gz).
Open Windows PowerShell and follow these steps:
- Create a folder:
mkdir tdm-standalone
tar –xvzf tdm-standalone-26.2.0.tar.gz -C path/to/your/tdm-standalone
This will create a folder named tdm-standalone containing multiple files and subfolders. The exact folder structure may vary depending on the setup. An example extraction process may take 2–5 minutes.
Important
If you using Hyper-V backed Docker, you must add this path/to/your/tdm-standalone to Docker File Sharing settings. Follow these steps:
1. Open Docker Desktop.
2. Click on Settings in the upper-left corner.
3. Navigate to File Sharing under the Resources tab.
4. Add your directory path to the list provided.
Loading Docker Images¶
Inside the packages folder, you will find .tar and .tar.gz files. These compressed Docker images are created using the docker save command, with compression reducing the package size by over 70%.
To load the Docker images:
1. Run the following script to import all images:
./config.ps1
2. Enter load_images to the FunctionName field.
3. After successful execution, you will see a confirmation message:
“All Docker images have been loaded successfully!”
4. Verify the imported images using:
docker image ls
Note
Docker Desktop can also be used to verify that the required images have been loaded successfully.
Init Configuration¶
Please check if the config.ps1 file exists in the same folder as the docker-compose file. This script will help you configure the TDM application.
The config.ps1 script creates a backup of the docker-compose file with each run. You can find previous versions of the compose file in the backup folder and restore them if needed.
The script automatically configures the compose file, but if you need advanced configurations, you can manually update the variables without using config.ps1. You can use text editors like Notepad to modify the docker-compose file.
Hostname Configuration¶
Since TDM is a client-side application, hostname parameters must be configured for each service. A script is provided to simplify this process:
Run the following command and follow the prompts:
./config.ps1
Enter set_hostname to the FunctionName field.
After configuring hostname parameters, press y to update the docker-compose.yml file.
Provide the appropriate hostname (an IP address for a VM or DNS). The application will be configured to use this hostname, allowing client access.
Note
Since TLS 1.0 support has been discontinued, the hostname (IP address / DNS) must use HTTPS.
Example: https://192.168.x.x
Database Credentials¶
TDM is a containerized application that allows extensive configuration through various parameters. As part of our security measures, we require the use of encrypted passwords for sensitive data, such as database credentials.
To securely configure the database credentials, you must first encrypt the database password. A provided script automates this process by encrypting the specified username and password, and then setting the necessary configuration values. The TDM application will automatically decrypt these values during runtime.
./config.ps1
Enter set_dbcreds to the FunctionName field.