Ручная установка — Windows

На этой странице описан процесс ручной установки решения Navixy On-premise на Windows. Мы рекомендуем использовать Windows Server 2016 или новее. Если вы хотите установить платформу на любую другую версию Windows, например на настольные версии, вы все равно можете применить это руководство, поскольку основные принципы и программное обеспечение одинаковы. Тем не менее, только серверные версии считаются надежным решением.

Полностью ручная установка Navixy On-premise для Windows предоставляется клиентам, которым требуется полный контроль над процессом установки или которые имеют требования к индивидуальной конфигурации. В общем случае рекомендуется выполнять автоматизированную установку на Linux, так как это гораздо проще и гибче не только для первоначальной инсталляции, но и для дальнейшего администрирования и обслуживания. Инструкции по установке на Windows доступны для тех клиентов, которые ориентированы на использование этой ОС исключительно из-за корпоративных требований или других внутренних причин.

Хотя платформа использует одинаковое стороннее программное обеспечение как на Linux, так и на Windows, основное различие в её работе заключается в том, как сервисы функционируют на Windows:

• Java-сервисы преобразуются в Windows-сервисы с помощью ПО YAJSW.

• Nginx не является службой, а обычной программой, работающей в фоновом режиме.

Для выполнения установки вам потребуется учётная запись Windows с администраторскими правами. Не имеет значения, локальная это учётная запись или доменная, поскольку платформа никак не связана с инфраструктурой домена. Вам нужны только достаточные права для её установки.

Установите необходимые предварительные компоненты

Скачайте и установите предварительно требуемое ПО, описанное в Server software документе. По сути, вам потребуются следующие компоненты, чтобы запустить платформу:

• MySQL 8.0 - требуется только Server, другие компоненты опциональны;

  • Для установки может потребоваться Microsoft Visual C++. Мастер установки уведомит вас об этом.

• Java SE Development Kit 21;

• Nginx - любая актуальная версия (не требует установки, достаточно распаковать);

В дополнение к базовым компонентам также рекомендуется установить следующее ПО для упрощения дальнейшей работы:

• Любой архиватор, способный распаковывать tar.gz файлы — например 7-Zip.

• Продвинутый текстовый редактор для работы с конфигурациями и большими лог-файлами — например Notepad++.

Настоятельно рекомендуется устанавливать стороннее ПО только из официальных ресурсов — желательно по ссылкам выше. Если ПО устанавливается из ненадежных источников, работоспособность не гарантируется.

Конфигурация MySQL

После установки MySQL Server необходимо внести изменения в его конфигурацию, чтобы платформа Navixy корректно работала с базой данных. Конфигурация задаётся в файле my.ini расположенном по следующему пути:

C:\ProgramData\MySQL\MySQL Server 8.0\my.ini

В этом файле необходимо установить параметры ниже в разделе [mysqld] соответствующем разделе. Если они уже присутствуют — измените их соответственно.

default-time-zone='+00:00'
sql-mode="NO_ENGINE_SUBSTITUTION"
innodb_buffer_pool_size=10G

The innodb_buffer_pool_size Параметр — это объём оперативной памяти, выделенной для MySQL. Настоятельно рекомендуется установить этот параметр на 70% от общего объёма оперативной памяти на вашем сервере (в гигабайтах).

После изменения конфигурации сохраните файл и перезапустите MySQL через оснастку служб Windows (services.msc), чтобы применить изменения.

Переменные окружения

Папки Java и MySQL bin должны быть указаны в системной переменной Windows PATH . Эти папки (по умолчанию) следующие:

• C:\Program Files\Java\jdk-21\bin

• C:\Program Files\MySQL\MySQL Server 8.0\bin

Папка установки Java также должна быть добавлена в новую системную переменную JAVA_HOME . Это требуется для корректной работы backend-сервисов

Имена папок могут отличаться между версиями, поэтому предварительно проверьте фактические пути.

Вы можете обновить переменные окружения следующими командами из командной строки:

setx /m Path "%PATH%;C:\Program Files\Java\jdk-21\bin;C:\Program Files\MySQL\MySQL Server 8.0\bin"
setx /m JAVA_HOME "C:\Program Files\Java\jdk-21"

Это создаст необходимые значения.

Вы также можете обновить переменную Path и JAVA_HOME вручную через свойства системы.

В результате у вас должны быть следующие значения:

Переменные окружения

После сохранения переменных откройте командную строку и проверьте версии ПО следующими командами:

mysql -V
java -version

Если команды возвращают версии, то переменные настроены правильно.

Версии ПО

Если вы видите ошибки вроде не является внутренней или внешней командой, проверьте указанные ранее пути.

Распакуйте платформу

Пакет дистрибутива Navixy предоставляется в виде архива .tar.gz. Последняя версия всегда доступна для скачивания по следующей ссылке:

⬇️ Скачать пакет Navixy On-premise

Поместите его в любую папку на сервере и распакуйте.

В пакете множество вложенных папок, поэтому будьте внимательны, чтобы не превысить ограничение Windows в 255 символов для длины пути к файлу.

Поместите папку navixy-package из архива в какую-нибудь директорию, например: C:\distrib\navixy-package

В дальнейшем это будет основной каталог дистрибутива. Далее в этой инструкции вы можете встретить пути вида ...navixy-package/db, что означает, что операции необходимо выполнять из этой папки и её подкаталогов.

После распаковки платформы и подготовки всех предварительных компонентов вы готовы начать установку Navixy платформы.

Базы данных Navixy

Сначала необходимо настроить базы данных MySQL. Рекомендуется работать с MySQL из командной строки. Подключитесь к MySQL как root пользователь с паролем, который вы задали при установке MySQL:

mysql -uroot -p

Выполните блок запросов ниже. Замените <PASSWORD> на новый пароль для navixy пользователя, запомните его, он понадобится вам позже.

CREATE USER navixy@'%' IDENTIFIED BY '<PASSWORD>' WITH MAX_QUERIES_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_USER_CONNECTIONS 0;
CREATE DATABASE google CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE DATABASE tracking CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT USAGE ON *.* to navixy@'%';
GRANT ALL PRIVILEGES ON google.* TO navixy@'%';
GRANT ALL PRIVILEGES ON tracking.* TO navixy@'%';

Это создаст пустые базы данных для дальнейшего использования.

Выйдите из MySQL и вернитесь в командную строку.

Содержимое базы данных

Измените директорию в командной строке на ...navixy-package\db.

Выполните следующую команду для импорта структуры таблиц прикладных данных:

mysql -uroot -p google < google.sql

После этого удалите файлы updates.sql и google.sql следующими командами, так как они не нужны на следующем шаге:

del updates.sql
del google.sql

Теперь импортируйте оставшиеся файлы в базу данных с помощью этой команды:

type *.sql | mysql -uroot -p google

Файловый сервер

Подключитесь к MySQL снова и выполните приведённый ниже SQL-запрос. Это позволит загружать файлы из мобильного приложения и веб-интерфейса на ваш сервер, что требуется при работе с формами полевых работ, обслуживанием транспортных средств и другими функциями. Измените api.domain.com на ваш домен для API и измените https на http если вы не используете SSL.

INSERT INTO google.file_storages (id, engine, config) values (1, 'local_fs', '{"base_path":"./files/","base_upload_url":"https://api.domain.com/file/upload","base_download_url":"https://api.domain.com/file/dl","secret":"s3cCr3Et","upload_credentials_ttl":"10m","is_dynamic_preview_enabled": true,"dynamic_preview_pattern":"(.+)/file/dl/(.+)","dynamic_preview_replace":"$1/file/preview/$2","security_module":{"type":"hashid","salt":"S4lTh45hV4lu3","ttl":"7d","min_length":8}}');

Значения параметров secret и salt рекомендуется задавать в виде случайной хеш-строки из букв и цифр.

Лицензионный ключ

Наконец, примените лицензионный ключ (fingerprint), который должен быть предоставлен Navixy. Он выглядит как длинная строка случайных символов.

Вставьте fingerprint в базу данных с помощью приведённого ниже запроса. Замените <FINGERPRINT> на полученное значение):

UPDATE google.variables SET value='<FINGERPRINT>' WHERE var='fingerprint';

Fingerprint динамический. Он обновляется каждый раз, когда ваш сервер соединяется с auth.navixy.com сервером лицензирования. Это происходит каждые 3 дня и при каждом запуске сервисов. Поэтому нет необходимости хранить его отдельно от платформы, так как он постоянно меняется. Также по этой причине вы не можете использовать его на нескольких инстансах. Ключ может применяться только для одного экземпляра Navixy On-premise.

Фронтенд

Следующим шагом является настройка фронтенда платформы Navixy On-premise — конфигурация веб-сервера Nginx и статических файлов пользовательского интерфейса.

Создайте nginx папку на диске C:.

md nginx

Скопируйте распакованный дистрибутив Nginx в C:\nginx.

папку Nginx

Статические файлы

Создайте папку с именем www в C:\nginx. Скопируйте папки panel-v2 и pro-ui из navixy-package в неё. Это папки, содержащие статические файлы сайта Navixy — фактически весь его видимый контент. Теперь необходимо переименовать файлы конфигурации:

• Откройте папку \panel-v2 и переименуйте файл PConfig.example.sa.js на в PConfig.js.

• Откройте папку \pro-ui и переименуйте Config.example.sa.js на в Config.js.

• Откройте папку \pro-ui\static и переименуйте app_config.example.sa.js на в app_config.js.

На всех вышеуказанных шагах просто удалите в именах файлов .example.sa Будьте внимательны, чтобы не перепутать файлы с похожими именами в папках.

Nginx

Добавьте следующие строки в http блок файла C:\nginx\conf\nginx.conf ::

include conf.d/*.conf;
server_names_hash_bucket_size 64;

Скопируйте папку с именем include из ...navixy-package\windows\nginx на в папку C:\nginx\conf

Создайте папку с именем conf.d в в папку. Эта папка будет содержать конфигурацию веб-сайта платформы.

Скопируйте эти файлы из ...navixy-package\windows\nginx в вновь созданную папку C:\nginx\conf\conf.d следующие файлы:

• map.conf

• navixy.conf

Если вы планируете использовать SSL-защиту на вашем сервере, чтобы сайт открывался по HTTPS, также скопируйте этот файл:

• navixy_ssl.conf

Теперь настройте navixy.conf и navixy_ssl.conf в соответствии со страницей Nginx configurations . Это основные конфигурационные файлы для веб-сервера, поэтому проявите повышенную осторожность при их редактировании.

Для настройки платформы на работу по HTTPS вам потребуется действительный SSL-сертификат, выпущенный для вашего домена, вместе с его приватным ключом. При отсутствии сертификата и соответствующего приватного ключа веб-сервер с опцией «443 ssl» не сможет запуститься. Чтобы узнать больше о SSL-сертификатах и их работе на платформе, пожалуйста, обратитесь к странице SSL certificates installation страницу.

После выполнения всех вышеописанных действий — запустите nginx.exe от имени администратора. Убедитесь, что он запущен в Диспетчере задач (обычно он имеет два или более процесса). Если он перестаёт работать, проверьте C:\nginx\logs\error.log на предмет ошибок и действуйте соответствующим образом.

Запуск Nginx

Бэкенд

Эта часть состоит из двух шагов: настройка Java-сервисов и преобразование их в Windows-сервисы.

Java-сервисы — предварительная конфигурация

Создайте java папку на диске C:.

md java

Скопируйте следующие папки из ...navixy-package на C:\java:

• api-server

• sms-server

• tcp-server

В каждой из этих папок переместите подпапку conf из подкаталога dist в папку сервиса. Для удобства выполните следующие команды в командной строке.

move C:\java\api-server\dist\conf C:\java\api-server\
move C:\java\sms-server\dist\conf C:\java\sms-server\
move C:\java\tcp-server\dist\conf C:\java\tcp-server\

Откройте поочерёдно каждую из трёх указанных conf подпапок и найдите внутри файлы db.properties . Это файлы для настройки сервисов платформы для подключения к базе данных. Для корректной работы каждого сервиса вам необходимо обновить учётные данные подключения к базе данных в каждом из них. Отредактируйте следующие строки в конфигурационных файлах (<PASSWORD> указывает на пароль, который вы ранее создали для пользователя "navixy")

db.username=navixy
db.password=<PASSWORD>

Если ваша база данных расположена на отдельном сервере, вам также нужно изменить строку db.connectionString в тех же файлах. Укажите фактический адрес вашего сервера базы данных вместо localhost, но не меняйте другие части этой строки.

Java-сервисы — API-server

Откройте файл C:\java\api-server\conf\config.properties.

Отредактируйте следующие строки:

• api.externalBaseUrl= - URL вашего API-домена (с http:// или https:// в начале). i

• feedback.toEmail=test@localhost - адрес для получения обращений/запросов в техподдержку от пользователей.

• feedback.defaultFromEmail=do-not-reply@localhsot - e-mail по умолчанию, от которого отправляются письма техподдержки.

• feedback.substituteFromEmail=false - переключатель, указывающий, отправляются ли сообщения техподдержки от e-mail по умолчанию (false) или от личного адреса пользователя (true).

Если у вас нет выделенного домена для API, здесь указывается ваш базовый домен с добавлением /api в конце, например: https://my.domain.com/api

Java-сервисы — SMS-server

Этот сервис не требует конфигурации и использует настройки по умолчанию.

Java-сервисы — TCP-server

Откройте файл C:\java\tcp-server\conf\config.properties.

Отредактируйте следующие строки:

• externalIP=127.0.0.1 - укажите IP-адрес вашего пользовательского интерфейса вместо 127.0.0.1.

• externalHostname=myhost.ru - укажите домен вашего пользовательского интерфейса вместо myhost.ru.

Вышеуказанные настройки будут использованы для автоматической активации устройств.

Java-сервисы — преобразование в Windows-сервисы

На этом этапе используется стороннее ПО — YAJSW (Yet Another Java Service Wrapper). Это бесплатное ПО, используемое для запуска Java-приложений как Windows-сервисов. Дополнительную информацию можно найти на странице проекта. Само ПО включено в пакет Navixy.

Скопируйте папку с именем wrapper из из ...navixy-package\windows на C:\java.

Запустите командную строку от имени администратора и перейдите в следующую директорию:

cd C:\java\wrapper\bat

Выполните setenv.bat из этой директории в командной строке.

setenv.bat

Выполните следующие команды по очереди:

wrapper.bat -i ../conf/wrapper.api-server.conf
wrapper.bat -i ../conf/wrapper.sms-server.conf
wrapper.bat -i ../conf/wrapper.tcp-server.conf

Это установит Java-сервисы платформы как обычные Windows-сервисы.

Откройте Оснастка «Службы» . Вы можете найти её через меню «Пуск» или просто выполнить следующее в cmd:

services.msc

Просмотрите список служб и найдите недавно установленные сервисы Navixy. Запустите их по одному.

• Navixy api-server

• Navixy sms-server

• Navixy tcp-server

Windows-сервисы Navixy

Убедитесь, что службы продолжают работать со временем — их статус должен постоянно быть «Running». Если какой-либо из них падает, проверьте их логи на наличие возможных ошибок.

Заключительные шаги

Доступ к панели администратора

Когда всё установлено и запущено, проверьте доступность домена панели администратора в браузере. При указании его в адресной строке вы должны перейти на страницу входа. Если домен не перенаправляет вас на нужную страницу, ещё раз проверьте настройки веб-сервера, чтобы убедиться в их корректности.

Рассмотрите возможность смены пароля для панели администратора сразу после входа в систему, поскольку учётные данные по умолчанию:

• имя пользователя: admin

• пароль: admin

Доступ к пользовательскому интерфейсу

Чтобы пользовательский интерфейс был доступен, сначала необходимо указать его домен в панели администратора → Service Preferences, как описано в этом документе: Domain name.

Если вышеуказанное не выполнено, пользовательский интерфейс не сможет открыться.

Обновления

Чтобы обновить Navixy, развернутый на системе Windows, до самой актуальной версии, пожалуйста, обратитесь к этому документу: Update on Windows

Устранение неполадок

Если вы столкнулись с какими-либо проблемами в процессе установки или настройки, пожалуйста, обратитесь к Устранение неполадок страницам с возможными решениями.