Wialon Pro GPS tracking software User Guide

» Administrator's Duties

Administrator's Duties

Wialon service administrator is in charge of the following:

To see that there are enough free space on the disk.

To care of hard drives state (to avoid the formation of damaged areas).

To monitor the volume of Wialon log files.

To monitor errors ('… error …') in Wialon log files, in case of errors promptly remove cause of trouble.

To monitor memory consumption and CPU load.

To maintain actual time on the server.

To control the logins to Wialon and do not allow restarts or attempts of restarts from users who do not have enough rights for this.

Several processes allowing to automate administrator's work are described in

Cron Jobs

Wialon Pro Guide

You are here:

custom design of the monitoring system (if you are using not a

» Directory Structure

Directory Structure

The general structure of Wialon directories:

custom - the directory containing your custom configuration;

skins - the directory with your

default skin);

hw - the directory with scripts needed to work with devices different from the standard package and unique for the given service);

custom.txt - the file of your custom

Wialon Configuration

;

dep – the directory containing system libraries needed for Wialon operation;

lib – the directory of main libraries;

logs – the directory containing log files:

service.log - main log;

trace.log - trace log;

http_error.log - error log of processing HTTP queries;

error.log - all errors from trace log which contain the text 'error'; and an individual log for each device type and for modems;

plugins – the directory with plugins (here the encrypted folder mps with additional plugins is also located);

scripts – the directory with the main scripts;

sites – the directory for sites;

storage – the directory containing database;

pd - database for units and their properties;

pl - database transactions log for units and their properties;

ps - database statistics on units and their properties;

md - messages database;

ml - transactions log for messages database;

ms - statistics on messages database;

tmp - the directory with temporary files.

User is allowed to make changes in custom directory only. By default, when the software is updated, only this directory is not replaced with original files from the distribution.

Wialon Pro Guide

You are here:

» License

License

The license is license.cfg file. It must be given to you as a soft copy or sent by e-mail.

Periodically (usually each 20-30 days), Wialon license connects to the license server lic.gurtam.com (port 31176) and confirms the product usage on one server at a time. If this license check is blocked because of firewall or lack of

Internet connection, it will cause a ban to use the program. In this case you will not be able to create new devices.

Working service with all its configuration will not be damaged.

You place the license file to the root directory before the first start of the server.

If you have any problems with license, you cannot create any monitoring objects, and in log files there can be found phrases like: Error fetching license: 'avl.unit'.

After purchasing a new license for local Wialon, it is necessary to update license file from lic.gurtam.com. After that, service must be restarted. It is important to monitor log files while restarting process is running.

If you have problems with license and you service is active, you cannot create any monitoring objects.

Wialon Pro Guide

You are here:

» Installation and First Steps

Installation and First Steps

Wialon Installation Procedure

Before installing Wialon, it is recommended to read recommendations on configuring

your file system and

minimum requirements

First of all, unzip the distribution using the tar command. In the example below, this command is applied to 1106r1 distribution:

tar

xzf wialon-pro_1106r1_l64.tgz

After this action, the directory wialonb3_install will appear. Here run installation script install.sh:

Table of Contents

Installation and First

cd wialonb3_install

/ install.sh

Root rights are not required for installation, but the default directory /var/lib/wialonb3 assumes that an ordinary user has no edit rights. However, for correct installation of

automatic administrator's scripts ,

log files rotation system

, and

unattended startup of the service

it is desirable to run installation as root user.

Root rights are neither required for normal service operation. In case you need port numbers under 1024, you can use

reverse proxy server : nginx, lighttpd or Apache.

Installation wizard will ask you some questions. If you install Wialon for the first time, it is recommended to leave default settings. At the end, the installation wizard will show you the adjusted configuration and will do installation.

Welcome to Wialon B3 installation script.

Please answer few questions before starting actual installation. Provide empty answers to use defaults.

Where would you like to install Wialon B3? [/var/lib/wialonb3]

Wialon B3 dependencies need to be downloaded and unpacked. This operation is performed only once for each service installation and can take some time, so please wait patiently.

Enter HTTP or local directory path that contain archived Wialon B3 dependencies file adf-dep-3.1.1-l64.tgz [http://distro.gurtam.com/adf]

Install custom configuration (folder)? [yes]

Where would you like to install Wialon B3? [/var/lib/wialonb3]

Install custom configuration (folder)? [no] yes

Install periodic administrative jobs (in current user crontab)? [no] yes

Install Wialon B3 log rotation script (into /etc/logrotate.d/wialonb3) [no] yes

OK, now is time to perform Wialon B3 installation. Check all parameters below are correct:

Wialon B3 will be installed in: /var/lib/wialonb3

Install user custom configuration folder: yes

Install Wialon B3 as system service: no

Install Wialon B3 cron jobs: yes

Install Wialon B3 log rotation script: yes

Use ADF dependencies from:

http://distro.gurtam.com/adf/adf-dep-3.1.1-l64.tgz

Are all parameters correct? [yes]

Creating directories...

Downloading/Copying packed ADF dependencies file adf-dep-3.1.1-l64.tgz

--08:53:36-- http://distro.gurtam.com/adf/adf-dep-3.1.1-l64.tgz

=> `/var/lib/wialonb3/adf-dep-3.1.1-l64.tgz'

Resolving distro.gurtam.com... 85.17.154.142

Connecting to distro.gurtam.com|85.17.154.142|:80... connected.

HTTP request sent, awaiting response... 200 OK

Length: 7,019,076 (6.7M) [application/x-gtar]

100%[===================================================================================

7,019,076 9.25M/s

08:53:37 (9.23 MB/s) - `/var/lib/wialonb3/adf-dep-3.1.1-l64.tgz' saved

[7019076/7019076]

Copying files and directories...

Installing Wialon B3 as system service...

Installing Wialon B3 cron jobs...

Installing Wialon B3 log rotation script...

Wialon B3 installation finished successfully. Read documentation for further instructions.

Server can be used as default init.d script. After loading environment (if using

/etc/init.d/ script preloading environment is not required) as described above you may:

To start server in debug (not forked) mode with logging to stdout (press Enter to stop): /etc/init.d/wialonb3 debug

To start server in normal mode with logging to /var/lib/wialonb3/logs:

/etc/init.d/wialonb3 start

To stop server in normal mode: /etc/init.d/wialonb3 stop

Log files located in /var/lib/wialonb3/logs directory always contain maximum information regarding service errors or status.

If this is the first installation, select to Install custom configuration for the ./custom folder to be created. It will have then standard contents. If installing updated, do not select this option in order to save your configuration settings.

Important! If the service will be started by a user with limited access rights, add the user/group to a trust group to avoid possible conflicts. To do this, in the file ./custom/system_env.sh comment in the variables ADF_USER or

ADF_GROUP and enter user/group that will obtain full rights to the directory where Wialon is installed.

#ADF_USER="--user some-user"

#ADF_GROUP="--group some-user-group"

Starting Wialon

Before starting Wialon, it is required to set up some variables in the

configuration file ./custom/config.txt

(ADF_DISKSPACE_CHECKER, WIALON_DISKSPACE_EMAIL_FROM and WIALON_DISKSPACE_EMAIL_TO).

They are needed to monitor free disk space.

More...

To start Wialon, see instructions in the installation script. Usually, it is /etc/init.d/wialonb3 start.

After the installation special configuration of Linux may be needed. For more details, see System Configuration

Default Ports

After the first installation, you can get the access to your service through a web browser via the following ports

(numbers by default):

Port

8021

Site

Administration site

Description

Access for users in the group of administrators.

8022 Monitoring site

Working application. Contains the map. Use the default login wialon and password wialon to enter the site.

8023

Management site

Access for users from the group of managers. Here the accounts are created.

8024 Mobile site A light version of the monitoring site to access the service form a PPC or mobile phone.

8025 Wialon ActiveX Port to connect to Wialon ActiveX.

In other words, if you are on the server, your administration site is accessible through the link http://localhost:8021 or http://server>IP:8021.

Users/Logins

During the first start, a password will be reset for the user admin to enter the administration site. Besides, the user

wialon

with the password wialon and the account wialon for this user will be automatically created. This user can be used to enter the monitoring site. It is recommended to change the password for this user. All this will be registered in the log:

2008/12/29 17:06:25:916: Performing initial setup for Wialon site

...

2008/12/29 17:06:25:916: Updating initial password for admin user to: GbykVFGtFG

...

2008/12/29 17:06:25:917: Created user 'wialon'

...

2008/12/29 17:06:25:917: adf_avl_create_resource('wialon')

2008/12/29 17:06:25:917: Created resource 'wialon'

Diagnostics

For any diagnostics of system operation, see the log file WialonB3_trace.log that is located in the logs directory.

Resources

Wialon may require more resources when it comes to the constantly increasing number of messages from units. In this case, the following can be done: to increase the allowed number of open files descriptors, write ulimit -n 20000 in ./custom/system_env.sh

file; to increase the allowed number of protocols, set the variable ADF_MAX_THREADS_COUNT = 100 in

./custom/config.txt file.

Wialon Pro Guide

You are here:

Network Time Synchronization

» System Configuration

System Configuration

Here are instructions of how to set your operation system to work with Wialon Pro.

File System

/etc/sysctl.conf

Firewall

Proxy Server

Mail Server

Log Files Management

Operation under Ordinary User

Unattended Startup

Cron Jobs

Wialon Pro Guide

You are here:

File System

File System Type

The strength of Linux OS is the opportunity to use file systems of different types. However, the question is how to choose the file system which fits better to your objectives.

Table of Contents

Over a month, we had administered tests in Wialon Data Center . Three file systems - ReiserFS, XFS and ext3 with different settings were tested on various hardware units to find out which file system provides maximum highperformance in work with Wialon monitoring service.

The result was as follows:

The most effective and simple way is to add noatime parameters when installing the file system in the file

/etc/fstab

If data level is not low (under 5-10GB), the difference in fast-acting is not considerable - up to 5-10%.

The most effective operation was shown by XFS file system. It was a lot faster than ext3 when operating with ten millions of files (WebGIS-3 cache). It was also a bit better in work with large files (up to 1GB) and much faster in work with files of several tens of gigabytes. Embedded tools such as online defragmentation and backup system add advantages in system administration.

The productiveness of ext4 file system, in theory, is no worse than XFS, but for the moment of testing, the support for distribution Debian 5.0 Lenny was not irreproachable.

File System Configuration

When configuring file system categories, RAID must be used, software- or hardware-based.

/boot - ext3 - 300MB

/ - xfs - 5-10GB + noatime option

/var/lib/wialonb3 - xfs - the rest of disk space + noatime option

Wialon Pro Guide

You are here:

/etc/sysctl.conf

For the configuration file /etc/sysctl.conf the following settings are recommended:

# for atop utility better view vm.overcommit_memory = 2 vm.overcommit_ratio = 95

# swapiness level vm.swappiness = 10

# reserve memory always vm.min_free_kbytes = 65535

# security fix vm.mmap_min_addr = 65536

# enable reboot upon kernel oops kernel.panic_on_oops = 1 kernel.panic = 30

The most important parameter that influences file system effective operation is vm.swappiness. The rest can be ignored.

Wialon Pro Guide

You are here:

Wialon Pro Client ). This port is available after purchasing

Firewall

Security is above all. That is why firewall is needed. We recommend using firehol: wialon-pro:~# apt-get install firehol

After that in the file /etc/default/firehol substitute NO for YES and configure /etc/firehol/firehol in the way it is shown below. Do not forger indicate your IP address, otherwise the access to server will be denie. eth0 is your network adapter.

version 5 tcpmss auto

FIREHOL_LOG_MODE="ULOG"

######################### trusted IP's ######################## trust_ips="IP (enter IP addresses you trust to separating them by space)" ext_wialon="IP1"

######################### custom rules ######################## server_wialon_ports="tcp/4998 tcp/20100:20300 udp/20100:20300" client_wialon_ports="any"

############################################################### interface eth0 inet1

policy reject

server ssh accept src

"${trust_ips}"

server icmp accept

server https accept dst

"${ext_wialon}"

server http accept dst

"${ext_wialon}"

server wialon accept dst

"${ext_wialon}"

client all accept

Then run firewall: wialon-pro:~# /etc/init.d/firehol start

In the table below the default input ports used for the monitoring server software are listed. Which of them should be protected by firewall is decided by the administrator of your server according to your company security policy.

Port

31188

Type

TCP

Description

Remote clients connection (such as

the license for remote connection from your clients.

20100:20300 TCP/UDP Connect devices by GPRS channel.

8021 TCP Administration site.

8022

8023

TCP

Monitoring site.

Management site.

8024

TCP Mobile site.

[email protected]

Wialon Pro Guide

You are here:

Network Time

Synchronization

Network Time Synchronization

For correct processing of data received from devices, it is necessary to set the exact time on Wialon telematic server.

Use the following command to set automatic time synchronization with Internet: wialon-pro:~# apt-get install ntp

Wialon Pro Guide

You are here:

Proxy Server

Wialon server contains embedded HTTP/1.1 web server. That is why it is possible to connect to them through through web browser directly.

However, if: other services are located on the same server with Wialon and IP address is shard, you would like to use SSL protected access to server, you would like to reach the maximum high performance and safety, then it is recommended to render services to your client through reverse proxy server.

One of the best proxy servers is nginx. It is easy to install (for Debian before Lenny version it is better to install it from source code): wialon-pro:~# apt-get install nginx

Let us assume, your server DNS name is monitor.gps.ru (mobile.gps.ru for mobile site and manager.gps.ru for management site) and Wialon uses

default ports

. Then the configuration of files is approximately the following:

/etc/nginx/sites-enabled/wialon: server {

listen 80;

server_name www.monitor.gps.ru;

rewrite ^(.*) http://monitor.gps.ru$1 permanent;

} server {

listen 80;

server_name monitor.gps.ru;

proxy_set_header Host $host;

proxy_set_header X-Forwarded-For $remote_addr;

client_max_body_size 8m;

access_log /var/log/nginx/wialon.access.log;

location / {

proxy_pass http://localhost:8022;

}

} server {

listen 80;

server_name mobile.gps.ru;

proxy_set_header Host $host;

proxy_set_header X-Forwarded-For $remote_addr;

access_log /var/log/nginx/wialon.access.log;

location / {

proxy_pass http://localhost:8024;

}

server {

listen 80;

server_name manager.gps.ru;

proxy_set_header Host $host;

proxy_set_header X-Forwarded-For $remote_addr;

access_log /var/log/nginx/wialon.access.log;

location / {

proxy_pass http://localhost:8023;

}

/var/lib/wialonb3/custom/config.txt (add a line):

ADF_HTTP_PROXY_MODE = 1

Wialon Pro Guide

You are here:

automatic scripts ), it is advisable to use aliases to

Mail Server

For correct operation of the system, SMTP server is needed. We recommend postfix: wialon-pro:~# apt-get install postfix

Default settings are acceptable and sufficient to provide a basic operability (sending e-mails from the server).

For system administrator to get messages form the server (see

indicate where to redirect mails. For example, if the scripts are set for the user named root, in the /etc/aliases can be written: root: [email protected]

Wialon Pro Guide

You are here:

Log Files Management

While installing Wialon, the installer requests automatic activation of this option:

...

Install Wialon B3 log rotation script ( into / etc / logrotate.d

/ wialonb3 ) [ no ]

yes

...

OK, now is time to perform Wialon B3 installation. Check all parameters below are correct:

Wialon B3 will be installed in : / var / lib / wialonb3

...

Install Wialon B3 log rotation script:

yes

...

This option is set automatically as default with the first installation if you install Wialon as root user. In this case, you do not need to configure this option manually.

You can control log size manually (periodically cleaning it) or automatically. To apply the automatic cleaning, use

logrotate utility. The utility functions in the following way. Log rotation is used to control disk space occupied by logs.

As the result, one active log file is left (this is a log file where data is recorded by the server at the moment) and several archival quality files compressed by a special archiver.

To start rotation, place a file like wialonb3 (or any other like “wialonb3.txt”) to the directory /etc/logrotate.d. The contents of the file may be as follows:

/var/lib/wialonb3/logs/*.log {

weekly

missingok

rotate 5

compress

delaycompress

notifempty

create 0664 root root

}

Wialon Pro Guide

You are here:

Operation under Ordinary

User

Operation under Ordinary User

For security reasons Wialon monitoring service can be configured in such a way that it would work under an ordinary user (for example, wialon or wialon group), and not under root. It is needed to create for this user: wialon-pro:~# adduser wialon

Then correct system settings to give this user possibility to work with a greater number of file than it is provided by defaults. To do this, add to the file /etc/security/limits.conf the following: wialon hard nofile 32768 wialon soft nofile 16384

Let us assume, we installed the distribution to the directory /home/wialon/wialon-pro. To provide our user the full access to the service, make it the owner of the following directory:

chown

-R wialon:wialon / home / wialon / wialon-pro

Regardless under which user the service is started, it is required that the service worked under wialon user or group.

To do so, write the following in the file /home/wialon/wialon-pro/custom/system_env.sh:

# Optional environment configuration for launching Wialon as system service

# Uncomment following and insert correct user and group name if you like to launch

Wialon not as root user. Be sure that specified user has full control over installation directory:

ADF_USER="--user wialon"

ADF_GROUP="--group wialon"

After that, the servoce can be started by the command /home/wialon/wialon-pro/adf_script start.

Wialon Pro Guide

You are here:

Unattended Startup

Unattended startup of the monitoring service software in Debian -like systems is easy to set. To do this, choose the option Install Wialon B3 as system service while installing the distribution or create symbolic link to service startup script adf_script manually in /etc/init.d/: wialon-pro: / var / lib / wialonb3# ln -s $PWD/adf_script /etc/init.d/wialonb3

To activate automatic startup of the service execute the command: wialon-pro: / var / lib / wialonb3# update-rc.d wialonb3 defaults

To disable automatic sturtup execute another command: wialon-pro: / var / lib / wialonb3# update-rc.d -f wialonb3 remove

If you have installed Wialon and are planning to start it not as root user, please,

read the instructions

, otherwise when starting the server, it will be run as root user.

Wialon Pro Guide

You are here:

mailing system on the server

Cron Jobs

Cron jobs are automatic administrator's scripts. When installing Wialon, the installer requests automatic activation of these administrator's scripts:

...

Install periodic administrative jobs ( in current user crontab ) ? [ no ]

yes

...

OK, now is time to perform Wialon B3 installation. Check all parameters below are correct:

Wialon B3 will be installed in : / var / lib / wialonb3

...

Install Wialon B3 cron jobs :

yes

...

These scripts are located in the directory where Wialon is installed. At the first installation, you should edit the file

wialon-include-check.sh

– indicate e-mail to send notifications to and adjust notification topic:

EMAIL="[email protected]"

TOPIC="Wialon Pro"

For correct operation of the warning system it is required to set

To enable/disable a script, edit the file: for root user - /etc/crontab for ordinary user, the command crontab -e in the console

Here is an example of lines which fit to both cases to launch these scripts automatically. Add the lines to the end of the file and indicate the path to each script if needed.

0 * * * * /var/lib/wialonb3/wialon-errors-check.sh

*/2 * * * * /var/lib/wialonb3/wialon-service-check.sh

*/1 * * * * /var/lib/wialonb3/wialon-db-check.sh

The list of scripts:

wialon-db-check.sh is a once-a-minute control over DB driver and automatic restarting of the service in case of troubles.

wialon-service-check.sh is a script to check service operability every two minutes and restart it in case of unforeseen cessation.

wialon-errors-check.sh is an every hour check inspection of the service log file to detect such text as

error

(various errors) and notify the administrator about these cases.

wialon-include-check.sh contains an e -mail address and topic for notifications as well as checks scripts for their location correctness.

Wialon Pro Guide

You are here:

For Wialon Pro Client only

» Wialon Configuration

Wialon Configuration

Configuration parameters are mostly adjusted in the file ./custom/config.txt. The file is in UTF-8 format (without BOM), that is why be attentive while editing it in Windows OS. As an editor for this file in Windows, we recommend Notepad

++ .

Variable values are adjusted in the following way:

An example of the file:

# Email notifications from address

AVL_NOTIFICATIONS_EMAIL_FROM = [email protected]

# Email jobs from address

AVL_JOBS_EMAIL_FROM = [email protected]

# Optional service-wide reports visual configuration file

AVL_REPORTS_STYLES_FILE=$ADF_ROOT_PATH/custom/reports_config.xml

# CMS Manager site specification

CMS_MANAGER_WEBSERVER = cms_manager:8023:*

# Wialon Web site specification

WIALON_WEB_WEBSERVER = wialon_web:8022:*

WIALON_WEB_EMAIL_FROM = [email protected]

WIALON_WEB_ENABLE_LOG = 0

# Net server allowing network clients access

ADF_STORAGE_NET_SERVER = 31188:*

# SMTP server configuration

ADF_SMTP_SERVER = localhost

# GIS network server configuration

ADF_GIS_NET_REMOTE_SERVER = mapsviewer.com

# Wialon Admin site specification

AVL_ADMIN_WEBSERVER = avl_admin:8021:*

# Communications server configuration

ADF_AVL_COMM_SERVER = local:0:0:1

Note:

When reinstalling the system or installing updates, the installer does not replaces this file by original distribution files so that not losing your changes.

In the following sections Wialon configuration is described in details:

Wialon Pro Guide

You are here: Wialon Pro

»

Wialon Administration »

Wialon Configuration »

General Variables

Here are the parameters to configure devices connection and storage system. How parameters are set, read in

Wialon

Configuration

Variable

ADF_AVL_HW_BIND_ADDR

ADF_AVL_COMM_SERVER

Description

Network interface to listen to devices connections. Default value is '*', which means

'any interface'.

Communication server configuration. The format to set the parameter:

<comm-server-name>:<avl-server-host>:<avl-server-port>:<scan-hw_dir>. Default value is '31189'. The parameter scan-hw-dir is optional (by default, its value is '0'). It means enabling autoscanning of new devices types when the system is being initialized.

WIALON_AUTO_CREATE_UNITS

ADF_STORAGE_PATH

ADF_AVL_UNIT_HISTORY_PERIOD

WIALON_DISKSPACE_CHECKER

WIALON_DISKSPACE_EMAIL_FROM

WIALON_DISKSPACE_EMAIL_TO

ADF_SMTP_SERVER

ADF_STORAGE_NET_SERVER

If the value is '1', unit which does not exist in the system but sends messages, will be automatically created.

The path to storage files. Default directory is ./storage (in root directory).

The period to store unit history (in days). Used for database servers only. If not set or the value is '0', unit history is not deleted automatically.

A variable to control free space on the disk with storage. For example, if the variable value is

${ADF_ROOT_PATH}/storage/pd,30G,alert;${ADF_ROOT_PATH}/storage/pd,20G,stop

, then when 30GB is left, you will receive an e-mail notification about it, and when 20GB is left, the server will be stopped. By default, the variable is enabled. To disable it, remove it from the configuration file.

E-mail from which to send a warning about insufficient disk space.

Destination e-mail to send a warning about insufficient disk space.

SMTP server address is set in the form <host>:<port>. This server is used to send messages from software. By default, the local computer and the port 25 are used.

SMTP server must maintain the operation without authentication from monitoring server IP address.

For Wialon

Pro Client only

. Set the port and network interface address to listen connections by the form <port>:<IP address>. IP address can be skiped to listen on all local network interfaces. Default port is 31188. To initialize server part in the trusted mode to any connected user (that is the authorization is not needed, and the connected user has the maximum access to all local objects), the third parameter set as '1' is needed, for example, '31188:*:1'.

ADF_STORAGE_NET_REMOTE_SERVER

. Set the port and network interface address where Wialon

Pro is located (main database). The format is: <port>:<IP address>. Default port is

31188.

Wialon Pro Guide

You are here:

configuration file custom/config.txt.

Maps

All Wialon Pro products include an embedded WebGIS -3 server. All address information for online tracking and reports is taken only from this WebGIS. Wialon system deals with vector maps in the proper closed format AVD. Maps in AVD format are located in the maps directory.

After adding or deleting maps, the service automatically detects changes within several seconds. Precompiled maps in AVD format are available here .

Table of Contents

The size of RAM needed for normal operation of GIS is in direct proportion to the size of maps used. On average, GIS subsystem requires 512MB + 1.5*<total size of all maps files>.

Variables

This is a set of variables which can be added to your

Variable

WIALON_WEB_VISICOM_DEFAULT

Description

WIALON_WEB_DEFAULT_POS

WIALON_WEB_GOOGLE_KEYS

Set the default map position and zoom when the monitoring site is opened.

Enter latitude, longitude, and zoom level, separating them by colon (for example, WIALON_WEB_DEFAULT_POS = 55.739162:49.199269:9).

WIALON_WEB_WEBGIS_COPYRIGHT

If you use your own WebGIS maps, enter copyright text for them here. See

Creating Maps to learn how to create maps.

Keys to activate Google Maps API for different URLs. To use these maps, https://code.google.com/apis/console (get Google Maps API v2). How to set the value for this variable is described below.

WIALON_WEB_GOOGLE_DEFAULT

WIALON_WEB_YANDEX_KEYS

WIALON_WEB_YANDEX_DEFAULT

WIALON_WEB_NAVTEQ_KEYS

WIALON_WEB_REGIO_KEYS

WIALON_WEB_VISICOM_KEYS

If the value is on and Google Maps API keys are available, these maps will be enabled by default.

Keys to activate Yandex Maps for different URLs. To use these maps, get the key . How to set the value for this variable is described below.

If the value is on and Yandex Maps keys are available, these maps will be enabled by default.

The variable to activate Navteq Maps. To use this map, get the key .

The variable to activate Regio Maps (the Baltic region). To use this map, get the key .

The variable to activate Visicom Maps (Ukraine). To use this map, get the key .

If the value is on and Visicom key is available, this map will be enabled by default.

Google and Yandex Maps

The variables WIALON_WEB_GOOGLE_KEYS and WIALON_WEB_YANDEX_KEYS contain keys for proprietary cartographic systems linked to a certain URL.

For example, clients connect to Wialon Web server from two different URLs: http://local.dns.ru:8022 and http://remote.dns.ru. To activate Google and Yandex Maps, get activation keys for both URLs and enter them in the configuration file using the following scheme:

WIALON_WEB_GOOGLE_KEYS = <dns1<:port>> <KEY for dns1> <dns2> <KEY for dns2> ...

The result will be like this:

WIALON_WEB_GOOGLE_KEYS = local.dns.ru:8022 KEY_VALUE1 remote.dns.ru KEY_VALUE2

Note that:

DNS addresses are set without http: prefix;

If you use the standard port (80), it is not required to indicate it.

If the keys are entered correctly, the option to enable Google/Yandex Maps will appear in the User Settings dialog (in the monitoring site).

Wialon Pro Guide

You are here:

Sites

There are some parameters to configure monitoring and administration sites, CMS Manager, and Wialon Mobile.

Network parameters for any site are entered in the form <DNS-name>:<port-number>:<network-interface-IP-address>.

DNS name can simply indicate a unique server name or the real DNS name if the same port number is used by other servers Network interface IP address can be skipped or set as '*' to allow operating on all network interfaces.

Administration Site

AVL_ADMIN_WEBSERVER

Network parameters for administration site are set in the form: <DNSname>:<port-number>:<network-interface-IP-address>.

Default value is avl_admin:8021:*.

If the value is 1, the administrator can login to all sites.

CMS_ALLOW_ADMIN_LOGIN

WIALON_RESET_ADMIN_PASSWORD

This variable is necessary in case if service administrator have forgotten the password to login to the administration site. The default value is 0 (no password reset is needed). If the value is 1, a new password will be reset to the log during the nearest restart of the service. After applying the new password, do not forget to delete the variable or set its value as 0.

Monitoring Site (Wialon Web)

WIALON_WEB_WEBSERVER

WIALON_WEB_LANGUAGES

Network parameters for Wialon Web in the form <DNS-name>:<portnumber>:<network-interface-IP-address>. Default value is

wialon_web:8022:*

The list of additional languages for monitoring site interface. Separate the languages by semicolon. By default, English and Russian are available. For example, if fi:suomi is set, the Finnish will be added.

WIALON_WEB_DEFAULT_LANGUAGE Set the default language for the monitoring site in the form of <domain>.

WIALON_WEB_HIDE_ACCOUNT

Set this variable to hide account information in user settings (the list of services, their limit and costs). To set the variable, enter

WIALON_WEB_HIDE_ACCOUNT = on.

AVL_NOTIFICATIONS_EMAIL_FROM Form this e-mail address the notifications are sent by default.

AVL_JOBS_EMAIL_FROM The default e-mail address used to fulfill jobs.

AVL_UNIT_ICON_MAX_SIZE

AVL_UNIT_DEFAULT_ICON

The size of icon (in pixels) to display devices on the map and in the lists.

Default value is 64, maximum value is 256.

The path to the default icon used to display devices. If this parameter is not set, the plugin initializes it to proper file.

AVL_GROUP_DEFAULT_ICON

ADF_AVL_MAP_MARKERS_PATH

CMS_MANAGER_WEBSERVER

The path to icons used to display devices groups. If this parameter is not set, the plugin initializes it to proper file.

The location of image files used to display markers.

WIALON_WEB_EXT_JS

WIALON_WEB_HELP_URL

Custom JS can be used for the monitoring site. It is loaded from the URL address provided by this variable.

This is URL address of online documentation provided. The link to the documentation web site/page will be placed at the top right-hand corner. If this variable is not set, no links to help materials are displayed.

Managements Site (CMS Manager)

Default value is wialon_cms:8023:*. Management site (or CMS Manager) is designed to manage users and other system objects, assign access rights and perform some administration functions.

Wialon Mobile

The default value is wialon_mobile:8024:*. Mobile site has simplified interface

WIALON_MOBILE_WEBSERVER (in comparison with monitoring site) and allows to track devices via pocket

PCs or mobile phones.

Note that CMS Manager and Wialon Mobile are licensed separately and can be not included in your package.

Administration site is available only for users from the group of administrators.

Wialon Pro Guide

You are here:

Modems tab of administration site.

Modems

Variable to configure modems.

Variable Description

ADF_SERIAL_SMPP_REMOVE_PLUS

ADF_SERIAL_CONN_IDLE_TIMEOUT

For SMPP modems only.

If the value is 1, destination phone numbers are not supplied with the '+' sign at the beginning for sending SMS messages. Default value is 0.

ADF_SERIAL_SMPP_SKIP_GSM_ENCODING

For SMPP modems only.

The variable allows sending SMS messages in their initial state, that is not encoding special symbols of SMS text according to GSM specification. Default value is 0 (messages are encoded). If the value is 1, messages are not encoded.

For GSM modems only.

The variable is used in CSD queries. If data does not come during the indicated period of time, connection breaks automatically. Default value is 30 seconds.

ADF_SERIAL_SMPP_SRC_ADDR_TON

ADF_SERIAL_MAX_SMS_LENGTH

For SMPP modems only.

The type of source address number in SMS being sent. Default value is 0.

For SMPP and GSМ modems only. The maximum number of parts to divide a large SMS message. Default value is 3.

Configuring modems can be also fulfilled on the

Wialon Pro Guide

You are here: