Software installation and launch

Hardware recommendations

• Processor: 64-bit with SLAT and Hyper-V support

• Virtualization Support: Check if your processor supports Intel VT at: Does My Processor Support Intel® Virtualization Technology?

• Operating System:

  • Linux: Kernel version 3.10 or newer

  • Windows: 10 Pro or higher

• RAM: 8 GB

• Storage: 100 GB HDD minimum

Software recommendations 

• Preferred OS: Ubuntu 20.04 LTS

• Alternative for small projects: Oracle VM VirtualBox

Oracle VM VirtualBox host compatibility:

• Windows (64-bit): Windows 8.1 to Windows 10 (various builds), Windows Server 2012–2019;

• macOS (Intel only): 10.13 High Sierra, 10.14 Mojave, 10.15 Catalina — Intel hardware is required;

• Linux (64-bit): Ubuntu, Debian 9/10, Oracle Linux 6–8, CentOS/RHEL 6–8, Fedora 30/31, Gentoo, SUSE SLES 12/15, openSUSE Leap 15.1 — officially supported Linux distributions only;

• Oracle Solaris (64-bit): Solaris 11 — with restrictions;

• For remote installation, you can use SSH or PuTTY.

General information

Link runs as a web application and must be installed on a host computer to provide browser-based access.

You can deploy any of the server versions below using Docker (recommended) or Oracle VM VirtualBox.

Choose your Link server setup:

Basic version includes:

• Messaging, announcements, polls

• Remote device configuration

• Identifier creation/management

• Guest access

• Partial elevator module functionality

Required ports

• 5060 TCP/UDP — SIP (unencrypted)

• 5061 TCP — SIP over TLS

• 80 TCP — HTTP

• 443 TCP — HTTPS

• 6001 TCP — WebSocket

• 10000–20000 UDP — RTP (audio/video)

• 1883 TCP — MQTT (unencrypted)

• 8883 TCP — MQTT (encrypted)

• 48080 TCP — SIP proxy management

• 48081 TCP — SIP node management

• 48089 TCP — SIP settings

Installation under Linux using Docker

1. Install Docker for your distro. The example below uses the installation for Ubuntu.

   # Remove old versions sudo apt-get remove docker docker-engine docker.io containerd runc # Configure the repo ## Update apt index and install dependencies sudo apt-get update sudo apt-get install \ apt-transport-https \ ca-certificates \ curl \ gnupg \ lsb-release ## Add Docker GPG key curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg ## Add repo echo \ "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null # Install Docker sudo apt-get update sudo apt-get install docker-ce docker-ce-cli containerd.io

2. Install docker-compose for your distro:

   # Download docker-compose sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose # Grant execute permission for the file sudo chmod +x /usr/local/bin/docker-compose # Add symlink sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

3. Clone the necessary project from our GitHub with the help of command:

   git clone https://github.com/basip/link.git

4. Create the necessary volumes in advance, with help of the command:    

   docker volume create name

   Name changes depending on the volume name to be created. The list of required volumes (with external: true values) you can find at the end of the docker-compose.yml file.
   
   

   Open

   

   
   So, according to the example, the following commands must be done:

   docker volume create app-data docker volume create app-storage docker volume create system-logs docker volume create app-ssl-certs docker volume create broker-data

    

If you are installing a version with a web proxy:

1. Copy the env.example file and name this copy as .env.

2. In the .env file you must enter the following data:

• your Link server address, e.g. link.bas-ip.com for HTTPS_DOMAIN field;

• production for HTTPS_MODE field;  

Open

These parameters are required for correct encryption certificates to work.

5. Go to the folder of the version you want to install. For example, for the version with SIP, the command is: 

If you install version without SIP, the command is: 

6. Run the project.

This completes the installation of the Link server. You have access to the web interface. You can learn more about it in the First authorization and the server initial setup section.