Overview
This page outlines the solution deployment within Docker describes how to install Docker and use images from Docker Hub to generate containers. It specifies the system requirements, including the installation of Docker installation. The configuration setup procedure involves copying necessary runtime files and subfolders to Docker's temporary folder, managing license and argument files for project configuration, and creating a Dockerfile based on a .NET Framework image. Instructions for building and running the Docker image, with considerations for memory, CPU cores, and port settings for external access, are provided. The document is technical, targeting users familiar with Docker.
On this page:
using a Docker image to create a Linux container that will include the files needed to run FrameworX. The document is technical, targeting users familiar with Docker.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Steps to Install Docker:
This is the procedure to install the Docker tools in a Windows computer.
1- Access the download link: Visit the Docker for Windows installation page.
2- Download: On the website, select the Docker Desktop for Windows (x86_64) option to download the latest version of Docker.
3 - Installation: After downloading, run the Docker Desktop Installer.exe file.
4 - Settings during installation:
- During the installation process, you'll see a configuration screen.
- Make sure to either check or uncheck the Use WSL 2 instead of Hyper-V option, depending on your preference:
- WSL 2 (Windows Subsystem for Linux): This is the recommended option as it provides better performance and compatibility.
- Hyper-V: If you prefer to use Hyper-V (for example, if you're already using it for other VMs), uncheck this option.
5 - Finish the installation: Complete the installation by following the on-screen instructions.
6 - Open Docker Desktop: After installation, open Docker Desktop from the Start Menu.
7 - Verify it’s working: When Docker Desktop opens for the first time, it will start automatically. You'll see a Docker icon in the system tray (next to the clock).
- To verify if Docker is installed correctly, open PowerShell or Command Prompt and run the following command: docker --version
Additional Considerations:
1 - Make sure your machine has virtualization enabled in the BIOS/UEFI (required for both WSL 2 and Hyper-V).
2 - You can install WSL 2 directly via PowerShell with the following command if it's not yet configured: wsl --install
Steps to pull an image from Docker Hub
Docker images are lightweight, standalone and executable software packages that include everything needed to run an application: code, runtime,libraries and system tools. They are used to create containers, which allow users to run applications consistently across different environments.
Step 1 - Access the Docker Hub to view the Docker images available
Step 2 - Open the Command Prompt and type the following code:
| Code Block |
|---|
docker pull tatsoftdockerhub/<docker_image_name>:latest |
Step 3 - Create a container from the Docker image:
| Code Block |
|---|
docker run --name <container_name> -p 3101:3101 -p 10108:10108 tatsoftdockerhub/<docker_image_name> |
Step 4 - Copy the RemoteServerService.config file from the container
| Code Block |
|---|
docker cp <container_name>:/Documents/Program/MachineSettings/RemoteLicenseService.config C:\<windows_path> |
Step 5 - Edit the RemoteLicenseService.config file
The syntax is: RemoteServer=<IpAddress>:<PortNumber>
The port should point to the same port as your WebServices (TWebServices) running on the Server computer.
| Code Block |
|---|
docker cp <container_name>:/Documents/Program/MachineSettings/RemoteLicenseService.config C:\<windows_path> |
Step 6 - Replace the RemoteLicenseService.config file you previously edited
| Code Block |
|---|
docker cp C:\<file_path> <container_name>:/Documents/Program/MachineSettings/RemoteLicenseService.config |
Step 7 - Verifying the Docker IP address
Open the Command Prompt and type the following code:
| Code Block |
|---|
ipconfig |
Once you've done that, copy the IPv4 address from the Ethernet adapter "vEthernet (WSL)."
Step 8 - Configuring the Remote Server
Open FrameworX, then go to the "Server Information" section in the top-left corner of the screen. Edit the "Remote Server" by entering your Docker IP address and the port where TWebService is running. The syntax is: http://172.28.1.1:10108/
Click "Connect" and wait a few seconds.
Step 9 - Upload a Multi-platform Solution and install the features that you will use in the Solution.
After a few minutes, you will be able to edit your Solution and run it using the features you have installed.
Running the Image
To run the image, execute the following command in Command Prompt (CMD):
| Code Block |
|---|
docker run --memory=4096m --cpus=4 -p 3101:3101 fx (Min Recommended 4 GB Memory and 4 CPU cores) |
Or just specifying the port: docker run -p 3101:3101 fx
If you want to name the container:
docker run --name <container_name> -p 3101:3101 fx
TRichClient Configuration
After running the container, go to fx-10 and create a shortcut for TRichClient.exe. Right-click on the TRichClient shortcut → Properties. In the target field, type your IP and the port where the solution is running in the container.
| Code Block |
|---|
"Path of TRichClient.exe" /ip1:<YOUR_IP> /port1:<PORT> |
To find your IP, open Command Prompt (CMD) and type ipconfig. Copy the IPv4 address from the Ethernet adapter vEthernet (WSL).
Once this is done, click Apply and close the Properties window. Then, click on the TRichClient Shortcut and wait for the solution to open.
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|