Kiloview NDI Switcher Server Deployment Guide

1 Kiloview NDI switcher server deployment

1.1 Server environment preparation

1.1.1 Hardware environment

Processor: High frequency CPU, such as E2288G, 12 Generation Core i5 12600K.

Hard disk: 64G or higher.

Memory: 4GB RAM or above 16G.

Network card: one or more 10G or higher speed network card.

1.1.2 Software environment

Operation system: Linux64-bit operating system (Ubuntu 18.04, 20.04).

1.1.3 Network environment

Internet application tools and image files.

LAN Bandwidth: 10 Gigabit networks.

1.2 Login to server

You can use remote terminal software to login to the server; Xshell or PuTTy is recommended.

Xshell download website: https://www.netsarang.com/zh/xshell-download/

PuTTy download website: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html

1) After installing Xshell, enter the IP address of the server in the new session and use SSH protocol to communicate. The default port is 22. Click "OK" after input completed.

Screenshot description: Xshell connection properties window showing SSH protocol, server IP address field, and port 22.

2) Enter the user name and password in the pop-up dialog box. Ordinary users need sudo to obtain management right or log in as root user. The deployment process is completed by the root user. You can enter sudo su- in the command window to switch to the root user.

1.3 Deployment guide

Step 1: Install container. Enter curl -fsSL https://get.docker.com | bash in the terminal window.

Terminal output showing Docker installation script execution and successful installation.

Step 2: Install NDI discovery tool. Enter apt install avahi-daemon in the terminal window.

Terminal output showing package installation process for avahi-daemon.

Enter Y when prompted "Do you want to continue?[Y/n]". Wait for the installation to complete.

Step 3: Install netdata to obtain CPU, network datasheet, etc. Enter docker run -d --name status --restart=always -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -e GLANCES_OPT="-w" nicolargo/glances in the terminal window.

Terminal output showing Docker pulling the nicolargo/glances image and starting the container.

Step 4: Upload NDI switcher image to the server.

(1) Upload NDI switcher image from personal computer to server.

[Warning] NDI switcher image needs to be uploaded to the Linux system from an NDI local personal computer, which requires a file transfer tool. Deployers can use the Xftp file transfer tool that comes with Xshell or other file transfer tools, such as SecureCRT.

Screenshot description: Xshell SFTP window showing files on the local computer and the remote server, with instructions to drag and drop the NDI image file.

Please contact Kiloview sales or mail to info@kiloview.com with NDI switcher image documents.

(2) Load NDI switcher image in the server.

Execute the command: docker load -i trial_ndimatrix.tar

Terminal output showing the process of loading the Docker image.

Note: If the location of the NDI image file is not in the current directory, you need to specify the folder where the NDI image file is located. For example: If the directory where NDI image file is located is /home/kiloview, then the NDI image file loading command is docker load -i /home/kiloview/trial_ndimatrix.tar.

Step 4: Run container.

Execute the command: docker run -d -v /home/data:/data/configs -v /var/run/avahi-daemon:/var/run/avahi-daemon -v /var/run/dbus:/var/run/dbus --restart=always --name kv_ndimatrix --network host --privileged=true kiloview/trial_ndimatrix:latest

Note: The last image name in the above command (e.g., trial_ndimatrix) must be the same as the name behind the loaded image at the top of the command line.

1.4 Login authentications

Enter "IP address of server:81" in the browser (Google is recommended), press enter to display the login interface of the NDI switcher. The default user name and password are admin.

Screenshot description: Kiloview NDI Switcher login interface with fields for Username and Password, and a Login button.

2 General Questions and Solutions

2.1 If there is an error message during the deployment process.

Solution: Please check the version of your operation system; it currently only supports Linux64-bit operating system (Ubuntu 18.04+ / Debian 9+).

(1) Check Linux digits: getconf LONG_BIT

Terminal output showing '64' for Linux bits.

(2) Check the version number of the Linux: cat /proc/version

Terminal output showing Linux kernel version and GCC version.

2.2 No response for a long time for the installation of the docker.

Solution: The process of the installation is relatively slow, please wait patiently. You can use the command docker version to check and confirm whether the installation is successful.

2.3 Fail to pull image

Solution: To pull the image, you need to get the image file via the internet. If the network delay is high or you cannot connect to the internet, kindly check whether the network is smooth by pinging an external website.

2.4 NDI switcher could not be logged in normally

Solution: Check if the server could start normally. Press "Win+R", open the command prompt window, type cmd, then type ping server ip.

(1) If it is able to ping the server IP, please check via the following commands:

<1> Check the status of running Docker: systemctl status docker

If Docker could not start normally, start Docker: systemctl start docker

<2> Check the status of running containers: docker ps -a

Terminal output showing running containers with their IDs, images, status, and names.

If a container runs abnormally, execute the following commands to delete the container and image, then redeploy as per the deployment guide:

• Stop all containers: docker stop $(docker ps -aq)
• Delete all containers: docker rm $(docker ps -aq)
• Delete all images: docker rmi $(docker images -q)

(2) If it is unable to ping the server IP, please check as below instruction:

<1> Check whether the maintenance PC and server run normally and whether the LAN port light flashes normally.

<2> The server IP may have changed. Directly connect to the server, press "Win+R", type cmd, then type ifconfig, and apply the changed IP address (e.g., 81) to visit.

2.5 How to set static IP address for NDI switcher

Solution: The ways of setting static IP address may differ across operating systems. The configuration ways below apply to Ubuntu 20.04 version.

Execute: sudo vi /etc/netplan/00-installer-config.yaml

[Warning] (1) The Internet configuration file name for different minor versions may differ, e.g., "00-installer-config.yaml". If the file name is different, navigate to the /etc/netplan directory using cd /etc/netplan, search for the Internet configuration file, and enter the corresponding configuration file using the vi command.

(2) Press i to access the file editing mode.

(3) After inputting, press ESC, then enter :wq to save the file and exit.

(4) If you make a mistake input and do not want to save the file, press ESC and enter :q! to exit without saving files.

Configuration snippet showing network settings in YAML format with IP addresses, gateway, and nameservers.

2.6 It shows "no such file or directory" error during command execution.

Solution: When you copy the command from the file, it may include form characters that cause the command to change. When you encounter this, please execute the command manually.

Contact Information

For more questions, please contact us via: https://www.kiloview.com/en/support

KILOVIEW Electronics CO., LTD.

Tel: 86-18573192787

Email: support@kiloview.com

Web: www.kiloview.com/en

Address: B4-106/109, Jiahua Intelligence Valley Industrial Park, 877 Huijin Road, Yuhua District, Changsha City, Hunan Province, China.