|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +id: on-premise-setup |
| 4 | +title: On-Premise Setup |
| 5 | +description: A guide to setup sql mobile connect on-premise |
| 6 | +slug: /sql-account-api/on-premise-setup |
| 7 | +tags: ["SQL Account", "SQL Account API", "On-Premise Setup"] |
| 8 | +--- |
| 9 | + |
| 10 | +## Prerequisites |
| 11 | + |
| 12 | +- `SQL Account` **version 5.2025.1038.875** or above |
| 13 | +- Fix server IP address (either DHCP Reservation or Static) |
| 14 | +- [Public IP Address](#public-ip-address) |
| 15 | +- [Port Forwarding](#step-3---port-forwarding) |
| 16 | + |
| 17 | +## Public IP Address |
| 18 | + |
| 19 | +Make sure to have a **dedicated public IP Address**. |
| 20 | + |
| 21 | +:::info[Check Public IP Address] |
| 22 | +You can using [SQL Connect Detector](https://connect.sql.com.my/document/private-cloud/requirements/sql-connect-detector#download) to check whether public IP is enabled by your ISP. |
| 23 | + |
| 24 | +Make sure the last requirement **Port Forward?** is in <text style={{color: "#43a047"}}>**Green**</text> |
| 25 | +::: |
| 26 | + |
| 27 | +:::tip[Hints] |
| 28 | +If the result is <text style={{color:"#f44336"}}>**Red**</text>, kindly call your internet service provider and request for dedicated Public IP. |
| 29 | + |
| 30 | +If the provider requests a reason, you can explain that you intend to host a server and therefore need to set up port forwarding. |
| 31 | +::: |
| 32 | + |
| 33 | +## Setup |
| 34 | + |
| 35 | +### Step 1 - Install SQL API Service |
| 36 | + |
| 37 | +1. On `Logon Screen` > **Click** `⚙️` |
| 38 | + |
| 39 | +  |
| 40 | + |
| 41 | +2. **Right-Click** on company database > **Select** `Configure API Service...` |
| 42 | + |
| 43 | +  |
| 44 | + |
| 45 | +3. **Click** on `Install` to install API service |
| 46 | + |
| 47 | +  |
| 48 | + |
| 49 | +### Step 2 - Start Service |
| 50 | + |
| 51 | +After the installation, start the service. Once successful, `Service is running` status will show on screen. |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +### Step 3 - Port Forwarding |
| 56 | + |
| 57 | +Next, we will need to do `Port Forwarding`. |
| 58 | + |
| 59 | +:::info[Port Forwarding Information] |
| 60 | +You can **Click** on `Show Tips` to find all the information for port forwarding configuration. |
| 61 | + |
| 62 | + |
| 63 | +::: |
| 64 | + |
| 65 | +1. **Access Router Setting**: Login to the router's administration interface on web browser. |
| 66 | + |
| 67 | + You can **Click** on `Show Tips` > `Gateway IP Address`, to access login page of the router. |
| 68 | + |
| 69 | + :::warning |
| 70 | + If you are using a firewall or serving the router's web administration interface via a different IP address, this might not work. |
| 71 | + ::: |
| 72 | + |
| 73 | +  |
| 74 | + |
| 75 | +2. **Navigate to Port Forwarding Section**: Find `Port Forwarding`, `Virtual Service` or similar section in the router's setting. |
| 76 | + |
| 77 | +3. **Add New Rule**: Create a new port forwarding rule. (All information can get from [Port Forwarding Information](#step-3---port-forwarding)) |
| 78 | + |
| 79 | + - `Service Name`: Enter a description name (**SQL Account API Service**) |
| 80 | + - `External/Public Port`: Specify the port number to use for external access (**443**) |
| 81 | + - `Internal IP Address`: Enter the IP address of the device to forward to (**E.g. 192.168.0.238**) |
| 82 | + - `Internal/Private Port`: Specify the port number the service is listening on within the internal network (**443**) |
| 83 | + |
| 84 | +4. **Save the Rule**: Save the new port forwarding rule. |
| 85 | + |
| 86 | +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. |
| 87 | + |
| 88 | +  |
| 89 | + |
| 90 | +### Examples of Port Forward |
| 91 | + |
| 92 | +Can refer to [Sample of port forward setup](../sql-mobile-connect/on-premise-setup#examples-of-port-forward) on different router |
0 commit comments