Differences

This shows you the differences between two versions of the page.

--- cs:installation [2019/07/26 12:14] – [Direct device access] voegeli
+++ connectivity-suite:installation [2020/03/18 09:18] – ↷ Links adapted because of a move operation juraschek
@@ Line 1: / Line 1: @@
-====== Quickstart ======
+====== QuickManual ======
 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|sales@netmodule.com]] for further information.
-==== Installation ====
+===== Installation =====
   -Log into your server where the Connectivity Suite will be installed as a user who has root privileges (superuser)
-  -Download the Software from the Connectivity Suite Gitlab repository (for the following steps it is as-sumed that the folder is named cs). The link and credentials for the repository are provided by NM.
+  -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.
   -Run the script cs-install-ubuntu from the cs/scripts folder on the server.
   -After executing the script, the User is prompted to enter the hostname of the server which hosts the Connectivity Suite.
@@ Line 22: / Line 24: @@
 </WRAP>
-==== Initialization ====
+===== Initialization =====
-  -Log in to your server where the Connectivity Suite has been installed as a user which has root privileg-es (superuser).
+  -Log in to your server where the Connectivity Suite has been installed as a user which has root privileges (superuser).
   -Run the script reset-data from the cs/scripts folder.
   -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).
-  -Configure the Home Network in the format xxx.xxx.xxx.xxx/xx (see chapter 9 for more detailed de-scription).
+  -Configure the Home Network in the format xxx.xxx.xxx.xxx/xx (see chapter 9 for more detailed description).
   -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.
   -Choose your preferred Home Network layout (you have the option of three given layouts).
@@ Line 53: / Line 55: @@
 </WRAP>
-==== Add Tenant ====
+===== Add Tenant =====
   -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.
   -Fill out the required fields (mandatory fields are signed by a *)
-  -Click “ADD” to finish the assign-ment of a Tenant. A confirmation message must pop up which confirms the assignment of the Ten-ant.{{ :cs:tenant21.png? }}
+  -Click “ADD” to finish the assignment of a Tenant. A confirmation message must pop up which confirms the assignment of the Tenant.{{ connectivity-suite:tenant21.png? }}
-  -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).{{ :cs:tenant22.png? }}
+  -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).{{ connectivity-suite:tenant22.png? }}
-==== Add Router ====
+===== Add Router =====
 Steps to be executed on the web interface of the router:
-  -Only required if the router is in factory state: Go to the Web Manager of your NM router and set an administrator password.
+  -Only required if the router is in factory state: Go to the Web Manager of your NetModule router and set an administrator password.
-  -Only required if the router is in factory state: Set the NM router to WAN mode and change the firewall settings accordingly.
+  -Only required if the router is in factory state: Set the NetModule router to WAN mode and change the firewall settings accordingly.
-  -Download the current configuration from the NM router via the web interface and make sure the the device is connected to the internet. This file will be needed to upload it to the Connectivity Suite
+  -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:
-  -For the initial NM 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.
+  -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.
-  -Fill out the required fields (mandatory fields are signed by a *) and Import the configuration file that has been downloaded from the NM router by click on “Choose file”.
+  -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”.
-  -Click “SAVE” to upload the con-figuration to the Connectivity Suite. A confirmation message must pop up which confirms the upload of the configuration.{{ :cs:router21.png? }}
+  -Click “SAVE” to upload the configuration to the Connectivity Suite. A confirmation message must pop up which confirms the upload of the configuration.{{ connectivity-suite:router21.png? }}
   -The uploaded configuration must now be shown in the Main dialogue box in the table.
-=== Provisioning via USB ===
+===== Provisioning via USB =====
   -Select the configuration in the Main dialogue box
   -Click on "Configuration for USB update" at the bottom of the Detail dialogue box to download the provisioning configuration.
-  -IMPORTANT: Do a factory reset of your NM router. This is necessary because the USB port has been disabled after your first login.
+  -IMPORTANT: Do a factory reset of your NetModule router. This is necessary because the USB port has been disabled after your first login.
   -Unzip the file config_usb.zip.
   -Copy the content of the config_usb folder onto an empty USB stick.
   -Plug the USB stick into your router to start the configuration update.
-  -The router will now automatically connect to the Connectivity Suite{{ :cs:router23.png? }}
+  -The router will now automatically connect to the Connectivity Suite {{ connectivity-suite:router23.png? }}
 <WRAP center round important 60%>
-The USB stick used to configure the NM router must be a FAT16/32 formatted USB stick.
+The USB stick used to configure the NetModule router must be a FAT16/32 formatted USB stick.
 </WRAP>
-=== Provisioning via Web Manager ===
+===== Provisioning via Web Manager =====
   -Click on "Configuration for file update" at the bottom of the Detail dialogue box to download the provisioning configuration.
-  -Upload the file config.zip onto your NM router to start the configuration update. The configuration process starts.
+  -Upload the file config.zip onto your NetModule router to start the configuration update. The configuration process starts.
-  -The Device will now automatically connect to the Connectivity Suite{{ :cs:router24.png? }}
+  -The Device will now automatically connect to the Connectivity Suite{{ connectivity-suite:router24.png? }}
-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 Con-nectivity Suite and added as name for the Device).
+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 ====
+===== Adding a Device to a Tenant =====
   -Navigate to the page “Devices” of the Connectivity Suite. Select the Device that needs be assigned to a Tenant.
-  -Select the tab “Device Details” in the details dialogue box. Fill out the required fields in the Detail dia-logue box (mandatory fields are signed by a *).
+  -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 *).
-  -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.{{ :cs:devicetenant21.png? }}
+  -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.{{ connectivity-suite:devicetenant21.png? }}
-==== Router configuration update ====
+===== Router configuration update =====
 Upload configuration to the Connectivity Suite:
@@ Line 116: / Line 118: @@
 Upload configuration to the NetModule router:
-  -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 NM routers{{ :cs:configupdate21.png? }}
+  -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{{ connectivity-suite:configupdate21.png? }}
-  -Select the NM routers you want to update in the table in the Main dialogue box
+  -Select the NetModule routers you want to update in the table in the Main dialogue box
   -Fill out the required fields (mandatory fields are signed by a *)
   -Schedule the deployment Job when it must be executed.
-  -Click "ADD" to update the router configuration. A confirmation message must pop up which confirms the deployment of the update.{{ :cs:configupdate24.png? }}
+  -Click "ADD" to update the router configuration. A confirmation message must pop up which confirms the deployment of the update.{{ connectivity-suite:configupdate24.png? }}
 <WRAP center round info 60%>
@@ Line 126: / Line 128: @@
 </WRAP>
-==== Router software update ====
+===== Router software update =====
 Upload software to the Connectivity Suite:
@@ Line 140: / Line 142: @@
 Upload software to the NetModule router:
-  -Navigate to the page “Configurations/Software” of the Connectivity Suite UI and choose the software to be uploaded to the NM routers and click on “UPDATE DEVICES “in the Main dialogue box which will open the table with the connected NM routers
+  -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
-  -Select the NM routers you want to update in the table in the Main dialogue box
+  -Select the NetModule routers you want to update in the table in the Main dialogue box
   -Fill out the required fields (mandatory fields are signed by a *) and schedule the deployment Job when it must be executed.
-  -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.{{ :cs:softwareupdate26.png? }}
+  -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.{{ connectivity-suite:softwareupdate26.png? }}
 <WRAP center round info 60%>
@@ Line 149: / Line 151: @@
 </WRAP>
-==== Direct device access ====
+===== Direct device access =====
 <WRAP center round info 60%>
@@ Line 155: / Line 157: @@
 </WRAP>
-  -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 (uunzip the “ServiceAccessConig.zip”) to im-port into your OpenVPN client and establish the connection. {{ :cs:directaccess21.png?400 }}
+  -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. {{ connectivity-suite:directaccess21.png?400 }}
-  -Navigate to the page “Devices” and select the Device you want to access directly in the Main dia-logue box. Open the “CONNECTED DEVICES” tab in the Detail dialogue box and check the exter-nal IP address of the End Device
+  -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
-  -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. {{ :cs:directaccess23.png? }}
+  -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. {{ connectivity-suite:directaccess23.png? }}
 <WRAP center round info 60%>
-The Web interface of a NM 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.
+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.
 </WRAP>
-==== Create Snippet ====
+===== Create Snippet =====
   -Navigate to the page “Configuration/Snippets” and click on “ADDD SNIPPET” to add a snippet.
-  -Fill out the required fields (mandatory fields are signed by a *) Select the NM routers you want to update in the table in the Main dialogue box. Click “ADD” to save the Snippet. A confirmation mes-sage will pop up. The added Snippet will be listed in the Main dialogue box in the table.
+  -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. {{ connectivity-suite:snippet21.png? }}
+  -Click “ADD” to save the Snippet. A confirmation message will pop up.
+  -The added Snippet will be listed in the Main dialogue box in the table.
-==== Device exchange ====
+===== Device exchange =====
   -Navigate to the page “Devices” and open the tab “CONFIGURATIONS” in the details dialogue box.
@@ Line 179: / Line 183: @@
-[[cs:start|← Back to Connectivity Suite Main Page]]
+[[connectivity-suite:start|← Back to Connectivity Suite Main Page]]

User Tools

Site Tools

Differences

Page Tools