Tariscope 4.6. Administrator's guide
Chapter 1 Installation
Advance preparation
Tariscope can be installed both on Windows (Windows 10, Windows Server 2019 / 2016) and Linux (Alpine, CentOS, Debian, Fedora, OpenSUSE, Red Hat, SLES, Ubuntu).
Before the Tariscope installation, perform the following steps:
- Determine under which operating systems the individual components of the Tariscope system will work. It is possible to install individual components on servers (computers) with different operating systems. For example, Microsoft SQL Server is installed on Windows, and Tariscope on Linux. Other installation options are also possible.
- Determine the Microsoft SQL edition you will use for the Tariscope database. Whether it will be installed from the installation package on the same computer where Tariscope will be installed, or the SQL server will be installed on a separate server.
- Select an option to install the system.
- Select a server (computer), you will install the system. Server parameters for the Tariscope system depend on the selected installation option, telephone traffic, activity with the Tariscope system. When placing the Tariscope system and MS SQL server on one server, as well as low telephone traffic, we can recommend the following minimum server parameters:
Processor: AMD FX-6300 or Intel Core i5-4430 or server AMD Opteron 3380 or Intel Xeon E3-1505L v5;
RAM: 8 GB;
Hard disk: 512 GB.
Additional dependencies
For Windows
The Tariscope distribution includes Microsoft SQL Server 2017 Express. This is a free edition, but it has several limitations, primarily related to the size of the database and performance. It is not required to install this server, but in this case, you should connect the Tariscope database to Microsoft SQL server of a different version and edition, which you already have, or purchase a new one. Microsoft SQL Server 2019 and 2017 are supported.
For Linux
Before installing the Tariscope system, you must install the following applications:
- cupid,
- inxi,
- libgdiplus,
- wkhtmltopdf,
- .Net Core Runtime 5.0. How to install this application for a specific Linux version, see the Microsoft website: https://docs.microsoft.com/en-us/dotnet/core/install/linux
Installation for Linux, unlike installation for Windows, does not contain Microsoft SQL Server installation. Therefore, you must install this server yourself, either under Windows or under Linux. How to install this server under Linux, see the Microsoft website: https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15
1.1 Installation for Windows
The Tariscope system has a single installation package to setup the Tariscope server, Tariscope database, and Microsoft SQL Server 2017 Express edition.
The Tariscope server executes general functions of the system.
The Tariscope is a Web application that is used to setup Tariscope parameters and to work with calls, services, customers' accounts and other information. It is a main application of the Tariscope system with which the user works.
The installation is contained in the file of tariscope46.exe, which you can download from the Tariscope site.
Run the file. The Installer Language window appears as shown in Figure 1.1.1.
Figure 1.1.1
Select the desired language and click OK. The installation window appears as shown in Figure 1.1.2.
Figure 1.1.2
This is an information window. Read information and click Next. The License Agreement window appears as shown in Figure 1.1.3.
Figure 1.1.3
Read the Agreement. If you agree with the agreement, click I Agree, otherwise click Cancel. If you have selected the I Agree button on the previous step of installation, the installation window looks as shown in Figure 1.1.4.
Figure 1.1.4
The Components selection window offer you to select an installation option. There are three options:
- Tariscope with components and database, Microsoft SQL Server 2017 Express.
The choice of the option allows you to install all Tariscope applications, the Tariscope database and Microsoft SQL Server 2017 Express edition. If you planning to use another edition of Microsoft SQL Server, do not select this option. - Tariscope server and applications (without Microsoft SQL Server).
The choice of the option allows you to install all Tariscope applications and the Tariscope database. Microsoft SQL Server does not install during the installation. The Tariscope database backup was made on the Microsoft SQL Server 2017, therefore, you should have this Microsoft SQL Server version or higher to attach the Tariscope database. - Tariscope applications only or update.
Select this option if you already installed the Tariscope. Also, you should select the option if you update the previously installed Tariscope applications.
Select the desired option and click Next. Whatever your choice is, the next installation window is as shown in Figure 1.1.5.
Figure 1.1.5
The Tariscope components windows allows you to select applications that you want to install. There are following applications:
- Tariscope is a Web application that provides the Tariscope configuration and work. You only need to install it on one server.
- Observer Server is a server of Tariscope Observer remote services. It should be installed on the remote computer that has access to calls from a telephone system.
Select the desired components and click Next. The next installation window appears as shown in Figure 1.1.6.
Figure 1.1.6
There are three Tariscope utilities for which you can create shortcuts in the Start menu of Windows.
The Move database utility allows you to move the Tariscope database from one folder to another.
The Attach database utility allows you to attach data files (MDF and LDF files) to the desired Microsoft SQL Server.
The Restore database utility allows you to restore the Tariscope database from the Tariscope database backup.
Select the desired check boxes and click Next. The installation window will be as shown in Figure 1.1.7.
Figure 1.1.7
Enter or select the desired folder where Tariscope will be installed and click Next. The installation window will be as shown in Figure 1.1.8.
Figure 1.1.8
This window allows you to select a folder name in the Start menu of Windows. By default, the Tariscope name is offered. You can change it on another. Click Install to begin the installation. The Tariscope installation window will look like the one shown in Figure 1.1.9.
Figure 1.1.9
The applications that you selected on the installation step shown in Figure 1.1.3 are installed. After the installation of the Tariscope system is completed, the Tariscope Start window will appear, an example of which is shown in Figure 1.1.10.
Figure 1.1.10
You can change the language of the window. To do this, select on the toolbar: Settings → Language.
To enter the parameters for connecting the Tariscope system to Microsoft SQL Server, click the Change connection options link. The SQL Server Connection window appears, an example of which is shown in Figure 1.1.11.
Figure 1.1.11
Specify the SQL server name or its IP address in the Server name or IP box. If Microsoft SQL Server that should be used for the Tariscope database is on another server, type IP address of the server.
If the SQL server instance name is not default one (MSSQLSERVER), you should specify its name in the SQL server name (optional) box. For example, the SQL Server name is MySQLServer. In this case, you should type: MySQLServer.
If you are installing the SQL Server from the Tariscope installation package, you can type '.' ('dot' symbol) in the SQL server name (optional) box.
In the Authentication section, in the Type list, select the desired type of authentication. There are options:
- Windows Authentication;
- SQL Server Authentication.
If you select Windows Authentication, you do not need to enter any parameters. You can use this authentication type if you are installing Tariscope on the same server where SQL Server works.
For the second option, in the Username and Password boxes, type a username and its password that are used to update the database on the SQL Server.
We reccomend using SQL Server Authentication.
If your SQL Server is located on another server, you should use only SQL Server Authentication.
If you use SQL Server that was installed from the Tariscope installation package, you can use both Windows Authentication and SQL Server Authentication. In the last case, you should use the username of 'sa' and password of 'Tariscope123'.
We strongly recommend to change the password when you begin to work with Tariscope.
Click Check connection.
If you have correctly entered parameters, the Connection status string displays the value of "connected". Otherwise, ckeck the set parameters.
Click Done, you will return to the Tariscope Start window.
In the Port box, you can specify the IP addresses that will be used to access the Tariscope application. Default value: 8085. You can change this value. If you want to open the application after installing it, select the Open in web browser check box.
If you want to use HTTPS and have a corresponding certificate, then to connect it, select in the menu: Settings → HTTPS. The HTTPS setup window appears, an example of which is shown in Figure 1.1.12.
Figure 1.1.12
Select Enable HTTPS. The rest of the window positions become active.
In the HTTPS ports box, enter one or more IP ports on which Tariscope will work.
If you want all users who connect to Tariscope via an unprotected protocol to be redirected to a secure site, select Enable HTTPS redirection.
Click on the button to the left of the SSL certificate box and select the certificate file.
In the Certificate password box, enter the password for the certificate and repeat it in the Validate password box.
To check if the settings are correct, click the Validate button. Click the Done button to complete the configuration.
The Tariscope website keeps a log of requests to it. You can set the period for creating such a new log. To do this, select in the Tariscope Start menu: Settings → Kestrel Logger. Kestrel is the name of the server that hosts the Tariscope website. The Kestrel Logger window appears, where in the Period list, select the required one and click Apply.
If you have used Tariscope versions 4.4 or lower before, and you want to transfer previously created views, select Tools → Migrate the views from the menu.
If you have used Tariscope versions 4.4 or lower before, and you want to transfer previously added telephone codes, select Tools → Migrate the codes in the menu.
To launch Tariscope, click the Start button. Tariscope installation will be completed.
1.2 Installation for Linux
Installation for Linux does not contain Microsoft SQL Server, which is needed for the Tariscope system to work. You must download it from Microsoft website and install it yourself. Microsoft SQL Server 2019 (2017) can be installed on both Linux and Windows.
Unpack the archive: tariscope46.tar.gz
As a result, the App and Generic folders will be created, and the install-tariscope.sh file will be in the root.
Run the following command with the root user rights to install the Tariscope system:
sh install-tariscope.sh - p 'name of the installation folder'
In this command instead of 'name of the installation folder', specify, for example, '/home/softpi/tariscope’.
If all the listed applications in the Additional dependencies section have been installed, then the Tariscope system installation should be completed without errors.
Go to the folder where you installed Tariscope. It should contain the www folder. The Tariscope database is in this folder /www/Database/Database. Install Microsoft SQL Server 2019 (2017) on this or another server and attach the specified database to it. How to install Microsoft SQL Server for Linux, see the article: https://docs.microsoft.com/en-us/sql/linux/sql-server-linux-setup?view=sql-server-ver15.
How to install Microsoft SQL Server for Windows, see the article: https://docs.microsoft.com/ru-ru/sql/database-engine/install-windows/install-sql-server?view=sql-server-ver15.
Go to the www folder and find appsettings.json file. Open it for editing. An example of this file is shown in Figure 1.2.1.
Figure 1.2.1
In the connection string (DefaultConnection) after Data Source, specify the IP address of the server where Microsoft SQL Server was installed. In the example in Figure 1.2.1, this is the IP address: 10.10.0.133. In the same line, the system administrator, "sa", with the password "Tariscope123" is specified as the user from whom the Tariscope system works. Instead of the "sa" user, you can use any other user who has all the rights (owner) to the Tariscope database.
Tariscope works on the Kestrel server. By default, this server keeps a log of requests to it. This is reflected in the line: "KestrelLogger": true.
Change true to false to disable this logging. We recommend keeping this log.
The line "KestrelLoggerPeriod": 1 defines the period for creating a new Kestrel log: 0 - daily, 1 - weekly, 2 - monthly. Change the period for creating the log if necessary.
The IP port on which Tariscope will work is specified in the line: "Http": "8085".
That is, IP port of 8085 will be used by default. Change it if necessary.
If you want Tariscope to work over HTTPS, you must have an SSL certificate and set its parameters in this file.
In the line "SSLCertificate": "" specify the path where the file of this certificate is located.
In the line "SSLPassword": "" enter the password for this certificate.
Specify the IP port for working over HTTPS in the line: "Https": ""
To enable HTTPS, change false to true in the line: "HttpsEnabled": false.
If you want to redirect all requests made in Tariscope via HTTP to HTTPS port, change the value false to true in the line: "HttpsRedirect": false.
Save the settings for this file.
In the www folder there is the run.sh file that starts the Tariscope server.
Run the command as the root user: sh run.sh.
After that you can work with the Tariscope system.
