How-Tos | Wialon Local

How to Configure Authorization with a Google Account

authorization

This guide describes the sequence of steps you should follow if you want to use your Google account to log in to the monitoring site.

Go to Google Cloud Platform and sign in to your Google account. The Dashboard tab is open by default.
Click Create project.
Specify the project name, organization, and the project location. If you use a personal account, the Organization field is not displayed.
Click Create.
Open the OAuth consent screen tab.
Select the External user type.
Click Create.
Specify the application name and the user support email.
At the bottom of the page, indicate the domain name of the monitoring site and the email address to which you want to receive Google notifications.
Click Save and continue.
If necessary, configure scopes and click Save and continue.
If necessary, add test users who should be able to access the project before its publication.
Click Save and continue.
Open the Credentials tab.
Click Create credentials to specify authorization data.
Select Oauth client ID.
Select the application type and specify its name.
Type the monitoring site URI (should be https) in the Authorized JavaScript origins and Authorized redirect URIs fields.
Click Create.
Copy the client ID from the Your Client ID field.
On the Wialon tab of the administration system, find the monitoring site (Wialon Web type) which you want to access using Google authorization and click Change next to its name. On the Advanced tab of the site settings, enable the Google authorization option.

The https protocol should be used for the selected monitoring site.
Insert the copied client ID in the Client ID for web application field.
Click Save.
Log in to the monitoring site as the user for whom you want to configure Google authorization. Click Connect with Google on the Security tab of the user settings.
Select the Google account you want to use for authorization and click OK.

As a result, the Log in with Google caption is displayed on the login page of the monitoring system. It allows logging in to the system using the connected Google account.

How to Upgrade Wialon Local from v1704 to v1804

upgrading_wialon_local

This guide describes the sequence of steps you should follow if you want to upgrade Wialon Local from version 1704 to version 1804.

In order for Wialon local version 1704 and above to function correctly, the Node.js 6.x package is required. Support for older versions of Node.js, starting with the release of 1804, is discontinued.

The official Debian 8 and Debian 9 repositories include earlier versions of packages. When installing from our distribution package, the required Node.js version is installed automatically.

How to Upgrade Wialon Local from v1804 to v1904

upgrading_wialon_local

When upgrading Wialon Local from version 1804 to version 1904, follow the steps below.

Make sure that the Debian operating system has been upgraded to version 9 (Stretch).

When updating from Debian 8 to Debian 9, add a line “include /etc/nginx/modules-enabled/*.conf” to the file /etc/nginx/nginx.conf . Here is an example of the received file:

user www-data;
worker_processes  2;
worker_rlimit_nofile 65535;
include /etc/nginx/modules-enabled/*.conf;

error_log  /var/log/nginx/error.log;
pid        /var/run/nginx.pid;

events {
       worker_connections  65535;
}

http {
       include       /etc/nginx/common/*;
       include       /etc/nginx/conf.d/*;
}

Add additional options (listed below) to the nginx configuration files for the admin site (/etc/nginx/conf.d/lcm.conf). Add the options to the location element of the server section of the lcm.conf file and to the configuration of other nginx involved in proxying requests. This is required to activate work using web sockets.

proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";

Example of the lcm.conf configuration file:

server {
    listen        80;
    server_name    10.10.10.10;
    client_max_body_size 10000m;
    proxy_read_timeout 500;
    location /50x.html {
        root /home/wialon/wlocal/nginx/www/nginx-default;
    }    
    location / {
        if ( $args ~* dns-test ) {
            echo 1;
        }
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";       
        proxy_pass         http://localhost:8080;
    }
    access_log /var/log/nginx/lcm.access.log;
}

Install the ripgrep utility. It is required for quick reading of statistical information about the status of the server.

wget --no-check-certificate http://ftp.br.debian.org/debian/pool/main/r/rust-ripgrep/ripgrep_0.10.0-2_amd64.deb -O /tmp/ripgrep.deb
dpkg -i /tmp/ripgrep.deb

Install the version 1904 of Wialon Local.

How to Upgrade Wialon Local from v1904 to v2004

upgrading_wialon_local

To upgrade Wialon Local from version 1904 to version 2004, follow the steps below.

Upgrade the operating system Debian to the version 10 (Buster).
Install the pigz and curl utilities. To do this, log in to the terminal on behalf of the main user (root) and run the following command:
```
apt-get install pigz curl
```

Upgrade Node.js to the version 10.x, by running on behalf of the main user (root) the following commands:

cd /home/wialon/wlocal/
service wlocal stop
./adf_script stop
apt-get install -y curl
curl -sL https://deb.nodesource.com/setup_10.x | bash -
apt-get install -y nodejs
npm -g install forever
npm install
chown -R wialon:wialon /home/wialon/
service wlocal restart

Install the version 2004 of Wialon Local.

Node.js upgrade instructions are also available on the official site of the Node.js developer.

You can also contact technical support to upgrade from version 1904 to version 2004.

How to Upgrade Wialon Local from v2104 to v2204

upgrading_wialon_local

To upgrade Wialon Local from version 2104 to version 2204, follow the steps below.

Before upgrading Debian, you should retain the old versions of the python and libpython packages. For this purpose, run the following command:

apt-mark hold python python2.7 libpython2.7

Upgrade the operating system Debian to the version 11 (Bullseye).

Upgrade Node.js to the version 12.x, by running on behalf of the main user (root) the following commands:

cd /home/wialon/wlocal/
service wlocal stop
./adf_script stop
apt-get install -y curl
curl -sL https://deb.nodesource.com/setup_12.x | bash -
apt-get install -y nodejs npm
npm -g install forever
npm install
chown -R wialon:wialon /home/wialon/
service wlocal restart

Install the version 2204 of Wialon Local.

Check the availability of your sites after they restart.

Node.js upgrade instructions are also available on the official site of the Node.js developer.

You can also contact technical support to upgrade from version 2104 to version 2204.

How to Upgrade Wialon Local from v2204 to v2304

To upgrade Wialon Local from version 2204 to version 2304, follow the instruction below step by step.

Preparation

Coordinate the upgrade from version 2204 to 2304 with your personal manager.

As the upgrade requires a database conversion for the primary and backup servers, ensure that the servers have sufficient free space.

The conversion of the database (the storage directory) leads to an increase in its size up to 20%.

Install all available updates in the primary server administration system. If the administration system is installed on backup servers, install updates for it as well.
Disable the Auto-install option on the System tab of the primary and backup server administration systems.

Upgrading the operating system of backup servers

If the backup servers are already running Debian 11 (Bullseye), skip this step.

Upgrade the operating system to Debian 11 (Bullseye) for the servers with the backup module installed. To do this, follow the steps below.

Stop the backup module that runs on the backup server.
Upgrade the version of Debian.
Update the software part of the backup servers (see below).
Start the backup module.

Updating the software part of backup servers

Update the software part of the backup servers. This is necessary for the subsequent conversion of their databases.

If the backup server is running the administration system in the backup server mode, do the following:

Check if the rsync tool is installed on the backup server. If not, install it by running the apt-get install rsync command in the server terminal.
On the System tab, in the Backup servers section, enable the Update backup server automatically option.
On the System tab, click on the icon (Redownload all modules).
Install the downloaded update.

If the backup server doesn't have the administration system installed, do the following:

Install all available updates in the primary server administration system.
Download the archive with the backup module by clicking on the Download button in the Backup servers section.
Stop the backup module.
Save the storage folder, which is located in the directory of the backup module and contains the Wialon Local database.
Reinstall the backup module.
Copy the saved storage folder to the backup module directory so that the database doesn't need to be synchronized from scratch.
Start the backup module.

Switching the distribution

Request your personal manager to switch your Wialon Local distribution from version 2204 to version 2304.
Wait for the next update with Wialon Local modules version 2204, which will be delivered to the administration system of the primary Wialon Local server after switching the distribution to version 2304.

By this time, all backup servers should be updated, launched and connected to the primary Wialon Local server.
Install the update. The entry Adding ADF_STORAGE_MSG_VERSION = v2 to wialonEnv will be displayed in the log in the administration system of the primary server:

Database conversion

After installing the update, the database conversion of the primary and backup servers begins. Depending on the size of the database, this may take several hours.

You can monitor the process of converting the primary server database in the log of the administration system. There will be a record like Set dbStats: 'X-Y' every 10 minutes. If X is equal to Y, then the conversion process is complete:

You can also check if the conversion has ended in the /home/wialon/wlocal/storage/ms/msgs_stats.txt file. All database files must be V5:

Don't stop or restart Wialon Local after the conversion is completed.

Make sure the databases on all backup servers are also converted. To do this, check the contents of the storage/ms/msgs_stats.txt file on the backup servers. All database files must be V5:

Approximately 20 minutes after the database conversion is completed, the administration system of the primary server will receive an update with Wialon Local version 2304.

Installing Wialon Local 2304

After the database conversion, you should install the update with Wialon Local version 2304. To do this, follow the steps below.

Install the update with version 2304 in the administration system of the primary Wialon Local server.
If the administration systems of backup servers are not installed, follow the steps in the Updating the software part of backup servers section. If they are installed, wait until the update arrives in the administration systems of backup servers, enable the Automatically update the backup server option for them, and install the received updates.

You can also contact technical support to upgrade from version 2204 to version 2304.

How to Upgrade Wialon Local from v2304 to v2404

To upgrade Wialon Local from version 2304 to 2404, follow the steps below.

In version 2404, we are switching to a new system of launching the admin site (wlocal service): the pm2 component will be used instead of forever. To upgrade, perform the following actions on the server:

npm -g install pm2
service wlocal stop
sed -i 's/forever/pm2/g' /etc/init.d/wlocal
systemctl daemon-reload
service wlocal start

Before upgrading Debian, you should retain the old versions of the python and libpython packages. For this purpose, run the following command:

apt-mark hold python python2.7 libpython2.7

Stop Wialon Local.
Upgrade the operating system to Debian 12 Bookworm.
If the error unknown directive "echo" in /etc/nginx/conf.d/lcm.conf:9 occurs after upgrading the nginx package, install an additional nginx-extras package:
apt-get install nginx-extras
Start Wialon Local.
Install Wialon Local version 2404.

In version 2404, we have updated the basic skins in the monitoring system. If you have problems with the personalization configured previously for a basic skin, go to the site settings, select default_classic in the Skin field and disable the New login page option. The default_classic skin corresponds to the basic skin in Wialon Local 2304.