Software installation and launch

Hardware recommendations


  • 64-bit processor with SLAT and Hyper-V support

Whether your processor supports Intel virtualization technology can be found at https://www.intel.ru/content/www/ru/ru/support/articles/000005486/processors.html

  • If Linux: Kernel is not older than 3.10
  • If Windows: 10 Pro or higher
  • 8 GB RAM
  • 100 GB HDD

General information


First, the Link must be installed and configured on a computer to work correctly and provide access in a web browser. It can be done with the help of: 

  • multiple Docker containers and deployed with Docker Compose;
  • Virtualbox virtual machine image;

Further, you will find detailed installation steps for both methods. 

There are several Link server variations, so before the installation choose the one that is required: 

  • Link without SIP and without web proxy;
  • Link without SIP but with web proxy; 
  • Link with SIP but without web proxy;
  • Link without SIP but with web proxy; 

Versions with SIP are recommended only for Linux OS installation.

Versions with web proxy are recommended to use if Link is going to be used as a public server and the connection will be via secure https protocol.   

Versions without web proxy are recommended to use if Link is going to be used in a local network and the connection will be via http protocol.   

In the beginning, you get Link basic version, and further you can buy access to the Link License server to expand software functionality. More details about functionality can be provided with licenses you can find in the corresponding tab.  

Installing Link 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.



    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

    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;  

     

    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 without SIP, the command is: 

    cd link/without-sip

     

  6. Run the project.

    docker-compose up -d

You can improve the productivity of extensive projects by doing the following Docker configuration: 

Change the userland-proxy attribute to false in the docker configuration /etc/docker/daemon.json file. If there is no such file, then create it with the content

 {"userland-proxy": false} 

Used ports


The application uses the following ports:

  • 5060 TCP/UDP: unencrypted SIP traffic port;
  • 5061 TCP: port for SIP using TLS;
  • 80 TCP: HTTP port;
  • 443 TCP: HTTPS port;
  • 6001 TCP: WebSocket port;
  • 10000-20000 UDP: RTP ports for audio/video;
  • 1883 TCP: unencrypted MQTT;
  • 8883 TCP: encrypted MQTT;

If SIP proxies and nodes are running on more than one server with the Link server application, then the following ports must be forwarded to them:

  • 48080: SIP proxy management port;
  • 48081: SIP node management port;