KiloLink Server Pro: Install Deployment Documentation v1.0

1.1 Rapid Deployment KiloLink Server Pro

To deploy KiloLink Server Pro on a cloud server with 4 cores, 8GB RAM, and 64GB storage, running a 64-bit Linux OS (Ubuntu 18.04+ or Debian 9+), with Docker and curl installed, execute the following command with sudo privileges:

/bin/bash <( curl -fsSL https://github.com/kiloview/klnk-server/raw/main/install.sh )

This command downloads and runs the installation script. Follow the prompts to complete the deployment. For assistance, contact Kiloview technical support at support@kiloview.com.

1.2 Server Environment Preparation

The server requires internet access. Recommended cloud providers include Amazon Web Services, Microsoft Azure, Google Cloud Platform, Alibaba Cloud, IBM Cloud, Oracle Cloud, Tencent Cloud, Huawei Cloud, Salesforce, or DigitalOcean.

Recommended Cloud Server Configuration:

1.3 Accessing Linux Servers

Common methods for remote connection:

1. Using SSH: Connect via SSH commands.
2. Using Cloud Service Provider's Management Console: Access via web-based consoles provided by AWS, Azure, Google Cloud, etc.
3. Using Third-Party Tools: Tools like PuTTY (Windows) for SSH connections or MobaXterm (Windows) for SSH, SFTP, and other connections.

1.4 Docker Environment

To manage packages and install Docker:

• Update package index: sudo apt update
• Install Docker: sudo apt install docker.io -y
• Start Docker service: sudo systemctl start docker
• Enable auto-start: sudo systemctl enable docker

1.5 Deployment Process

The one-click deployment command uses a cloud-hosted script. Ensure a stable internet connection.

/bin/bash <( curl -fsSL https://github.com/kiloview/klnk-server/raw/main/install.sh )

Docker Permissions Check:

Verify user permissions with docker ps. If a "permission denied" error occurs, add the user to the docker group:

sudo usermod -aG docker yourusername

Re-login or use newgrp docker to apply changes.

Installing curl (if not present):

• Ubuntu/Debian: sudo apt-get install curl
• CentOS/Fedora: sudo snap install curl

After installing curl, re-run the deployment command.

License Agreement:

Read and agree to the Kiloview® KiloLink Server (KLS) License Agreement. Enter [y/Y] to agree and proceed, or [n/N] to disagree.

Step 1: Image Download

The KiloLink Server Pro image will be loaded from the Docker image repository after agreeing to the license.

Step 2: Installation Path Selection

Specify an installation path or press ENTER for the default subdirectory 'kilolink-server'. If migrating from an older version, check the storage path of the old data.

To inspect the storage directory of an old container (e.g., named 'kilolinkserver'), use:

docker inspect "container_name"

Example: docker inspect kilolinkserver shows the storage directory as `/data`, corresponding to `/home/ubuntu/update_test` on the server.

You can specify `/home/ubuntu/update_test` as the installation path. It is recommended to back up historical data before installation:

cp /home/ubuntu/update_test /home/ubuntu/update_test_back -rf

Step 3: Removing the Old KiloLink Server Container

If an older version is detected, it will be indicated. It is recommended to remove the old container to avoid conflicts, as a server supports only one instance.

Step 4: Port Configuration

• Web Port: For HTTP access to the management console (default: 80). May need manual adjustment based on regulations.
• Link Port: For device management and aggregation. Must be an even number. The system uses the specified port and the next consecutive port (e.g., 50000 and 50001).
• Public IP: Manually specify the public IP address obtained from your cloud service provider's management panel.

Step 5: NDI Discovery Service Usage Notice

The system checks for the "avahi-daemon" service, used for NDI's automatic discovery. To enable NDI|HX output discovery, install "avahi-daemon":

• Ubuntu/Debian: sudo apt install avahi-daemon
• CentOS/Fedora: sudo yum install avahi-daemon

If "avahi-daemon" is not installed, NDI|HX output may not be discovered. You can proceed without it, but functionality might be limited.

Step 6: Confirmation of Information

Successful installation of KiloLink Server Pro. Key access details and recommendations follow.

Access Points and Firewall Configuration

Access Points:

• Web management interface for KiloLink Server Pro.
• Connection port for device binding and management.
• Docker container name.

Notes and Firewall Configuration:

Not installing Avahi Daemon disables NDI discovery. Install it if NDI discovery is required.

Firewall Configuration for External Access: Ensure the following ports are open:

• UDP ports: 50000, 50001, 5353 (if NDI|HX is enabled)
• TCP ports: 83, 5961-5962 (at least 4*N ports for NDI|HX, where N is the number of streams)
• SRT, RTSP, WebRTC port range: [30000, 30300]

1.6 Login Verification

Accessing the KiloLink Server Pro interface:

1. Open a browser (Google Chrome, Firefox, Edge recommended).
2. Enter the address: http://IPaddress:Port. Replace "IPaddress" with your server's public IP and "Port" with the server's port number (e.g., http://192.168.1.100:83).
3. Press Enter to connect.
4. The login interface will appear upon successful connection.
5. Default Credentials: Username: admin, Password: Kiloview001. You will be prompted to change the password after the first login.