Skip to main content

On-Premise Setup

Prerequisites​

Public IP Address​

Make sure to have a dedicated public IP Address.

Check Public IP Address

You can using SQL Connect Detector to check whether public IP is enabled by your ISP.

Make sure the last requirement Port Forward? is in Green

Hints

If the result is Red, kindly call your internet service provider and request for dedicated Public IP.

If the provider requests a reason, you can explain that you intend to host a server and therefore need to set up port forwarding.

Setup​

Step 1 - Install SQL API Service​

  1. On Logon Screen > Click ⚙️

    logon screen setting

  2. Right-Click on company database > Select Configure API Service...

    configure mobile connect

  3. Click on Install to install API service

    install mobile connect

Step 2 - Start Service​

After the installation, start the service. Once successful, Service is running status will show on screen.

service running

Step 3 - Port Forwarding​

Next, we will need to do Port Forwarding.

Port Forwarding Information

You can Click on Show Tips to find all the information for port forwarding configuration.

show tips

  1. Access Router Setting: Login to the router's administration interface on web browser.

    You can Click on Show Tips > Gateway IP Address, to access login page of the router.

    warning

    If you are using a firewall or serving the router's web administration interface via a different IP address, this might not work.

    router gateway

  2. Navigate to Port Forwarding Section: Find Port Forwarding, Virtual Service or similar section in the router's setting.

  3. Add New Rule: Create a new port forwarding rule. (All information can get from Port Forwarding Information)

    • Service Name: Enter a description name (SQL Account API Service)
    • External/Public Port: Specify the port number to use for external access (443)
    • Internal IP Address: Enter the IP address of the device to forward to (E.g. 192.168.0.238)
    • Internal/Private Port: Specify the port number the service is listening on within the internal network (443)

  4. Save the Rule: Save the new port forwarding rule.

  5. Verify: Click on Test Connection to test SQL Account API Service status. When ✅ OK status is shown, it means the service is setup successfully.

    alt text

Examples of Port Forward​

Can refer to Sample of port forward setup on different router