This guide provides instructions for deploying the VertiGIS DXFExport backend API using Docker containers in an on-premises environment. The deployment process involves setting up Docker and PostgreSQL, then deploying the application as containers on either Ubuntu Linux or Windows systems.

Technology Stack

Prerequisites and Assumptions

•Operating System Requirements: Ubuntu 22.04.2 LTS

•User account with sudo privileges is required

•Software requirements

oDocker:

▪Must be installed on the server

▪Docker service must be enabled and running

oDatabase:

▪PostgreSQL should be installed and configured on the server

oNetwork configuration:

▪Server IP address should be static and ideally bound to the MAC address

▪Both server and network firewalls must allow inbound and outbound traffic on application ports:

•Port 5000

•Port 5001

Deployment Setup

Step 1: Download Deployment Script

Download the deployment script from the VertiGIS SharePoint location:

Script Name: dxfexport_linux.sh

Step 2: Grant Executable Permissions

sudo chmod +x <filename>

Step 3: Prepare Required Information

Keep the following details ready before running the script:

•Database host

•Database user

•Database password

•Database name

•ACR (Azure Container Registry) user

•ACR password

•Application ports

Step 4: Execute Deployment Script

./<filename>

Success Indicators

The deployment is successful when:

•Container status shows as "Up" and healthy

•Health checks pass successfully

•Application endpoints are accessible on configured ports (5000 and 5001)

•No error messages appear in container logs

 

Refer to the screenshot below to verify the output:

 

Configure DXF API Service URL for VertiGIS Network Editor / Explorer

Either the VertiGIS Network Tools Editor or Explorer must be configured with the URL of the DXF Export API service. This can be done after installing the tools by using the VertiGIS Studio Web Designer.

To connect your VertiGIS Network Editor/Explorer to the DXF Export API service:

1.Open VertiGIS Studio Web Designer and load your VertiGIS Network Editor or Explorer application.

2.Select the Services tab.

3.Select DXF Export Navigation Service.

4.Enter the DXF Export API Service URL in the DXF Service URL field. Press Enter or Tab to confirm.

5.Save the application to apply the changes.