Versions Compared

Old Version 7

changes.mady.by.user BAS-IP

Saved on

compared with

New Version 8

changes.mady.by.user BAS-IP

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

We recommend the installation and use of the Docker program, but this type can be used for small projects.  

Preparing Ubuntu on a virtual machine for a Link server

If you already have a server based on Ubuntu, skip this section and go to Installing Link under Linux: Ubuntu. If no, follow the steps:

  1. Download the Oracle VM VirtualBox. 

...

  1. Image Added

  2. Open the downloaded file to install the program.

...

  1. Image Added

  2. Click Next.

    Image Modified

  3.  Select the way for installation and click Next. 

    Image Modified

  4. Select appropriate options and click Next.

    Image Modified

  5. Confirm installation by clicking Yes and then Install.

    Image Modified

  6. Finish the process.

    Image Modified

  7. Download the Ubuntu server image and configure the virtual machine.

...

  1. Image Added

  2. Open the Oracle VM VirtualBox and click New.

...

  1. Image Added

  2. Select downloaded in the Step 8 file. 

...

  1. Image Added

  2. Create a username and password and click Next, e.g.: 

    • username: linkuser

    • password: qwerty11!@

...

    • Image Added

  2. Set base memory as shown.

...

  1. Image Added

  2. Create a Virtual disk with the following parameter and click Next.

...

  1. Image Added

  2. Click Finish.

...

  1. Image Added

  2. Open your machine settings.

...

  1. Image Added

  2. Go to the Network tab and set the following adapter settings as shown on the screen. Click Ok.  

...

  1. Image Added

  2. Start the created machine. 

...

  1. Image Added

Configuration of the OS to install the Link

...

server 

  1. Select a language and click Enter.

...

  1. Press Continue without updating option.

...

  1. Press Done on the next 6 pages.

...

  2. Press Continue.

...

  1. Fill in the required fields with the data and click Done when it is ready, for example: 

  • your name: linkuser

  • your server’s name: linkuser

  • pick a username: linkuser

  • choose a password: qwerty11!@

  • confirm your password: qwerty11!@

...

  1. Press the space bar to choose the Install OpenSSH server option and press Done.

...

  1. Scroll down and press Done.

...

  1. Wait for the system to update. It can take about 30 minutes.

...

  1. Press Reboot Now.

...

  1. After reboot enter your login and password (created in step 5) and log in:

...

  1. To run a command as administrator (user “root”), use the command: sudo su. Enter password qwerty11!@. The dollar icon should change to a hash.

...

  1. Enter the ifconfig command to find out the IP address (in the future you can use as static it or register another one).

...

  1. You can perform the following steps in the SSH and telnet client PuTTY. After downloading and installing, run the program.

...

  1. Enter the address you found and press Open.

...

  1. Press Accept.

...

  1. installation 8-20240115-221936.pngImage Added

  2. Return to Oracle VM VirtualBox and enter your login and password to log in: 

    • login: linkuser

    • password: qwerty11!@
      To run a command as administrator (user “root”), use the command: sudo su. Enter password qwerty11!@. The dollar icon should change to a hash.

...

    • Image Added

  2. Go to the root folder: cd ../../

  3. Go to the Netplan section and open the document to edit the network settings:

    Code Block
    cd etc/netplan
ls
vi 00-installer-config.yaml

...

  1. Image Added

  2. The network is configured for DHCP. You need to set up a static IP address.

...

  1. Press "I" to switch to edit mode and adjust the settings as shown in the example:

  • addresses: [192.168.1.23/24] (where 192.168.1.23 is your local IP address, /24 is your subnet mask (255.255.255.0), if you have another subnet mask, check the correct number here)

  • gateway4: 192.168.1.1

  • nameservers: addresses: [192.168.1.1,8.8.8.8]
                          search: []

  1. Press Esc and then Shift Z twice.

...

  1. Accept the network settings. Check if the internet connection is working.

Code Block
sudo netplan apply
ping 8.8.8.8
Ctrl z

...

  1. As result, configuration of the OS to install the Link server is done. Move to the next section to finish Link installation.   

Installing Link under Linux using Docker

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

    Code Block
    languagebash
    # 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.

    Code Block
    languagebash
    # 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.

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

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

    Code Block
    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.

...

  1. install-20240114-224711.pngImage Added

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

    Code Block
    docker volume create app-data
docker volume create app-storage
docker volume create system-logs
docker volume create app-ssl-certs
docker volume create brocker-data

...

Info

If you are installing a version with a web proxy:

...

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

...

  1. 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;  

...

  • Image Added

These parameters are required for correct encryption certificates to work.

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

 

Code Block
cd link/with-sip

If you install version without SIP, the command is: 

Code Block
cd link/without-sip

  1. Run the project.

Code Block
docker-compose up -d
Info

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

Code Block
 {"userland-proxy": false} 

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.