Installation instructions | Server with Ubuntu 16.04/18.04

Xesar 3.0 | V 3.0.216 2 / 16

Table of contents

1 EXPLANATION OF SYMBOLS .................................................................3

2 INSTALLATION INSTRUCTIONS SERVER WITH UBUNTU 16.04/18.04 ......................................................4

2.1 Requirements ................................................................................................. 5

2.2 Install Ubuntu ................................................................................................ 5

2.3 Create Docker Machine .................................................................................... 9

2.4 Xesar 3.0 installation ......................................................................................11

2.5 Data backup ..................................................................................................12

Xesar 3.0 | V 3.0.216 3 / 16

1 Explanation of symbols

The following symbols are used to support illustration:

Symbol Meaning

Attention, risk of material damage in the event of non-compliance with the corresponding safety measures

Notices and additional information

Hints and recommendations

Avoidance of errors and error messages

Options

Links

Step in instructions

Xesar 3.0 | V 3.0.216 4 / 16

2 Installation instructions Server with Ubuntu 16.04/18.04

You will find information below on the preparation of the Xesar 3.0 installation on a server with the Ubuntu 16.04 or 18.04 operating system.

The creation of the necessary IT and server environment is not part of these installation instructions. These must be provided by the customer and is not the responsibility of EVVA.

Check the system requirements for Xesar 3.0. Before the installation, you must confirm that the system requirements for Xesar 3.0 according to the project checklist and system manual have been met.

Follow the current project checklist from EVVA:

https://www.evva.com/uk-en/products/electroniclockingsystem-saccesscontrolsystems/xesar/

We strongly recommend that you only carry out the Xesar 3.0 installation in close cooperation with the customer's responsible IT administrator.

https://www.evva.com/uk-en/products/electroniclockingsystemsaccesscontrolsystems/xesar/https://www.evva.com/uk-en/products/electroniclockingsystemsaccesscontrolsystems/xesar/

Xesar 3.0 | V 3.0.216 5 / 16

2.1 Requirements

The following requirements must be met for successful installation of Xesar 3.0 on a server with the Ubuntu 16.04 or 18.04 LTS operating system:

• Admin Client PC WIN 10 PRO with Docker and Installation Manager installed• Server with VM Ubuntu 1604 or 1804• Xesar 3.0 system requirements are fulfilled

2.2 Install Ubuntu

The following instructions apply to 16.04 and 18.04

Download Ubuntu 18.04

releases.ubuntu.com/18.04/ubuntu-18.04.1.0-live-server- amd64.iso

Tutorial for Ubuntu installation

https://tutorials.ubuntu.com/tutorial/tutorial-install- ubuntu-server#0

Bootable USB stick

https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows#0

Follow the instructions during the installation

After successful installation of Ubuntu, select the option open ssh server.

If this option is not selectable, it can be installed afterwards in the Linux con-sole with the command sudo apt install openssh-server. If "sudo without password” (see below) has not yet been configured, then the user password will be requested.

To set up sudo without a password, enter the following commands into the Linux console:

Enter command sudo visudo for the password prompt for sudo (Password is requested and the file /sudoers.d will open)

Scroll to the end of the opened file and type the command username

http://releases.ubuntu.com/18.04/ubuntu-18.04.1.0-live-server-amd64.isohttp://releases.ubuntu.com/18.04/ubuntu-18.04.1.0-live-server-amd64.isohttps://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-server#0https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-server#0https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows#0https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows#0

Xesar 3.0 | V 3.0.216 6 / 16

ALL=(ALL) NOPASSWD: ALL below the final line:

Save file (Ctrl+O and then ENTER)

Close file (Ctrl+X)

Check that the command sudo visudo now works without a password prompt.

In the Linux console, create a SSH key pair (Standard is RSA encryption) with the command ssh-keygen or ssh-keygen -t rsa -b 4096

The ssh key is stored by default at /home/user/.ssh on the Linux server. In our exam-ple, the user is shqadmin, which we created when creating the Linux installation.

Xesar 3.0 | V 3.0.216 7 / 16

In the next step, you need to add in the Linux console the public key (.pub) of the key pair created to the authorised keys on the Linux server.

Using the first command line, go to the previously created directory

Using the second line, add the key:

cd /home/user/.ssh/

cat id_rsa.pub > authorized_keys

Install a program (e.g. putty or WINSCP) to transfer data securely from the client (physical Win10PRO PC) to the server and vice versa. In our example, WINSCP is used.

Freeware program

https://winscp.net/eng/download.php

Log in using WINSCP on the server

Transfer protocol is SFTP Computer name is the IP address of the server (can be found in the Linux con-

sole with the command) ifconfig Port is 22 (standard) User and password correspond to the user and user's password on the Linux

server

https://winscp.net/eng/download.php

Xesar 3.0 | V 3.0.216 8 / 16

Copy the private key id_rsa and public key id_rsa.pub onto the client using WINSCP. (In our example of /home/shqadmin/.ssh on the server after C:/Users/Test10 onto the WIN10 Client – Test10, the name of the user is on our physical WIN10 PC.)

Open the Windows Console (with cmd in search, right-click as Admin)

Using the command cd C:/Users/Test10 go to the directory in the Windows Console, in which the private key id_rsa is saved (this may vary depending on the description)

Xesar 3.0 | V 3.0.216 9 / 16

2.3 Create Docker Machine

Enter the command to create the Docker Machine in the Windows Console (also from the directory where the public key is located)

The general command is:

docker-machine create --driver generic --generic-ip-address (IP server address) --generic-ssh-key (name of the public key) --generic-ssh-user (name of the user for whom the Ubuntu server was created) (name of the Docker Machine)

Command part Explanation

docker-machine create is the general command to create a Docker Machine

--driver generic is the generic driver for installing Docker on the ser-ver

--generic-ip-address is the IP address of the server

--generic-ssh-key is the description of the public key used. (If executed from the directory in which it is stored. For a different directory, the entire path must be entered.)

--generic-ssh-user is the description of the ssh users (“shqadmin” in our example). After a space, this is followed by the name of the Docker Machine (xs3ubuntu1804 in our exam-ple)

The whole process create docker-machine takes approx. 2 to 10 minutes, de-pending on the computer

Xesar 3.0 | V 3.0.216 10 / 16

If an unexpected error message occurs, you can cancel the process by exi-ting the Windows Console. Then reopen the Windows Console and delete the incorrectly set up Docker Machine with the command docker-machine rm „name“ (name is the as-signed name). Example: docker-machine rm xs3ubuntu1804

Then enter the commanddocker-machine --debug create --driver generic --generic-ip-address (IP address of the server) --generic-ssh-key (name of the public key) --generic-ssh-user (name of the user for whom the Ubuntu Server is created) (name of the docker machine). Use the suffix --debug to receive a precise error report.

If an error message relates to the ssh connection, check the user again with sudo without password or check the storing of the ssh-keys.

If there is an error message related to docker(e.g. sudo get docker version not found or similar), try to install Docker manually in the Linux console with the command sudo apt install docker.io.

After successfully creating the Docker Machine, use the command docker-ma-chine ls. in the Windows Console to check that the Docker Machine is also run-ning.

Xesar 3.0 | V 3.0.216 11 / 16

2.4 Xesar 3.0 installation

Download the latest Xesar 3.0 software

https://www.evva.com/uk-en/products/electroniclockingsystem-saccesscontrolsystems/xesar/xesarsoftwaredownload/

Connect coding station

Open the Installation Manager

Select the tab AdminCard

Select the required card reader

Load the AdminCard

Click on the button to input the Ad-minCard number

Select the tab Configuration

Select the Docker Machine

Select the tab Installations

Using the “+” button, add a new sys-tem

Select the name , the port  and the Docker Machine

https://www.evva.com/uk-en/products/electroniclockingsystemsaccesscontrolsystems/xesar/xesarsoftwaredownload/https://www.evva.com/uk-en/products/electroniclockingsystemsaccesscontrolsystems/xesar/xesarsoftwaredownload/

Xesar 3.0 | V 3.0.216 12 / 16

If you are updating Xesar 2.2, enter the database path for the import. After creating the system, you can start and commission the system (see system manual).

2.5 Data backup

The following data must be saved:

• Admin PC(Windows 10 PRO physical PC). [XesarUser] is a placeholder for the Windows user (e.g. admin) who performed the Xesar 3.0 installation

• C:System\Users\[XesarUser]\.xesar-1.0.XX\system name• C:System\Users\[XesarUser]\.xesar-cs• C:System\Users\[XesarUser]\.docker• ssh key

As of version Xesar 3.0 SP1, a manual and automatic backup can be perfor-med in the Installation Manager

• VM server

• Snapshot of the VM after each large or important change• Generally a mirroring of the whole partition, preferably the whole hard drive on

which the Xesar VM (for example Ubuntu) is installed – as is usual with servers• ssh key

• Physical server

• entire hard drive

Xesar 3.0 | V 3.0.216 13 / 16

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

Xesar 3.0 | V 3.0.216 14 / 16

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

Xesar 3.0 | V 3.0.216 15 / 16

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

.....................................................................................................................................................................

www.evva.com

1Explanation of symbols2Installation instructionsServer with Ubuntu 16.04/18.042.1Requirements2.2Install Ubuntu2.3Create Docker Machine2.4Xesar 3.0 installation2.5Data backup