Skip to content

Commit 4fdb49e

Browse files
committed
refactor: add general router port forward config guide for on prem mobile connect
1 parent 0de79cb commit 4fdb49e

File tree

7 files changed

+108
-34
lines changed

7 files changed

+108
-34
lines changed

docs/integration/sql-mobile-connect/on-premise-setup.md

Lines changed: 108 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,94 +7,168 @@ slug: /sql-mobile-connect/on-premise-setup
77
tags: ["SQL Account", "SQL Mobile Connect", "On-Premise Setup"]
88
---
99

10-
## Prerequisite
10+
## Prerequisites
1111

1212
- `SQL Account` **version 5.2025.1027.869** or above
13+
- Fix server IP address (either DHCP Reservation or Static)
1314
- [Public IP Address](#public-ip-address)
1415
- [Port Forwarding](#step-3---port-forwarding)
1516

1617
## Public IP Address
1718

18-
Make sure public IP Address is enabled by your ISP (Internet Service Provider)
19+
Make sure to have a **dedicated public IP Address**.
1920

2021
:::info[Check Public IP Address]
2122
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.
2223

23-
Make sure the last requirement **Port Forward?** is `Green`
24+
Make sure the last requirement **Port Forward?** is in <text style={{color: "#43a047"}}>**Green**</text>
2425
:::
2526

26-
## SQL Mobile Connect (On Premise) Setup
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
2734

2835
### Step 1 - Install Service
2936

3037
1. On `Logon Screen` > **Click** `⚙️`
3138

32-
![logon screen setting](../../../static/img/sql-mobile-connect/on-premise-setup/1.png)
39+
![logon screen setting](../../../static/img/sql-mobile-connect/on-premise-setup/1.png)
3340

34-
2. **Right-Click** on company `database` > **Select** `Configure Mobile Connect...`
41+
2. **Right-Click** on company database > **Select** `Configure Mobile Connect...`
3542

36-
![configure mobile connect](../../../static/img/sql-mobile-connect/on-premise-setup/2.png)
43+
![configure mobile connect](../../../static/img/sql-mobile-connect/on-premise-setup/2.png)
3744

3845
3. **Click** on `Install` to install mobile connect service
3946

40-
![install mobile connect](../../../static/img/sql-mobile-connect/on-premise-setup/3.png)
47+
:::success[Host Name]
48+
A default host name will be filled in. However, if you would like to use a custom host name, you may edit the default. Note that changing hostname is only available during the initial setup. (Host name should have **at least 8 characters**)
49+
:::
4150

42-
:::success[Host Name]
43-
A default company's `Host` name will suggested, but you can change to any host name you like for first time setup. (Min host name length is **at least 8 characters**)
44-
:::
51+
![install mobile connect](../../../static/img/sql-mobile-connect/on-premise-setup/3.png)
4552

4653
### Step 2 - Start Service
4754

48-
After **SQL Mobile Connect** service is installed and running. `Service is running` status will show on screen.
55+
After the installation, start the service. Once successful, `Service is running` status will show on screen.
4956

5057
![service running](../../../static/img/sql-mobile-connect/on-premise-setup/4.png)
5158

5259
### Step 3 - Port Forwarding
5360

54-
Next, `Port Forwarding` required to configure on your router for public access.
61+
Next, we will need to do `Port Forwarding`.
5562

5663
:::info[Port Forwarding Information]
57-
You can **Click** on `Show Tips`, to show the information for port forwarding configuration.
64+
You can **Click** on `Show Tips` to find all the information for port forwarding configuration.
5865

5966
![show tips](../../../static/img/sql-mobile-connect/on-premise-setup/5.png)
6067
:::
6168

62-
#### Port Forward Configuration Example
63-
6469
1. **Access Router Setting**: Login to the router's administration interface on web browser.
6570

66-
:::success[Router Login Page]
67-
You can **Click** on `Show Tips` > `Gateway IP Address`, to access login page of the router
71+
You can **Click** on `Show Tips` > `Gateway IP Address`, to access login page of the router.
6872

69-
![router gateway](../../../static/img/sql-mobile-connect/on-premise-setup/6.png)
73+
:::warning
74+
If you are using a firewall or serving the router's web administration interface via a different IP address, this might not work.
7075
:::
7176

72-
2. **Navigate to Port Forwarding Section**: Find `Port Forwarding`, `Virtual Service` or similar section within router's setting.
77+
![router gateway](../../../static/img/sql-mobile-connect/on-premise-setup/6.png)
78+
79+
2. **Navigate to Port Forwarding Section**: Find `Port Forwarding`, `Virtual Service` or similar section in the router's setting.
7380

7481
3. **Add New Rule**: Create a new port forwarding rule. (All information can get from [Port Forwarding Information](#step-3---port-forwarding))
75-
- `Service Name`: Enter a description name (**SQL Account Mobile Connect**)
76-
- `External/Public Port`: Specify the port number to use for external access (**443**)
77-
- `Internal IP Address`: Enter the IP address of the device to forward to (**E.g. 192.168.0.238**)
78-
- `Internal/Private Port`: Specify the port number the service is listening on within the internal network (**443**)
7982

80-
4. **Save the Rule**: Save the new port forwarding rule.
83+
- `Service Name`: Enter a description name (**SQL Account Mobile Connect**)
84+
- `External/Public Port`: Specify the port number to use for external access (**443**)
85+
- `Internal IP Address`: Enter the IP address of the device to forward to (**E.g. 192.168.0.238**)
86+
- `Internal/Private Port`: Specify the port number the service is listening on within the internal network (**443**)
87+
88+
4. **Save the Rule**: Save the new port forwarding rule.
89+
90+
5. **Verify**: **Click** on `Test Connection` to test `SQL Mobile Connect` access status. When `✅ OK` status is shown, it means the service is setup successfully.
91+
92+
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/7.png)
93+
94+
#### Examples of Port Forward
95+
96+
#### AX3000
97+
98+
1. Navigate to `Advanced` > `NAT Forwarding` > `Port Forwarding`, click `Add` to create a new entry.
99+
100+
![ax3000-1](../../../static/img/sql-mobile-connect/on-premise-setup/AX3000-1.png)
101+
102+
2. Fill in the details following the [Port Forwarding Information](#step-3---port-forwarding):
103+
104+
|Router Fields|Port Forward Information|
105+
|--|--|
106+
|Service Name|Name|
107+
|Device IP Address|Local IP|
108+
|External Port (Individual Port)|External Port|
109+
|Internal Port|Internal Port|
110+
|Protocol|Protocol|
111+
112+
![ax3000-2](../../../static/img/sql-mobile-connect/on-premise-setup/AX3000-2.png)
81113

82-
5. **Verify**: **Click** on `Test Connection` to test `SQL Mobile Connect` access status. When `✅ OK` status is shown, mean the service is setup successfully.
114+
3. Click `Save`.
83115

84-
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/7.png)
116+
#### HG8145X6
117+
118+
1. Navigate to `⚙️` > `Forward Rules` > `IPv4 Port Mapping`, click `New` to create a new entry.
119+
120+
![HG8145X6-1](../../../static/img/sql-mobile-connect/on-premise-setup/HG8145X6-1.png)
121+
122+
2. Fill in the details following the [Port Forwarding Information](#step-3---port-forwarding):
123+
124+
|Router Fields|Port Forward Information|
125+
|--|--|
126+
|Mapping Name|Name|
127+
|Internal Host|Local IP|
128+
|External port number|External Port|
129+
|Internal port number|Internal Port|
130+
|Protocol|Protocol|
131+
132+
![HG8145X6-2](../../../static/img/sql-mobile-connect/on-premise-setup/HG8145X6-2.png)
133+
134+
3. Click `Apply`.
135+
136+
#### SR1041F
137+
138+
1. Navigate to `Basic Setup` > `NAT` > `Port Forwarding`, click `Add Port Forwarding` to create a new entry.
139+
140+
![SR1041F-1](../../../static/img/sql-mobile-connect/on-premise-setup/SR1041F-1.png)
141+
142+
2. Fill in the details following the [Port Forwarding Information](#step-3---port-forwarding):
143+
144+
|Router Fields|Port Forward Information|
145+
|--|--|
146+
|Protocol|Protocol|
147+
|Local IP Address|Local IP|
148+
|Local Port Range|Internal Port|
149+
|Remote Port Range|External Port|
150+
151+
![SR1041F-2](../../../static/img/sql-mobile-connect/on-premise-setup/SR1041F-2.png)
152+
153+
3. Click `Confirm`.
85154

86155
### Step 4 - Access SQL Mobile Connect
87156

88-
1. Now, You can access `SQL Mobile Connect` by **Click** on `🌐`
157+
:::info[Important]
158+
Before access to the service, do remember to setup your users. To learn more, follow [SQL Mobile Connect - User Setup](user-setup).
159+
:::
160+
161+
1. You can now access `SQL Mobile Connect` by **Clicking** on the globe `🌐`
89162

90-
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/8.png)
163+
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/8.png)
91164

92-
2. Then **Click** on `Copy` or **Scan** on `QR Code` to get `SQL Mobile Connect` link and open on web browser to access your company on SQL Mobile Connect
165+
2. We offer two options for users to access the service:
93166

94-
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/9.png)
167+
- **Click** on `Copy` (top left) to retrieve the link
168+
- **Scan** the `QR Code` with your phone
95169

96-
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/10.png)
170+
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/9.png)
97171

98-
## Reference
172+
3. You should see the login page.
99173

100-
Your can refer to [SQL Mobile Connect - User Setup](user-setup) for user setup to login on SQL Mobile Connect
174+
![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/10.png)
164 KB
Loading
28.3 KB
Loading
91.1 KB
Loading
125 KB
Loading
91.4 KB
Loading
38.4 KB
Loading

0 commit comments

Comments
 (0)