Tunneling (ngrok)

Vishwac Sena Kannan edited this page Sep 23, 2018 · 11 revisions

If you're running the Bot Framework Emulator behind a firewall or other network boundary and want to connect to a bot hosted remotely, you will need to install and configure tunneling software.

Computers running behind firewalls and home routers are not able to accept ad-hoc incoming requests from the outside world. Tunneling software provides a way around this by creating a bridge from outside the firewall to your local machine. ngrok, developed by inconshreveable, is an example of such tunneling software.

The Bot Framework Emulator integrates tightly with ngrok and can launch it for you when it is needed.

Installing & Configuring ngrok

  1. Download the ngrok executable to your local machine
  2. Configure the path to ngrok in the emulator's App Settings dialog

Connect_Localhost

  1. Verify the emulator is able to successfully launch ngrok

If you've followed these steps but the emulator is not able to launch ngrok, ensure you have ngrok version 2.1.18 or later. Earlier versions have been known to be incompatible.

To check ngrok's version, from the command line:

ngrok -v
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.