This document outlines the required information and steps your team needs to provide and complete to prepare for the integration of your Access Control System (ACS) using Ngrok.
Ngrok is an application that VTS utilizes to provide a secure TCP/HTTP connection in order to exchange information between a client’s on-prem servers and VTS’ cloud based servers. It provides a TCP/HTTP tunnel to a trusted server on the public Internet that VTS accesses through a filter limited to the VTS backend systems. Ngrok is required for any access control system integration that runs on an on-prem server.
Please see additional Ngrok information and FAQs here.
Task 1: Required Information
Please provide the following contact and logistical details to facilitate the deployment and remote configuration of the Ngrok Application:
| Primary Technical Contact Name | Full name of the main technical contact for the integration. |
| Primary Technical Contact Email | Email address for the primary contact. |
|
TeamViewer Login + Available Configuration Dates/Times |
VTS will remotely configure the Ngrok application via TeamViewer. Download TeamViewer and provide your VTS Integration Manager with the Session ID and Password for the remote session. Please provide your VTS Integration Manager with available dates/times to remote in to your server for the configuration (approx. 1 hour needed) |
Task 2: Infrastructure Preparation Steps
The following tasks must be completed by your Building IT team before the scheduled remote configuration session.
| Task | Task Owner | Details |
| Install the Ngrok Application to the ACS server or a proxy server | Building IT |
Use the following link to download the Windows 64-bit Ngrok application to the “ngrok” folder. https://ngrok.com/download/windows?tab=download If installing on a proxy server, ensure that the server has access to the ACS server along with access to the internet via property’s public IP. |
| Create new folder titled “ngrok” to the C Drive | Building IT | This folder is where the Ngrok application download should be saved to, as well as the YAML file that the VTS integration manager will configure during the remote session. |
| Whitelist VTS production IPs | Building IT | Please whitelist all of the IP addresses as stated on this page. |
Remote Configuration Session
During the scheduled remote configuration session, a VTS Integration Manager will use the provided TeamViewer (or similar) access to remotely configure a Ngrok YAML file to connect your on-prem ACS to VTS’ cloud based servers. Once configured, VTS will be able to connect to the secure Ngrok tunnel to interact with your ACS data.
There may be additional system and/or ACS configuration required during this session.