Unified VPN SDK demo for Windows

This guide covers how to build, configure, and use the Unified VPN SDK demo application for Windows, including setup instructions, feature usage, and troubleshooting.

Build the demo application MSI installer

For the recommended setup method, follow the Quickstart: run the VPN SDK demo for Windows guide. If you encounter issues with the quickstart, use the manual steps below as an alternative.

1. Download the demo app project folder. Contact your account manager to get access to the demo app.

2. Launch Visual Studio, navigate to the folder containing the recently downloaded project from GitHub and open the solution file "..\unified-sdk-windows-demo\src\UnifiedSDK.Demo.sln".

3. Once the solution is open, you need to restore NuGet Packages.

Restore NuGet Packages

1. Build the "UnifiedSDK.Demo" project.

Build the project

1. Build the "UnifiedSDK.Demo.Installer.x64" project.

Build the installer

1. Navigate to ..\unified-sdk-windows-demo\output\Debug(Release)\Installer\, then double-click UnifiedSDK.Demo.Installer.x64.msi to install the demo application.

Usage

1. Sign in at pango-cloud.com.

Note that at this time, it is not possible for users to create their own accounts directly if they do not already have an account established with example.com. Please contact your sales representative to initiate account creation as part of the project and client onboarding process or contact us. We apologize for any inconvenience.

1. In Pango dashboard, create a project and use a name for your project as a Public key. Private key is optional.

Create project page

1. Navigate to the Network tab from the navigation bar. Then, click on the Add location button.

Network page

1. In Pango dashboard, navigate to the dashboard and locate your carrier_id.

2. You can find the backend URL for Prod/Stage/Dev here.

3. You are almost ready to connect to the VPN. To initiate the VPN connection process in the demo app:

   1. Enter the carrier ID and backend address in the appropriate fields.

      

      Carrier ID and backend address fields
   2. Click the "Initialize SDK service" button. No visible change will occur (except the log message in the log window), which is expected behavior.

   3. Click the "Login" button. The app should now display a "Logged in" message, indicating successful authentication.\

      
   4. Choose VPN protocol and Virtual Location.\

      
   5. Click the "Connect" button. The app will establish the VPN connection, and display a "Connected" message upon success.

   
4. Your device is now connected to the VPN. To verify the connection:

   • Open any browser on your device.

   • Navigate to whatsmyip.com (or any other site which can identify your IP).

   • Observe that the IP address displayed is different from your device's actual IP address, confirming that traffic is being routed through the VPN.

5. To terminate the VPN connection when finished, click the "Disconnect" button in the demo app. This will sever the connection and restore direct network access.

Features usage

Multihop / Custom VPN profiles / Custom DNS

1. Initialize SDK service.

2. Click the "Login" button.

3. Select "Use multihop proxy" if needed.

   • Select "Use optimal proxy location" or write your own location description.

4. Select "Get custom VPN profiles" if needed.

   • After Login select profile from "Custom profiles" combo box.

5. Select "Use custom DNS" if needed.

   • After Login select profile from "DNS server" combo box.

6. Fill the "User DNS server address" if you want to define the HTTP URL of DNS-over-HTTPS which should be used for a VPN session. Should be a valid URL.

7. Select VPN protocol.

8. Select virtual location.

9. Click the "Connect" button.

Block local networks / Prevent IP leak / Enable Killswitch

1. Initialize SDK service and Login.

2. Select "Block local networks" if needed. Disabled by default.

   • It blocks all local network connections during the VPN session except for multicast networks

3. Unselect "Prevent IP leak" if needed. Enabled by default.

   • It blocks IPv6 and DNS requests outside the VPN tunnel.

4. Select "Enable Killswitch" if needed. Disabled by default.

   • It prevents traffic leakage during an unexpected VPN tunnel shutdown.

5. Click the "Connect" button.

Keep Killswitch enabled

1. Connect to VPN with Killswitch enabled.

2. Select "Keep killswitch enabled". Disabled by default.

   • It keeps traffic protection features active aftert manual disconnect.

   • It still allows to Unified SDK to connect to another location.

3. Click the "Disconnect" button.

4. To disable this feature call disable KillSwitch method or unselect "Keep killswitch enabled" and call disconnect one more time.

VPN bypass domains/applications (only x86 and x64 architecture )

1. Fill the domains/applications (full path required).

2. Click the "Apply" button.

3. Connect to VPN.

Throttling configuration (only x86 and x64 architecture)

1. Select "Enable throttling".

2. Set global speed limits in Bit/second.

3. Set local speed limits in Bit/second.

   • Add the process you want to throttling by clicking the "Add process" button and filling the process name.

   • Click the "Add speed limit" button if you want to add another one local speed limit.

4. Click the "Send configuration button".

5. Click the "Connect" button.

Route via VPN (only x86 and x64 architecture)

1. Click on the "Initialize SDK service" button.

2. Click on the "Loggin" button.

3. Uncheck "Prevent IP leaks" checkbox.

4. Check "Enable RouteViaVPN" checkbox.

5. Fill "Route via VPN applications" text box with full path to .exe file.

6. Fill "Route via VPN domains" text box.

7. Click "Apply" button.

8. Click "Connect" button.

Logging

The demo application logs messages using the Trace level. All logs are displayed in the panel to the right of the main window. You can right-click this panel to either clear the log output or save the current log to a file.

Please note that the demo application does not display internal SDK logs in the logging panel except SDK responses which are shown there to help better understand SDK behavior.

The SDK by default is using Error log level. For more information about SDK logging please see Collecting debug logs.

Avoid using DEBUG or TRACE log levels for SDK logs in PROD, unless absolutely necessary for troubleshooting. These levels may expose sensitive or excessive information.

The same is recommended to do in PROD with application logs for SDK response data.

More Information

See SDK documentation

See Troubleshooting