Guide: Onboarding and System Registration

Keywords: CommBox EdgeOS, Onboarding, Registration, Edge Mobile App

The registration process associates the CommBox EdgeOS System with the user’s account and the location where it is or will be installed, thus allowing full management via proprietary applications viz CommBox Edge Cloud Portal (Cloud Portal, also called Service Portal), Edge Mobile App and Konnect VPN.

Pre-requisites for Registration

The pre-requisites for registration process are as follows.

Group should be existing within the KVH organization. This activity is done by Sales team as part of Group Onboarding and out of scope of this document.

  • The user should have an active email account  on which the Group Admin can send an activation request.

  • The user should have the Edge Mobile App installed on their Mobile device.

  • The CommBox EdgeOS System to be registered must be connected to the Internet.

 Steps to meet these pre-requisites are as follows:

Activating personalized Account

To activate the personalized Account, perform the following steps.

Steps

  • Share the email account that would be used for the purpose of accessing the CommBox EdgeOS System and related applications.

  • The Group Admin will initiate account activation based on the user’s email account, upon which the user will receive an email from Accounts, see Figure Invitation to Register Account.

  • Click on Register Account button at the bottom of the email body. The user is directed to the Account Registration System, see Figure Registration Page.

  • Enter the required details in the form.

  • Click Register button.

 The account will be activated successfully. At this point the user can access the CommBox EdgeOS Portal, Edge Mobile App, Konnect Application and CommBox Edge Cloud Portal.

image-20230921-115156.png
Invitation to Register Account
image-20230921-115217.png
Registration Page

Installing Edge Mobile App

To install the Edge Mobile App, perform the following steps.

Steps

  • On the Mobile device, open the App Store or Play Store.

  • Search for the ‘Edge’ App and download it.

  • Open the app to see login screen, see Figure Application Login Page.

  • Login to the app with the activated account credentials.

  • The user is successfully logged into the Edge Mobile App.

image-20230920-170328.png
Application Login Page

Powering up CommBox EdgeOS System and connecting to Internet

Before getting started, the user must ensure that the CommBox EdgeOS System is installed and powered up according to its installation instructions.

If there is some doubt, then audit the system, and it is reasonable to power cycle the CommBox EdgeOS System before starting. The proper power cycle procedure is to disconnect the CommBox EdgeOS System AC Power plug from a UPS AC Outlet for 20 seconds and then re-insert. The CommBox EdgeOS System will take 5 minutes to power up. The step assures a clean reboot and power up; short power loss/hits will not provide a clean restart of the system.

IT IS VERY IMPORTANT that POWER SUPPLY to the CommBox EdgeOS System is stable and does NOT blink on/off frequently, thus UPS connectivity and clean power off/on requirements are stated. Please contact the system administrator to recommend appropriate UPS solutions for the CommBox EdgeOS System.

If the CommBox EdgeOS System is properly powered up, verify the LAN Ethernet link from the CommBox EdgeOS System is operating as intended.

To verify the LAN Ethernet link and IP connectivity to the CommBox EdgeOS System, perform the following steps.

Steps

  • Connect a laptop Ethernet port to the CommBox EdgeOS System RJ45 LAN Ethernet port (the leftmost port). The laptop Ethernet port should be configured for DHCP Client services and will request an IP from the CommBox EdgeOS System.

  • To verify whether the Ethernet link is active in windows, click the Internet Access icon, and then click Network Status. Check the Ethernet Status; the Ethernet link should be up and 1000 Mbps. The CommBox EdgeOS System by default has DHCP enabled and will assign the IP address within the 192.168.230.0/24 space. The CommBox EdgeOS System will have the GW IP address of 192.168.230.1 and DNS of 8.8.8.8.

  • Depending on the connectivity of the cellular (LTE/5G) WAN, the user may or may not have Internet connectivity.

  • To verify the IP address in Windows, click the Internet Access icon, click Network Status, and then click on the active connection. The IP information is displayed.

  • If the Ethernet link is up and IP is assigned to the laptop, then the system is ready for registration.

Registration Process

Registering CommBox EdgeOS System with CommBox Edge Cloud Portal

After the pre-requisites are met, register the device in CommBox Edge Cloud Portal:

  1. Open CommBox Edge Cloud Portal at https://CommBoxEdge.kvh.com and log in.

  2. Select Inventory from the left menu bar and click the Warehouse tab. The list of devices available for registration is shown.

  3. Note the Device ID (DID) / serial number on the device or its box and type it in the search box. The table shows the matching device.

kc-cloud-inventory-warehouse.png
Inventory - Warehouse
  1. Click the gear icon in the Operations column. The Operations dialog opens with REGISTER selected.

  2. In Select Organization, choose the organization.

  3. In Create / Search Site, type the site name and select an existing site, or type a new name and click Add to create a new site. The Site Name must be unique for the group deployment; multiple CommBox EdgeOS nodes can be in a single site.

  4. Enter a Device name.

  5. Select the License and the Term.

  6. In Upgrade EOS, select Yes to upgrade to the latest CommBox EdgeOS version shown, or No to keep the current version.

  7. In Apply Default Config, select Yes to apply the organization’s default configuration, No to keep the current configuration, or Other to choose a saved backup configuration.

  8. Click Register.

kc-cloud-warehouse-register.png
Operations - Register
  • The device moves from the Warehouse tab to the Deployed tab. The Deployed table shows Site, Organization, Device Name, EOS Version, DID, Last Seen, Reg. Date, License, Warranty (Months), License Exp. Date, Uptime Since, Saved Config and Operations.

kc-cloud-inventory-deployed.png
Inventory - Deployed

This completes the registration process.

Registering CommBox EdgeOS System with the Edge Mobile App

The device can also be registered with the Edge Mobile App by scanning the QR code on the device. For the current step-by-step flow, see How To: Register A Device (section “Registration through the Mobile App”).

Login to CommBox EdgeOS via the CommBox EdgeOS Portal

After successful registration, log in to the CommBox EdgeOS portal:

  1. Open any browser.

  2. Enter the CommBox EdgeOS IP address (for example http://10.0.254.1, or the LAN gateway http://192.168.230.1 when connected to the default LAN) and press Enter. The login page appears.

  3. Enter your personalized account credentials and click the login button. The login page also offers Remember me, Forgot Password? and Sign in with Single Sign-On.

  4. If Two Factor Authentication is enabled for the user, a security code is sent to the registered email address. Enter the code and click Verify.

It is also possible to log in with the temporary account edge/edge. However, it is recommended to use the personalized account to use the full functionality of the CommBox EdgeOS portal.

  • After login, the Dashboard > Internet Status page opens.

kc-edge8-dashboard.png
Dashboard - Internet Status
  • To log out, click your user name at the top right and select Logout. The same menu has Manage Accounts.

kc-edge8-user-menu.png
User menu

Viewing the CommBox EdgeOS System through CommBox Edge Cloud Portal

The CommBox EdgeOS system can be monitored in CommBox Edge Cloud Portal, which shows its health and vital statistics.

  1. Open CommBox Edge Cloud Portal at https://CommBoxEdge.kvh.com and log in.

  2. The Sites page opens, showing summary tiles (Sites, Internet Links, Cellular, Starlink, VSAT) and the list of sites with Usage, Quota, Availability, Top Apps, Clients, Services and Portal.

  3. Click a site name to open its Topology and see the status of the device and its interfaces.

kc-cloud-sites.png
CommBox Edge Cloud Portal - Sites