Plugin Management
      Back to home
      1. Resource Center
      2. Step-By-Step
      3. Plugin Management

      How to Use ngrok Plugin

       

      💡 Skip ahead to:

      Let’s Get Started!

      Plugin Overview

      Allxon provides essential remote device management solutions to simplify and optimize edge AI device operations. As an AI/IoT ecosystem enabler, connecting hardware (IHV), software (ISV), and service providers (SI/MSP), Allxon serves as the catalyst for fast, seamless connectivity across all systems.

      The Allxon Octo SDK simplifies the integration and extension of custom-developed device plugins with a flexible and user-friendly development framework. By integrating the ngrok tunneling service with Allxon Plugin, you can easily access local services hosted on your edge devices via a web browser.

      Plugin Installation

      Once you have successfully enrolled your devices in Allxon Portal, proceed to download the ngrok plugin from Allxon Plugin Station to begin using ngrok services.

      One-to-many deployment is a fundamental concept in Allxon solutions. You can select multiple devices and install the plugin simultaneously, empowering your devices with ngrok services instantly.

      Configuring ngrok Credentials

      The first step to using the plugin is to generate your ngrok authtoken and API key in the ngrok dashboard. Follow the steps below to complete the configuration in the ngrok plugin:

      - On the ngrok Dashboard: Generating ngrok authtoken and API key

      1. Navigate to the ngrok dashboard: https://dashboard.ngrok.com/.
      2. Generate a new tunnel authtoken in the Authtokens page. 
      3. Copy and securely store your Authtoken. 
      4. Generate a new API key in the API page. 
      5. Copy and securely store your API key.

      - On Allxon Portal: Configuring ngrok Plugin

      1. Navigate to the ngrok plugin and click "Edit Group Settings" in the Configs card.

      2. Click "Edit" to enter your ngrok authtoken and API key, then click "Save".

      3. Return to the ngrok plugin. If the tunnel status in the States card changes from "Cannot check status" to "Close", it indicates that your ngrok API key is active and working with the ngrok agent on your device.

      Opening a Tunnel

      Tunneling is a service that the ngrok agent uses to expose your local services to the Internet, which is particularly useful for accessing remote devices with different network settings from operator machines. Follow the steps below to open two different tunnels on your devices:

      1. Expand "Open tunnel" in the Commands card. Ensure that your ngrok authtoken is properly set in the Configs. Specify the endpoint with "tcp", the port with "22", and optionally provide a name. For example, forwarding TCP endpoint port 22 opens a tunnel for SSH connection. Click "Execute" to open the tunnel.

      2. Click "Execute" again.

      3. Go to the States card. If the tunnel is opened successfully, the tunnel status will be "Open", and the TCP endpoint will display your defined tunnel name with a link. 

        Learn more about ngrok's document for using the link to establish an SSH connection.

      4. To serve local file system directories in the plugin, specify the endpoint with "http", the port with "file:///home", and a name. Click "Execute".

      5. Navigate to the States card. Copy the HTTPS link from the HTTP endpoint and paste it into your web browser to browse the home directory of your remote device.

      *Initiating multiple endpoints is a paid feature of the ngrok service.

      Closing a Tunnel

      1. Expand "Close tunnel" in the Commands card. Enter the link associated with the tunnel you wish to close. Click "Execute".

      2. Click "Execute" again.

      3. The name and link of the closed tunnel will be removed from the States card. If you close all active sessions, the tunnel status will return to "Close".

      You’re All Set!

       

      back to top