Skip to content

add sql mobile connect on-premise setup guide #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions docs/integration/sql-mobile-connect/on-premise-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
sidebar_position: 1
id: on-premise-setup
title: On-Premise Setup
description: A guide to setup sql mobile connect on-premise
slug: /sql-mobile-connect/on-premise-setup
tags: ["SQL Account", "SQL Mobile Connect", "On-Premise Setup"]
---

## Prerequisite
- `SQL Account` version [5.2025.1027.869](/changelog/5.2025.1027.869) or above
- [Public IP Address](#public-ip-address)
- [Port Forwarding](#step-3---port-forwarding)

## Public IP Address
Make sure public IP Address is enabled by your ISP (Internet Service Provider)

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

Make sure the last requirement **Port Forward?** is `Green`
:::


## SQL Mobile Connect Setup

### Step 1 - Install Service
1. On `Logon Screen` > **Click** `⚙️`

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

2. **Right-Click** on company `database` > **Select** `Configure Mobile Connect...`

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


2. **Click** on `Install` to install mobile connect service

![install mobile connect](../../../static/img/sql-mobile-connect/on-premise-setup/3.png)

:::success[Host Name]
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**)
:::

### Step 2 - Start Service

After **SQL Mobile Connect** service is installed and running. `Service is running` status will show on screen.

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

### Step 3 - Port Forwarding

Next, `Port Forwarding` required to configure on your router for public access.

:::info[Port Forwarding Information]
You can **Click** on `Show Tips`, to show the information for port forwarding configuration.

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

#### Sample of Step to Configure Port Forwarding

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

:::success[Router Login Page]
You can **Click** on `Show Tips` > `Gateway IP Address`, to access login page of the router

![router gateway](../../../static/img/sql-mobile-connect/on-premise-setup/6.png)
:::

2. **Navigate to Port Forwarding Section**: Find `Port Forwarding`, `Virtual Service` or similar section within router's setting.

3. **Add New Rule**: Create a new port forwarding rule. (All information can get from [Port Forwarding Information](#step-3---port-forwarding))
- `Service Name`: Enter a description name (**SQL Account Mobile Connect**)
- `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 Mobile Connect` access status. When `✅ OK` status is shown, mean the service is setup successfully.

![alt text](../../../static/img/sql-mobile-connect/on-premise-setup/7.png)

### Step 4 - Access SQL Mobile Connect
1. Now, You can access `SQL Mobile Connect` by **Click** on `🌐`

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

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

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

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


## Reference

Your can refer to [SQL Mobile Connect - User Setup](./user-setup) for user setup to login on SQL Mobile Connect
2 changes: 1 addition & 1 deletion docs/integration/sql-mobile-connect/set-user-view.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
id: set-user-view
title: Set User View
description: A guide to set user view for SQL Mobile Connect
Expand Down
2 changes: 1 addition & 1 deletion docs/integration/sql-mobile-connect/use-in-web-view.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
id: open-in-dekstop-browser
title: Open In Desktop Browser
description: A guide to use SQL Mobile Connect in desktop browser
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 1
id: setup
title: Setup
description: A guide to setup SQL Mobile Connect
slug: /sql-mobile-connect/setup
tags: ["SQL Account", "SQL Mobile Connect", "Setup"]
sidebar_position: 2
id: user-setup
title: User Setup
description: A guide to setup SQL Mobile Connect User
slug: /sql-mobile-connect/user-setup
tags: ["SQL Account", "SQL Mobile Connect", "User Setup"]
---

## 1.0 SQL ACCOUNT SETUP
Expand All @@ -13,58 +13,58 @@ tags: ["SQL Account", "SQL Mobile Connect", "Setup"]

Step 1: Tools | Maintain Agent… | Create New Agent | Save

![1](../../../static/img/sql-mobile-connect/setup/1.png)
![1](../../../static/img/sql-mobile-connect/user-setup/1.png)

Step 2: Select **‘Create WebApp User’** , then will show one dialog **User is created**. | Press OK.

![2](../../../static/img/sql-mobile-connect/setup/2.png)
![2](../../../static/img/sql-mobile-connect/user-setup/2.png)

Step 3: Select **+ Button** under Passkey windows

![3](../../../static/img/sql-mobile-connect/setup/3.png)
![3](../../../static/img/sql-mobile-connect/user-setup/3.png)

Step 4: Can press the Copy link **(Red Box)** or QR code shown

Send to Salesman for register passkey on their device

![4](../../../static/img/sql-mobile-connect/setup/4.png)
![4](../../../static/img/sql-mobile-connect/user-setup/4.png)

After done registration of passkey on your device, it will show screen

Step 5: Rename the Nickname for this passkey | Press OK

![5](../../../static/img/sql-mobile-connect/setup/5.png)
![5](../../../static/img/sql-mobile-connect/user-setup/5.png)

![6](../../../static/img/sql-mobile-connect/setup/6.png)
![6](../../../static/img/sql-mobile-connect/user-setup/6.png)

## 2.0 SQL MOBILE CONNECT SETUP

Step 1: Press the link or scan the QR code provided

![7](../../../static/img/sql-mobile-connect/setup/7.png)
![7](../../../static/img/sql-mobile-connect/user-setup/7.png)

Step 2: After press the link or scan the QR code, will show screen as above for you to register passkey. Then, select **‘Continue’** to proceed.

Step 3: After registered passkey successfully, will show the screen below.

![8](../../../static/img/sql-mobile-connect/setup/8.png)
![8](../../../static/img/sql-mobile-connect/user-setup/8.png)

You need to install the App on your device

- Android > click More > Install App
- Windows > click Install App
- IOS > Share > Add to Home Screen

![9](../../../static/img/sql-mobile-connect/setup/9.png)
![9](../../../static/img/sql-mobile-connect/user-setup/9.png)

The installed app will appear on your home screen as shown above.

Alternatively, you can copy the link or scan the QR code by pressing the red box to access SQL Mobile Connect on your device.

![10](../../../static/img/sql-mobile-connect/setup/10.png)
![10](../../../static/img/sql-mobile-connect/user-setup/10.png)

![11](../../../static/img/sql-mobile-connect/setup/11.png)
![12](../../../static/img/sql-mobile-connect/setup/12.png)
![11](../../../static/img/sql-mobile-connect/user-setup/11.png)
![12](../../../static/img/sql-mobile-connect/user-setup/12.png)

Now you can start using and exploring the SQL Mobile Connect app.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.