Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Указание параметров подключения клиентов к веб-приложению

При локальном или удаленном подключении к веб-приложению клиент-браузеры используют протокол WebSocket (веб-сокет). Настройте параметры веб-сокета в конфигурационном файле, указав, какие соединения будут использоваться: безопасные (SSL/TLS) или незащищенные.

Путь к конфигурационному файлу:

  • ОС Windows: C:\Program Files\Automiq\Alpha.HMI.WebViewer или C:\Program Files (x86)\Automiq\Alpha.HMI.WebViewer
  • ОС Linux: /opt/Automiq/Alpha.HMI.WebViewer/

Откройте файл alpha.hmi.webviewer.xml в текстовом редакторе для настройки параметров.

Указание сетевого адреса веб-сокета

Чтобы указать имя хоста или IP-адрес веб-сокета, перейдите к элементу WebSocket и пропишите значение атрибута Address. Eсли вы хотите просматривать мнемосхемы локально, укажите адрес localhost или 127.0.0.1. Eсли же вы будете подключаться к веб-приложению с удаленного компьютера, укажите внешний IP-адрес веб-сокета.

Дополнительно возможно указать несколько IP-адресов (или имён хостов) для веб-сокета. В этом случае внутри элемента WebSocket прописываются несколько вложенных тегов Address.

При такой конфигурации Alpha.HMI.WebViewer будет по кругу бесконечно перебирать указанные адреса до тех пор, пока не удастся установить соединение с одним из них. При потере соединения перебор возобновляется по тому же принципу.

ОС Windows

  • Пример с одним адресом:
<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
  <WebSocket Address="192.168.0.1" Port="8080"/>
  <Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project"/>
</Alpha.HMI.WebViewer>
  • Пример с несколькими адресами:
<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
 <WebSocket Port="8080">
    <Address>192.168.0.1</Address>
    <Address>192.168.0.2</Address>
    <Address>192.168.0.3</Address>
  </WebSocket>
<Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project"/>
</Alpha.HMI.WebViewer>

ОС Linux

  • Пример с одним адресом:
<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="/usr/bin/python3">
  <WebSocket Address="192.168.0.1" Port="8080"/>
  <Application ProjectPath="/home/user/TestProject/Test.hmi" WwwRoot="/var/www/webviewer.local/html"/>
</Alpha.HMI.WebViewer>
  • Пример с несколькими адресами:
<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="/usr/bin/python3">
 <WebSocket Port="8080">
    <Address>192.168.0.1</Address>
    <Address>192.168.0.2</Address>
    <Address>192.168.0.3</Address>
  </WebSocket>
<Application ProjectPath="/home/user/TestProject/Test.hmi" WwwRoot="/var/www/webviewer.local/html"/>
</Alpha.HMI.WebViewer>

Указание порта для незащищенных подключений

Чтобы указать порт для подключений по веб-сокету, перейдите к элементу WebSocket и пропишите значение атрибута Port. Eсли вы будете использовать незащищенные соединения, укажите порт 8080.

ОС Windows

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
  <WebSocket Address="192.168.0.1" Port="8080"/>
  <Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project"/>
</Alpha.HMI.WebViewer>

ОС Linux

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="/usr/bin/python3">
  <WebSocket Address="192.168.0.1" Port="8080"/>
  <Application ProjectPath="/home/user/TestProject/Test.hmi" WwwRoot="/var/www/webviewer.local/html"/>
</Alpha.HMI.WebViewer>

Указание параметров для безопасных подключений

Alpha.HMI.WebViewer поддерживает защищённые WebSocket-соединения на основе протоколов SSL/TLS.

Для настройки защищённого соединения перейдите к элементу WebSocket в конфигурационном файле и задайте следующие атрибуты:

  • SslPort - порт для защищённых WebSocket-соединений. Для использования безопасных соединений укажите порт 4430.
  • PrivateKeyPath - путь к файлу приватного ключа в формате .pem.
  • CertificatePath - путь к файлу SSL-сертификата в формате .pem.

ОС Windows

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
  <WebSocket
     Address="192.168.0.1"
     Port="8080"
     SslPort="4430"
     PrivateKeyPath="C:\Certs\private.pem"
     CertificatePath="C:\Certs\certificate.pem"
  /> <Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project"/> </Alpha.HMI.WebViewer>

ОС Linux

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="/usr/bin/python3">
  <WebSocket
     Address="192.168.0.1"
     Port="8080"
     SslPort="4430"
     PrivateKeyPath="/etc/certs/private.pem"
     CertificatePath="/etc/certs/certificate.pem"
  /> <Application ProjectPath="/home/user/TestProject/Test.hmi" WwwRoot="/var/www/webviewer.local/html"/> </Alpha.HMI.WebViewer>

Указание параметров Диффи–Хеллмана

В рамках SSL/TLS-соединения обмен ключами выполняется по протоколу Диффи–Хеллмана. По умолчанию Alpha.HMI.WebViewer автоматически генерирует необходимые DH-параметры. При необходимости вы можете использовать заранее сгенерированные DH-параметры. Для этого укажите путь к файлу с DH-параметрами в формате .pem в атрибуте DhParametersPath (путь к файлу с параметрами Диффи–Хеллмана в формате .pem).

Указание прокси-сервера

Прокси-сервер — это посредник, который принимает WebSocket-подключения от клиентских браузеров и перенаправляет их на внутренний адрес, по которому работает Alpha.HMI.WebViewer.

Прокси-сервер используется для следующих целей:

  • Сокрытие деталей внутренней сетевой инфраструктуры.
  • Интеграция с внешней авторизацией.
  • Доступ к Alpha.HMI.WebViewer из внешней сети. Позволяет клиентам из глобальной сети подключаться к Alpha.HMI.WebViewer, работающему в локальной сети, через публичный URL прокси-сервера, доступного в локальной и глобальной сетях.

Настройка прокси-сервера

Настройте прокси-сервер так, чтобы он перенаправлял WebSocket-запросы от клиентских браузеров на адрес и порт, указанные в параметрах Address, Port/ SslPort элемента WebSocket конфигурационного файла Alpha.HMI.WebViewer.

Выбор программного обеспечения для прокси-сервера и его настройка для перенаправления трафика на Alpha.HMI.WebViewer осуществляются пользователем самостоятельно.

Подробная инструкция по настройке Nginx в качестве прокси-сервера доступна в разделе Настройка веб-сервера Nginx для проксирования Alpha.HMI.WebViewer.

Настройка Alpha.HMI.WebViewer

В конфигурационном файле Alpha.HMI.WebViewer пропишите параметр ProxyUrl в элементе WebSocket. Остальные параметры подключения (Address, Port, SslPort и др.) указываются так же, как описано в разделах:

Если атрибут ProxyUrl указан, клиентские браузеры подключаются к Alpha.HMI.WebViewer через прокси-сервер по этому URL. Если ProxyUrl не указан, веб-приложение будет использовать для подключения адрес, сформированный на основе значений Address, Port/ SslPort.

Пример конфигурации

Рассмотрим настройку конфигурации для подключения по следующей схеме:

Описание схемы:

  • Alpha.HMI.WebViewer работает по внутреннему адресу 192.168.0.1:8080.
  • Прокси-сервер доступен клиентам по адресу wss://hmi.example.com/ws.
  • Прокси перенаправляет запросы с пути /ws на 192.168.0.1:8080.

Для данной схемы в конфигурационном файле задайте следующие параметры:

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
  <WebSocket
     Address="192.168.0.1"
     Port="8080"
     ProxyUrl="wss://hmi.example.com/ws" />
<Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project" />
</Alpha.HMI.WebViewer>

Пример настройки веб-сервера Nginx для проксирования Alpha.HMI.WebViewer

Ниже приведен пример настройки веб-сервера Nginx в качестве прокси-сервера для Alpha.HMI.WebViewer с безопасным HTTPS/WSS подключением. Nginx будет принимать WebSocket-подключения от клиентских браузеров и перенаправлять их на внутренний адрес Alpha.HMI.WebViewer.

Исходные данные:

  • Сервер с Ubuntu 20.04/22.04 (IP: 192.168.1.50) - прокси-сервер
  • Alpha.HMI.WebViewer работает на сервере 192.168.1.100:8080
  • Локальная сеть 192.168.1.0/24
  • Используется самоподписанный SSL-сертификат для локальной сети
  • Доступ осуществляется через локальный IP-адрес

Установка Nginx

  1. Установите Nginx.

    sudo apt install nginx -y
  2. Запустите Nginx и добавьте в автозагрузку.

    sudo systemctl start nginx
    sudo systemctl enable nginx
  3. Проверьте статус Nginx.

    sudo systemctl status nginx

    Должно отображаться:

    Active: active (running)

Настройка брандмауэра

  1. Проверьте текущие правила UFW.

    sudo ufw status
    # Если UFW неактивен, включите его:
    sudo ufw enable
  2. Разрешите HTTP и HTTPS трафик.

    sudo ufw allow 'Nginx Full'
  3. Разрешите внутренний трафик на порт 8080 (для связи с Alpha.HMI.WebViewer).

    sudo ufw allow from 192.168.1.0/24 to any port 8080
  4. Проверьте применение правил.

    sudo ufw status

    Должны отображаться строки:

    80/tcp                     ALLOW       Nginx Full
    443/tcp ALLOW Nginx Full
    8080 ALLOW 192.168.1.0/24

Создание самоподписанного SSL-сертификата

  1. Создайте каталог для SSL-сертификатов.

    sudo mkdir -p /etc/nginx/ssl
  2. Создайте приватный ключ.

    sudo openssl genrsa -out /etc/nginx/ssl/nginx.key 2048
  3. Создайте файл конфигурации для сертификата.

    sudo nano /etc/nginx/ssl/cert.conf

    Добавьте следующее содержимое:

    [req]
    default_bits = 2048
    prompt = no
    default_md = sha256
    distinguished_name = dn
    req_extensions = v3_req
    
    [dn]
    CN=192.168.1.50
    O=Internal Network
    L=Local
    ST=Local
    C=RU
    
    [v3_req]
    subjectAltName = @alt_names
    
    [alt_names]
    IP.1 = 192.168.1.50
    DNS.1 = localhost
  4. Создайте самоподписанный сертификат.

    sudo openssl req -new -x509 -key /etc/nginx/ssl/nginx.key -out /etc/nginx/ssl/nginx.crt -days 365 -config /etc/nginx/ssl/cert.conf -extensions v3_req
  5. Установите права доступа.

    sudo chmod 600 /etc/nginx/ssl/nginx.key
    sudo chmod 644 /etc/nginx/ssl/nginx.crt

Создание конфигурации Nginx

  1. Удалите стандартную конфигурацию.

    sudo rm /etc/nginx/sites-enabled/default
  2. Создайте новый файл конфигурации.

    sudo nano /etc/nginx/sites-available/webviewer
  3. Вставьте следующую конфигурацию:

    # Перенаправление HTTP на HTTPS
    server {
        listen 80;
        server_name 192.168.1.50;
        return 301 https://$server_name$request_uri;
    }
    
    # Основная конфигурация HTTPS
    server {
        listen 443 ssl http2;
        server_name 192.168.1.50;
    
        # Логирование
        access_log /var/log/nginx/hmi-access.log;
        error_log /var/log/nginx/hmi-error.log;
    
        # SSL сертификаты (самоподписанные)
        ssl_certificate /etc/nginx/ssl/nginx.crt;
        ssl_certificate_key /etc/nginx/ssl/nginx.key;
        ssl_protocols TLSv1.2 TLSv1.3;
        ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
        ssl_prefer_server_ciphers off;
        
        # Дополнительная безопасность
        add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
        add_header X-Frame-Options DENY always;
        add_header X-Content-Type-Options nosniff always;
    
        # Главная страница (опционально)
        location / {
            return 200 'Alpha.HMI.WebViewer Proxy Server - Local Network\nWebSocket endpoint: wss://192.168.1.50/websocket';
            add_header Content-Type text/plain;
        }
    
        # HTTP и WebSocket прокси для Alpha.HMI.WebViewer
        location /websocket {
            # Проксирование на внутренний сервер
            proxy_pass http://192.168.1.100:8080;
    
            # Заголовки для WebSocket
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
    
            # Заголовки клиента
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
    
            # Таймауты для WebSocket
            proxy_read_timeout 86400s;
            proxy_send_timeout 86400s;
            proxy_connect_timeout 5s;
    
            # Отключение буферизации
            proxy_buffering off;
            
            # Дополнительные заголовки для WebSocket
            proxy_set_header X-Forwarded-Host $server_name;
            proxy_set_header X-Forwarded-Port $server_port;
        }
    }
  4. Сохраните файл: Ctrl+X, затем Y, затем Enter.

Активация конфигурации

  1. Создайте символическую ссылку.

    sudo ln -s /etc/nginx/sites-available/webviewer /etc/nginx/sites-enabled/
  2. Проверьте синтаксис конфигурации.

    sudo nginx -t

    Должно отображаться:

    nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
    nginx: configuration file /etc/nginx/nginx.conf test is successful
  3. Перезагрузите Nginx.

    sudo systemctl reload nginx

Настройка Alpha.HMI.WebViewer

  1. В конфигурационном файле Alpha.HMI.WebViewer пропишите параметр ProxyUrl в элементе WebSocket.

    <?xml version="1.0" encoding="utf-8"?>
    <Alpha.HMI.WebViewer PythonPath="C:\Users\User1\AppData\Local\Programs\Python\Python37">
     <WebSocket
         Address="192.168.1.100"
         Port="8080"
         ProxyUrl="wss://192.168.1.50/websocket" />
    <Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project" />
    </Alpha.HMI.WebViewer>
  2. На любом клиентском устройстве в локальной сети 192.168.1.0/24 откройте браузер и перейдите по адресу: https://192.168.1.50/websocket

В результате клиенты смогут устанавливать защищённое WebSocket-соединение с Alpha.HMI.WebViewer через прокси-сервер по адресу: wss://192.168.1.50/websocket

Указание параметров восстановления сессии

При работе с веб-приложением возможно кратковременное прерывание соединения между клиентским браузером и Alpha.HMI.WebViewer (например, при смене сети, потере сигнала или временной недоступности канала связи). По умолчанию в таких случаях сессия пользователя завершается, и при восстановлении соединения создаётся новая сессия с начальным состоянием – открытые окна, введённые данные и другие действия пользователя теряются.

Чтобы обеспечить сохранение состояния и продолжение работы пользователя в рамках прежней сессии после восстановления связи, предусмотрен механизм автоматического восстановления сессии.

Чтобы включить механизм восстановления сессии, добавьте элемент Session в конфигурационном файле и задайте атрибут Timeout со значением больше 0.

При потере соединения в этом случае Alpha.HMI.WebViewer не завершает сессию немедленно, а сохраняет её активной в течение заданного тайм-аута (в секундах), ожидая восстановления связи. Если в течение указанного времени подключение восстанавливается, клиент продолжает работу в рамках текущей сессии. Если связь не восстанавливается – сессия закрывается.

Значение по умолчанию: 0 – механизм восстановления отключён.

Для своевременного обнаружения обрывов связи убедитесь, что в элементе WebSocket атрибут ConnectionTimeout не равен 0. По умолчанию используется значение 30 секунд.

ОС Windows

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="C:\Users\User_1\AppData\Local\Programs\Python\Python37">
ㅤㅤ<WebSocket Address="192.168.0.1" Port="8080"/>
ㅤㅤ<Session Timeout="120"/>
ㅤㅤ<Application ProjectPath="C:\HMI\WEB\Test.hmi" WwwRoot="D:\WebViewer-WwwRoot\Project"/> </Alpha.HMI.WebViewer>

ОС Linux

<?xml version="1.0" encoding="utf-8"?>
<Alpha.HMI.WebViewer PythonPath="/usr/bin/python3">
ㅤㅤ<WebSocket Address="192.168.0.1" Port="8080"/>
ㅤㅤ<Session Timeout="120"/>
ㅤㅤ<Application ProjectPath="/home/user/TestProject/Test.hmi" WwwRoot="/var/www/webviewer.local/html"/> </Alpha.HMI.WebViewer>