About the Document
This document serves as a comprehensive guide for the setup, configuration, and management of the KioSoft Edge Box. It provides detailed instructions on connecting devices to the internet, establishing secure terminal connections, and managing user accounts. The document also covers program installation and upgrade procedures, including uploading necessary software packages, executing installations, and verifying outcomes. Furthermore, it outlines essential network configurations such as port forwarding and DHCP setup, ensuring seamless device integration into existing infrastructure. This document is designed to assist technical personnel in efficiently deploying and maintaining the box.
Change Log
Date | Version | Description |
06062024 | V 1.0.0 | Initial release. |
07292024 | V 1.0.1 | Modified image 3-2; Add note of this image. |
01202025 | V 1.0.4 |
|
06272025 | V1.0.8 |
|
Important
For the first batch of 15 sets of boxes, the SSH User Name and Password (See: Box_User_Password_List.xlsx) have been configured in advance. Please skip step 1.2 & 1.3, which means after acquire the IP address in step 1.1, directly start from step 2. Program Installation and Upgrade
For the other batches of boxes that are not configured in advance, please set up following the instructions below step by step. Don’t skip.
1. Device Connection
1.1 Power on and connect to the Internet
Power on the box and connect the network cable to the LAN1 port and the display to the HDMI port as shown in Image 1-1.
Image 1-1
After the box is started, input:
user name: yxzk
password: yxzk123.
Note: The ending dot “.” is included in the password.
Image 1-2
After login, input command: "ip a" to check the IP address of the device. As the case shown in Image 1-3, the box IP is 192.168.8.250. Remember this IP, later it will be used for remote connection tool.
Image 1-3
1.2 XShell/SecureCRT/Putty Connect to the Box
In this case, take XShell as an example, using SSH protocol to connect to the device.
1.2.1 Create a new connection
1) Go to File > New > Connection. Input the Name of the connection as desired, select SSH for protocol, and input the IP address you received from step 1 for Host. See Image 1-4.
Image 1-4
2) Select Authentication on the same page. Enter the corresponding username and password of the box, then click "OK" to save. See Image 1-5.
Image 1-5
1.2.2 Connect the box
1) After creating the connection, a window similar to Image 1-6 will pop up. Double-click the connection or click "Connect" in the lower right corner to initiate the connection request.
Image 1-6
2) Information shown in Image 1-7 indicates a successful connection. If the connection fails, please check any execution errors in the above steps, or check the network status.
Image 1-7
1.3 Create a new user and delete the old one (only required for devices installed for the first time)
The existence of the default user with sudo permissions and a relatively simple password on the device may cause potential security issues. Therefore, we need to create a new user and then delete the old user.
Note
Please ensure first create new user, not delete the old one. If the old user is deleted first, disorder may happen.
1.3.1 Connect to the device using the default username and create a new user
1) Create a new connection following the contents in 1.2, using the username and password as below:
username: yxzk
password: yxzk123.
Note: The ending dot “.” is included in the password
2) Log in to the device with this connection. Execute the command "sudo -i" to obtain root user permissions. A password is required; enter the password mentioned above, and press “Enter”. See Image 1-8.
Image 1-8
3) Execute the command "adduser kiosoft”, then enter the password for the new user as prompted, as shown in Image 1-9.
Image 1-9
4) Grant sudo permissions to the newly created user "kiosoft" by executing the command "usermod -aG sudo kiosoft", and then press Enter, as shown in Image 1-10.
Image 1-10
5) Click the "Disconnect" button to exit the current connection, as shown in Image 1-11.
Image 1-11
6) Follow the steps in 1.2 to create a new connection using the newly created username "kiosoft" and password.
7) Execute the command "sudo -i" to obtain root permissions, as shown in Image 1-12.
Image 1-12
8) Execute the command "deluser yxzk" to delete the default user, as shown in Image 1-13.
Image 1‑13
If the deletion fails, please check whether there is still a connection from the “yxzk” user to the box. If there is, execute the command “exit” to disconnect, wait for a minute, and then try again.
2. Program Installation/Upgrade
2.1 Upload Program Package and Installation Script (The zipped installation package needs to be extracted first.)
Follow the process in 1.2 to log in to the device, then execute "sudo -i" to obtain root permissions.
1) Execute the command "apt install lrzsz" to install the lrzsz package, as shown in Image 2-1, which allows us to conveniently upload files.
Image 2‑1
2) Execute the command "cd / ". Switch the current program from path to the root path.
3) Execute the command “ls” to check if the file “install_init.sh” is present in the current directory. If it is not present, proceed to the next step. If it is present, execute the command “rm -f install_init.sh” to delete it.
Note
This step removes the installation script from the previous version and must be executed; otherwise, uploading the upgrade files in the next step might encounter issues.
4) Execute the command "rz", and then upload the upgrade package in the pop-up window, as shown in Image 2-2.
Image 2‑2
5) Execute the command "ls" to check if the file has been transferred to the device, as shown in Image 2-3.
Image 2‑3
6) Execute "chmod +x install_init.sh" to add executable permissions to the installation script, as shown in Image 2-4.
Image 2‑4
2.2 Execute Installation/Upgrade
1) Based on the steps in 2.1:
first execute the command “apt-get update”, and
then execute the command "./install_init.sh" to install the program.
2) If prompted similar to Image 2-5, input the letter “y” (case insensitive).
Image 2‑5
3) If prompted similar to Image 2-6, press Enter directly.
Image 2‑6
4) If prompted similar to Image 2-7, press Enter directly.
Image 2‑7
5) If prompted similar to Image 2-8, you can press Enter directly or provide real information.
Image 2‑8
6) After installation, there will be information similar to Image 2-9.
Image 2‑9
2.3 Check Installation/Upgrade Results
1) Log in to the device based on the process in 1.2, then execute "sudo -i" to obtain root privileges.
2) Execute "apt install net-tools" to install network detection tools, as shown in Image 2-10.
Image 2‑10
3) Execute the following three commands separately to check the running status of three ports, as shown in Image 2-11:
netstat -plant | grep 443
netstat -plant | grep 80
netstat -plant | grep 16000
Image 2‑11
4) If each command outputs similar results as above, it indicates that the service is running normally and the installation is successful.
2.4 Obtain the IP address of the upgraded box
Execute the command “ip a”; you will see an additional IP address xxx.xxx.xxx.250 in the current network adapter. This address is the IP address of the upgraded box, and it will be automatically detected and set upon booting. If the LAN segment of the current router changes, this IP address will change accordingly. For example, if the LAN segment was 192.168.8 before, then the IP would be 192.168.8.250. If the LAN segment changes to 192.168.2, then the IP would be 192.168.2.250. Please record this IP address, which is required during setup in Vendor Portal in step 4.
2.5 Use INI Configuration Tool to Configure the Box
1) Open IniConfigure, enter the corresponding information of the Box, then select Ini Template > Download from server. Click Download, and you will find that the default configuration information has been downloaded, as shown in Image 2-12.
Image 2‑12
2) Modify the PlatformAddress/Uln/RoomId/TerminalId/VendorID to the corresponding information, then click the Upload button to upload to the Box. Re-power the Box; the configuration will be successfully updated, as shown in Image 2-13.
Image 2‑13
3. Port Forwarding and DHCP Setup
Sometimes we need to log in to the device to access local logs or perform remote debugging, so we need to configure the router to perform port forwarding, redirecting specific ports to the Box's SSH port.
3.1 HongDian 8860 Router
3.1.1 Setup Router Port Forwarding
1) Log in to the Hongdian router management page (details not provided here, please refer to other documentation), then go to Forward -> NAT, as shown in Image 3-1.
Image 3‑1
2) Click the Add button, then configure as shown in Image 3-2, and click Save to save.
Note
“Mapping Address” refers to the IP address of the Linux Box after setup, which ends with ”.250”. The “Original Port” of Original Address is fixed at “22222”.
Image 3‑2
3.1.2 Setup DHCP Range of the Router
Due to the program installation package fixing the box IP to .250 within the current network segment (see details in 2.4), in order to prevent IP conflicts with other devices in field, it is necessary to set the DHCP range of the router to .4~.249 within the current network segment. For example, if the current LAN segment is 192.168.8, the required IP range would be from 192.168.8.4 to 192.168.8.249, as shown in Image 3-3.
Image 3-3
3.2 Inhand IR302 Router
3.2.1 Setup Router Port Forwarding
1) Log in to the Inhand router management page (details not provided here, please refer to other documentation), then go to Forward -> Port Mapping, as shown in Image 3-4.
Image 3-4
2) Map the 22222 port of the router to port 22 of the box, and then click “Apply“ to take effect, as shown in Image 3-5.
Image 3-5
3.2.2 Setup DHCP Range of the Router
Due to the program installation package fixing the box IP to .250 within the current network segment (see details in 2.4), in order to prevent IP conflicts with other devices in field, it is necessary to set the DHCP range of the router to .4~.249 within the current network segment. For example, if the current LAN segment is 192.168.8, the required IP range would be from 192.168.8.4 to 192.168.8.249, as shown in Image 3-6.
Image 3-6
4. Setup in Vendor Portal
Log in to Vendor Portal and click “Location Management” in the navigation pane. Find the location where the box is deployed, and click “Edit.”
Click the “Option” tab and scroll down to find “Other” section. Then:
Enable “On-Premise Server”
Server IP Address: Input the IP address you obtained in step 2.4.
Server Port: For Elevate Card Connect (CRCS), input 16000 (for VC and Ultra, its Server Port is set to 443 by default, and no configuration is required.).
Click “Save” to save the configuration.
5. After completing the disk cloning, change the password of the box (applicable to factory processes only).
5.1 Connect to the Box
Refer to 1.2 to connect to the box.
Note: The username and password are those newly configured on the master disk.
5.2 Change the Password
Execute the “passwd” command to access the password change page. Enter the current password of the master disk, then enter the new password twice to confirm the change.
5.3 Verify the Password Change
Execute the “sudo -I” command and enter the newly configured password to check if you can successfully log in as root.
6. Network Configuration for Kiosoft Wireless Network
6.1 For the site has less than 17 devices
For a location that has 16 or less devices, we recommend using a low capacity modem like Hongdian H8951.
6.1.1 Network Diagram
6.2 For the site has 17 - 50 devices
For a location that has 16 or less devices, we recommend using a high capacity modem like Hongdian H8860.
6.2.1 Network Diagram
6.3 For the site has 51 – 140 devices
For a location that has 51 – 140 devices, we recommend using the InHand IR302 FQ38 modem, a PT-Link TL-SF1005P PoE+ switch and two Ubiquiti U7 Pro Access Points.
InHand modem |
PT-Link PoE+ switch |
Ubiquiti Access Point |
6.3.1 Network Diagram
6.3.2 Setting up a new site in Unifi portal
In a laptop or a desktop computer, sign in to the Unifi Cloud gateway using a valid Unifi account for Techtrex in this URL:
Go to Site Manager
Select Create a New Site, assign a site name following this naming convention:
vendor name-vendor ID-location ID-location name
After filling in the site name
Click “Create” and confirm the new site is shown in the Site Manager.
Select the new site and go to the site setup page. Click the setup icon then select Create New.
Fill in the Name and Password with the default credentials then select “Add WiFi Network.”
Name: techtrex
Password: tti147258
Click the newly created “techtrex” network, go to the Network settings page, select the “Manual” button and uncheck the 5 GHz box for WiFi Band, then click “Apply Changes.”
6.3.3 Connecting the devices
Insert an activated SIM card, connect the modem LAN2 port to port 5 of PoE+ switch using a network cable. Connect the Access Point #1 to port 1 of PoE+ switch, Connect the Access Point #2 to port 2 of PoE+ switch.
Connect the power and the cellular antenna to the modem. Leave the Wi-Fi antenna disconnected.
Optional: connect the Edge Box LAN1 port to port 3 of PoE+ switch using a network cable.
|
|
Optional: connect any port # of the switch box inside the primary VC Touch to port 4 of PoE+ switch using a network cable.
|
|
6.3.4 Configuring the modem
Power on the modem and the switch. Wait for a minute then log in to the modem using IP address 192.168.8.1, or 192.168.11.1.
username: admin
password: mtrextechtrex
Configure the InHand IR302 FQ38 modem, go to Network -> LAN, confirm the LAN IP is: 192.168.11.1
Go to Services -> DHCP Service, confirm the DHCP Service is enabled, and IP Pool Starting Address is 192.168.11.4, the IP Pool Ending Address is: 192.168.11.249.
Disable the WLAN. Go to Network -> WLAN, uncheck the “Enable” box.
6.3.5 Adding the Access Points
Install the Unifi App to a Smartphone. Log in with a valid account.
Go to the Site Manager and select the site you just created. It will guide you to the UI page. Make sure the correct site is selected. Click the AP icon that is the second from left on the bottom of the page.
Ensure the Access Point is powered on by checking the LED is in steady amber color. On the Unifi Devices page, click the “Add Device” icon on the bottom. Scan the QR code on the back side of the Access Point.
|
|
On the “Connect to AP” page, click “Connect,” then “Join.” Try again if it is unable to connect until successfully connected. If it is still not connected, try factory reset. Please refer to the instruction in “Ubiquiti Access Point Factory Reset” section.
After the AP is connected, click the “Adopt To KioSoft Wireless” button on the “Adopting Device” page. Wait until it finishes adopting. If the AP is successfully adopted to a site, the LED will turn to a solid blue.
|
|
6.3.6 Access Point Configuration
After the AP is adapted to the site, go to the Unifi portal on your computer. Select the correct site and click the “Unifi Devices” icon.
Click the AP icon from the list, then click the settings button on the right-hand side. The settings page will be displayed.
Change the Name to “AP1”. Channel to “6”, 5 GHz Transmit Power to “Disabled.” Select “Apply Changes.”
After changing the settings, the Devices page should look like this.
Repeat section 6.3.4 and section 6.3.5 for the second Access Point.
Remember to change the Name to “AP2” and set the Channel to “11”. It is very important!
6.3.7 Ubiquiti Access Point Factory Reset
• Locate the reset button located near the Ethernet port, labelled “RESET”
• Gently push the end of a paperclip into the hole
• Press and hold the reset button for 10 seconds (Do this with caution, you do not need a lot of pressure.)
• Release the button after 10 seconds (If it has worked, the LEDs on the Access Point will stop glowing.)
• DO NOT disconnect the AP from the power source during reboot
• If successful, the AP will reset to factory settings
• The LED should now come back on and remain a solid color