QuickStart

This tutorial assumes you are starting fresh and have no existing instances installed. It is also assumed that all system requirements are met to perform the installation and run the Connectivity Suite.

The Connectivity Suite offers on premise installation and cloud installation. There are different licensing models available depending on the hosting option. Please contact sales@netmodule.com for further information.

Installation

  1. Log into your server where the Connectivity Suite will be installed as a user who has root privileges (superuser)
  2. Download the Software from the Connectivity Suite Gitlab repository (for the following steps it is assumed that the folder is named cs). The link and credentials for the repository are provided by NetModule.
  3. Run the script cs-install-ubuntu from the cs/scripts folder on the server.
  4. After executing the script, the User is prompted to enter the hostname of the server which hosts the Connectivity Suite.
  5. The prerequisites are installed, and the latest Docker images are pulled automatically, this step takes some time.
  6. When all prerequisites are installed, you must make sure that port 80 is opened in your firewall (see chapter 5.2) and confirm by pressing enter.
  7. If the Let’s Encrypted certificate for the SSL connection exists already you will be prompted to decide if the certificate should be renewed or kept.
  8. When prompted, log out.

For generating the SSL certificate corresponding to the domain under which the machine is reachable, the Connectivity Suite uses Let’s Encrypt. Let’s Encrypt is a free, automated certificate authority.

Note that some domains which are automatically created by providers such as AWS are not accepted by Let’s Encrypt and can therefore not be used.

Initialization

  1. Log in to your server where the Connectivity Suite has been installed as a user which has root privileges (superuser).
  2. Run the script reset-data from the cs/scripts folder.
  3. Configure the Core Network in the format xxx.xxx.xxx.xxx/20. It is mandatory to use a subnet mask of 20 (see chapter 9.1 for more detailed description).
  4. Configure the Home Network in the format xxx.xxx.xxx.xxx/xx (see chapter 9 for more detailed description).
  5. When prompted choose between default settings for your Network layout or do the settings by yourself. If you choose the default settings step 6 and 7 can be skipped.
  6. Choose your preferred Home Network layout (you have the option of three given layouts).
  7. Enter a name for the Tenant type.
  8. Enter the number of max. required Tenants. Be aware that if the number set during this step is too small this cannot be changed afterwards.
  9. Configure the size of the Tenant, the default network (in the format xxx.xxx.xxx.xxx).
  10. Enter the number of max. required End Devices. Be aware that if the number set during this step is too small this cannot be changed afterwards.
  11. Enter the number of concurrent Service Access sessions. Be aware that if the number set during this step is too small this cannot be changed afterwards.
  12. Choose a username for the platform administrator account (see chapter 11.4 for the user roles).
  13. Wait for the initialization process to finish, this takes a while. Be aware that the username cannot be changed afterwards.
  14. As soon as the process is finished, the login data and the address of the Connectivity Suite UI is shown, log into the UI using these credentials.
  15. For the first login of the Connectivity Suite it is mandatory that the domain name ends with /ui/. Example cs-netmodule.com/ui/.
  16. After the first login the user will be requested to change the password.
  17. After changing the password, the Connectivity Suite will be ready for use.

Step 7-11 may need to be repeated, depending on the chosen Home Network layout in step 6.

Configuring the Home Network (step 6-11) can only be done once, during the initial setup of the software!

Only experienced users are allowed to do the settings on their own.

Add Tenant

  1. To add a Tenant, navigate to the “Network” page of the Connectivity Suite UI. Click on “ADD TENANT” at the bottom of the Main dialogue box to add a Tenant.
  2. Fill out the required fields (mandatory fields are signed by a *)
  3. Click “ADD” to finish the assignment of a Tenant. A confirmation message must pop up which confirms the assignment of the Tenant.
  4. The Tenant will now be listed in the table in the Main dialogue box. When the status shows a green tick, the Tenant is ready for use. It can take up to two minutes until the Tenant shows up in the table (it will only show up by refreshing the page).

Add Router

Steps to be executed on the web interface of the router:

  1. Only required if the router is in factory state: Go to the Web Manager of your NetModule router and set an administrator password.
  2. Only required if the router is in factory state: Set the NetModule router to WAN mode and change the firewall settings accordingly.
  3. Download the current configuration from the NetModule router via the web interface and make sure the device is connected to the internet. This file will be needed to upload it to the Connectivity Suite

Steps to be executed on the web interface of the Connectivity Suite:

  1. For the initial NetModule router provisioning navigate to the page “Configuration/Configurations” or use the Quick Link “ADD PROVISIONING” on the Dashboard. Click on “ADD PROVISIONING” in the Main dialogue box.
  2. Fill out the required fields (mandatory fields are signed by a *) and Import the configuration file that has been downloaded from the NetModule router by click on “Choose file”.
  3. Click “SAVE” to upload the configuration to the Connectivity Suite. A confirmation message must pop up which confirms the upload of the configuration.
  4. The uploaded configuration must now be shown in the Main dialogue box in the table.

Provisioning via USB

  1. Select the configuration in the Main dialogue box
  2. Click on “Configuration for USB update” at the bottom of the Detail dialogue box to download the provisioning configuration.
  3. IMPORTANT: Do a factory reset of your NetModule router. This is necessary because the USB port has been disabled after your first login.
  4. Unzip the file config_usb.zip.
  5. Copy the content of the config_usb folder onto an empty USB stick.
  6. Plug the USB stick into your router to start the configuration update.
  7. The router will now automatically connect to the Connectivity Suite

The USB stick used to configure the NetModule router must be a FAT16/32 formatted USB stick.

Provisioning via Web Manager

  1. Click on “Configuration for file update” at the bottom of the Detail dialogue box to download the provisioning configuration.
  2. Upload the file config.zip onto your NetModule router to start the configuration update. The configuration process starts.
  3. The Device will now automatically connect to the Connectivity Suite

To ensure that the Device has been connected navigate to the page “Devices” of the Connectivity Suite UI. Search for the serial number of the Device in the table (serial number is pulled automatically from the Connectivity Suite and added as name for the Device).

Adding a Device to a Tenant

  1. Navigate to the page “Devices” of the Connectivity Suite. Select the Device that needs be assigned to a Tenant.
  2. Select the tab “Device Details” in the details dialogue box. Fill out the required fields in the Detail dialogue box (mandatory fields are signed by a *).
  3. Click on “APPLY” to assign the Device to the Tenant (this operation may take some time). A confirmation message must be pop up which confirms the assignment of the Device to the Tenant.

Router configuration update

Upload configuration to the Connectivity Suite:

  1. Navigate to the configurations page of the Connectivity Suite UI.
  2. Click on “Choose file” at the bottom.
  3. Choose a .zip or .cfg file to upload.

Upload configuration to the NetModule router:

  1. Navigate to the page “Configurations/Configurations” of the Connectivity Suite UI. Choose the configuration to be uploaded to the routers and click on “UPDATE DEVICES “in the Main dialogue box which will open the table with the connected NetModule routers
  2. Select the NetModule routers you want to update in the table in the Main dialogue box
  3. Fill out the required fields (mandatory fields are signed by a *)
  4. Schedule the deployment Job when it must be executed.
  5. Click “ADD” to update the router configuration. A confirmation message must pop up which confirms the deployment of the update.

The option to start a deployment Job immediately is only available if the chosen Device is currently online and reachable from the Connectivity Suite. If the deployment for some reason cannot be completed within 24 hours, the Job is considered failed.

Router software update

Upload software to the Connectivity Suite:

  1. Navigate to the page “Configurations/Software” of the Connectivity Suite UI. Click on “ADD SOFTWARE “in the Main dialogue box which should open a Detail dialogue box.
  2. Fill out the required fields such as “Description”, “Manufacturer”, “Device type” and “Model” and select the “Choose File” to upload the software and click “SAVE” to close the upload. A confirmation message must be shown which confirms the upload of the software.
  3. The applied uploaded configuration must now be shown in the Main dialogue box in the table.

Notice: It can take several seconds until the software has been uploaded. Do not refresh the pager after the click “SAVE”.

Upload software to the NetModule router:

  1. Navigate to the page “Configurations/Software” of the Connectivity Suite UI and choose the software to be uploaded to the NetModule routers and click on “UPDATE DEVICES “in the Main dialogue box which will open the table with the connected NetModule routers
  2. Select the NetModule routers you want to update in the table in the Main dialogue box
  3. Fill out the required fields (mandatory fields are signed by a *) and schedule the deployment Job when it must be executed.
  4. Click “ADD” to update the router configuration. A confirmation message must pop up which confirms the deployment of the update. A confirmation message must pop up which confirms the deployment of the update.

The option to start a deployment Job immediately is only available if the chosen Device is currently online and reachable from the Connectivity Suite. If the deployment for some reason cannot be completed within 24 hours, the Job is considered failed.

Direct device access

For the following steps an account with Platform Administrator rights and an OpenVPN client is required.

  1. Navigate to the page “Network” and download the Service Access configuration for the required network by clicking on the download icon in the Service Access row of the table in the Main dialogue box. Using downloaded Service Access configuration (unzip the “ServiceAccessConig.zip”) to import into your OpenVPN client and establish the connection.
  2. Navigate to the page “Devices” and select the Device you want to access directly in the Main dialogue box. Open the “CONNECTED DEVICES” tab in the Detail dialogue box and check the external IP address of the End Device
  3. Establish a VPN connection using the Service Access configuration downloaded in step 1. After successful VPN connection you can now establish a connection to the End Device (e.g. via SSH) using the IP obtained from the connectivity Suite in step 3.

The Web interface of a NetModule router can be accessed directly from the Connectivity Suite UI by navigating to the page “Devices” and clicking on the button “OPEN WEB INTERFACE” in the Device details box.

Create Snippet

  1. Navigate to the page “Configuration/Snippets” and click on “ADDD SNIPPET” to add a snippet.
  2. Fill out the required fields (mandatory fields are signed by a *) Select the NetModule routers you want to update in the table in the Main dialogue box.
  3. Click “ADD” to save the Snippet. A confirmation message will pop up.
  4. The added Snippet will be listed in the Main dialogue box in the table.

Device exchange

  1. Navigate to the page “Devices” and open the tab “CONFIGURATIONS” in the details dialogue box.
  2. Copy the “Configuration Content” and navigate to the page “Configuration/Snippets”. Create a Snippet with the copied configuration as described in chapter Create Snippet.
  3. Navigate to the page “Configuration/Configurations” of the Connectivity Suite UI. Choose the provisioning configuration of the exchanged router and upload the provisioning configuration to the new router as described in chapter Provisioning via Web Manager / USB.
  4. Assign the new router to the Tenant where the exchanged router has been assigned to.
  5. Update the new router with the copied configuration stored as Snippet as described in chapter Create Snippet.
  6. Navigate to the page “Devices” and delete the exchanged router from the list

← Back to Connectivity Suite Main Page