yunkong2.admin/docs/ru/admin.md

Описание

Драйвер используется для обслуживания и настройки системы yunkong2 и всех установленных драйверов. Он представляет собой WEB-интерфейс по адресу <IP-Адрес сервера>:8081 и устанавливается вместе с yunkong2.

С помощью WEB-интерфейса, предоставляемого драйвером admin, реализуются следующие функции:

• Установка дополнительных драйверов
• Обзор объектов
• Обзор состояний объектов
• Управление пользователями и группами
• Просмотр журнал (лог-файл) работы системы
• Управление хостами (работа с распределенной системой - более одного хоста)

Установка

Этот драйвер устанавливается вместе с yunkong2, ручная установка не требуется.

Настройка

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

IP

IP-адрес с которого доступен драйвер (поддерживаются IPv4 и IPv6). Значение по-умолчанию 0.0.0.0, то есть возможно соединение на любой IP-адрес.

Изменять не желательно, можно потерять досуп!

Port

Порт, по которому доступен интерфейс драйвера. На сервере может быть запущено несколько WEB-сервисов и порт 8081 (настройка по-умолчанию) может быть занят, необходимо исключить конфликт занятого порта. Значение можно изменять.

Шифрование

Если необходимо использовать протокол HTTPS, необходимо отметить данную опцию.

Аутентификация

Если необходима аутентификация пользователя для работы с драйвером, необходимо отметить данную опцию (автоматически включится опция HTTPS).

Кэш

Необходимо отметить данную опцию, если планируется использовать кэш браузера.

Пользователь по-умолчанию

Если опция аутентификации отключена, то драйвер admin будет работать от имени пользователя по-умолчанию (выбирается из списка), в противном случае, от имени пользователя при аутентификации.

Проверка обновлений

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

Использование

В адресной строке WEB-браузера наберите: <IP-Адрес сервера>:8081

Вкладки

Главное окно интерфейса состоит из нескольких вкладок.

Вкладка "Драйвера"

Здесь можно установить или удалить экземпляры драйверов. В списке отображаются доступные для установки драйвера и их версии, а так же версии установленных. Обновить информацию по версиям можно с помощью кнопки в левом верхнем углу. В столбце Версия предусмотрена цветовая маркировка релиза драйвера (красный = в планах, желтый = бета-версия, оранжевый = альфа-версия, зеленый = финальная версия). Если установленная версия драйвера ниже версии на сервере (имеются обновления), то заголовок станет зеленым и появится в строке драйвера кнопка обновления. Если кнопка со знаком вопроса в последнем столбце активная, то нажав по ней, можно перейти на сайт Github для ознакомления с информацией об драйвере.

Вкладка "Настройки драйверов"

Здесь отображаются установленные экземпляры драйверов и осуществляется настройка/конфигурирование. Слева сверху находится кнопка включения режима эксперта - для отображения дополнительных настроек.

Настройки драйверов:

• Запуск/станов экземпляра драйвера
• Открытие всплывающего окна с настройками драйвера
• Кнопка перезапуска экземпляра драйвера
• Кнопка удаления экземпляра драйвера
• Если драйвер подразумевает собственный WEB-сервис, будет доступна кнопка перехода в новом окне.

Если щелкнуть на название драйвера в столбце Заголовок, можно изменить название экземпляра. В режиме эксперта появляются еще два столбца справа:

• Столбец Уровень - выбор из списка уровень подробности ведения журнала работы адаптера (debug, error, warn, info)
• Столбец Max. RAM - при необходимости можно ограничить выделение памяти ОЗУ для работы драйвера

Вкладка "Объекты"

На этой вкладке отображаются объекты системы (переменные, программы, устройства и пр.). По-умолчанию, системные объекты скрыты, их можно отобразить нажав кнопку Показать системные объекты слева сверху. С помощью кнопок со стрелками вверх/вниз можно загрузить/выгрузить объект(-ы) файлом JSON. В столбце справа можно нажатием кнопки вызвать окно настроек конкретного объекта (отдельной кнопкой настройки хранения истории) и удалить объекты. Если значения отображаются красным цветом, значит они еще не подтверждены - флаг ack = false.

Вкладка "Состояния"

Отображение в табличной форме состояний всех объектов системы. В шапке таблицы поля для ввода - фильтры для поиска объекта или группы объектов.

Вкладка "События"

Отображение в табличной форме изменений состояний объектов в режиме реального времени (можно приостановить, нажав справа сверху соответствующую кнопку).

Вкладки "Группы" и "Пользователи"

Добавление пользователей и групп, редактирование привилегий.

Вкладка "Категории"

Добавление/редактирование/удаление категорий (к примеру комнат для работы с адаптером Scenes).

Вкладка "Сервера"

Список серверов с установленным yunkong2, так же здесь отображается версия js-controller на каждом хосте. Если имеется новая версия, то заголовок вкладки будет отображаться зеленым цветом и появится кнопка обновления версии js-controller до актуальной. Запросить текущую версию (если отключено автоматическое обновление) можно с помощью кнопки Обновить информацию драйвера в левом нижнем углу окна. Так же возле имени хоста имеется кнопка перезагрузки js-controller (не OS).

Вкладка "Лог"

Здесь отображается журнал работы сервера. Сверху слева доступны поля для фильтрации записей. Можно отображать записи только указанного драйвера, либо всех (включая системный js-controller); можно выбрать уровень отображения лога (отладка, инфо, предупреждения, ошибки) и фильтровать по значениям.

Справа сверху находятся кнопки:

• Кнопка Задержать вывод сообщений - вывод сообщений на странице временно приостанавливается (например, когда сообщения появляются слишком быстро, чтобы не пропустить искомое)
• Кнопка Обновить протокол - обновить журнал вручную (сообщения должны выводиться в режиме онлайн при активной вкладке)
• Кнопка Скопировать протокол - сообщения на экране копируются в буфер обмена для дальнейшего использования (например, для вставки на форум, чтобы описать ошибку)
• Кнопки Очистить протокол на экране и Очистить протокол на сервере - соответственно очищает вывод сообщений на вкладке Лог и полностью удаляет сообщения из журнала на сервере (применять осторожно).

Вкладка "Скрипты"

Эта вкладка активна только если установлен драйвер Javascript/Coffescript Script Engine. Здесь можно создавать/удалять/редактировать скрипты для автоматизации. Более подробно смотри описание данного драйвера.

Вкладка "Node-red" и вкладки других драйверов

Эти вкладки видны только если включен соответствующие драйвер (см. пункт ниже).

Общие настройки

Справа сверху находятся кнопки общих настроек драйвера Admin:

• Кнопка Видимость вкладок - можно включать и отключать вкладки, а так же, при установке определенных драйверов, для которых существуют свои вкладки - добавлять их на страницу
• Кнопка Системные настройки - дополнительные настройки работы системы такие как: язык интерфейса, формат даты, единицы измерений, активный репозиторий и пр. (группа основные настройки); редактирование, добавление/удаление ссылок на репозитории (группа репозитории); добавление/удаление собственных сертификатов при использовании HTTPS (группа сертификаты); настройка анонимного сбора статистики (группа статистика)
• Кнопка Выйти - выход из системы.