Продукты
АКС Комплекс PTL RID Световые маяки Все продукты
Услуги Загрузки Оборудование Документация FAQ
Контакты
Документация · версия 3.0

Развёртывание и запуск RID API

Установка Linux-бинаря, настройка LED-дисплеев и проверка сервиса. Docker не требуется.

Требования

Быстрый старт

Установка
curl -fsSL https://pkg.whsoft.ru/rid_api/install.sh | sudo sh

# указать Redis и дисплеи
sudo nano /etc/rid_api/config.json

sudo systemctl restart rid-api
curl http://127.0.0.1:8000/_ping

Установщик поддерживает RID_VERSION=3.0 (закрепить версию) и RID_NO_START=1 (не запускать сервис).

Что делает install.sh. Проверяет SHA256 (и minisign, если установлен), создаёт пользователя rid и каталоги /opt/rid_api, /etc/rid_api, /var/lib/rid_api, ставит бинарь, конфиг-пример и unit rid-api.service, затем проверяет Redis.

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

Настройки задаются через JSON-файл. По умолчанию сервис ищет файл по пути /etc/rid_api/config.json. Путь можно переопределить переменной APP_CONFIG или флагом -config.

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

config.json
{
    "redis_url": "redis://127.0.0.1:6379",
    "displays": [
        {
            "display_ip": "192.168.0.195",
            "display_port": 502
        }
    ],
    "clean_displays_on_startup": false,
    "debug": false,
    "log_level": "info",
    "api_host": "0.0.0.0",
    "api_port": 8000,
    "telemetry_enabled": true,
    "telemetry_url": "https://telemetry.whsoft.ru"
}

Все параметры

ПараметрПо умолчаниюОписание
redis_urlredis://127.0.0.1:6379Адрес подключения к Redis
displays[]Список дисплеев: display_ip, display_port
clean_displays_on_startupfalseОчищать дисплеи при старте
debugfalseРежим отладки
log_levelinfoУровень журнала: debug, info, warn, error
log_file—Путь к файлу журнала (по умолчанию stdout)
log_max_size_mb100Максимальный размер файла журнала (МБ)
log_max_files5Количество ротируемых файлов
api_host0.0.0.0Адрес прослушивания
api_port8000Порт прослушивания
displays_ping_interval2Интервал опроса дисплеев (сек.)
displays_ping_timeout1Тайм-аут опроса (сек.)
displays_ping_threshold0.3Порог медленного ответа (сек.)
reconcile_interval5Интервал синхронизации состояния (сек.)
apply_timeout10Тайм-аут применения команды (сек.)
telemetry_enabledtrueОтправлять обезличенную телеметрию
telemetry_urlhttps://telemetry.whsoft.ruАдрес сервера телеметрии

Запуск и systemd

Установщик создаёт unit rid-api.service:

systemd
sudo systemctl status rid-api
sudo systemctl restart rid-api
sudo journalctl -u rid-api -f

Ручной запуск:

Запуск
APP_CONFIG=/etc/rid_api/config.json /opt/rid_api/rid-api

Флаги командной строки

ФлагПо умолчаниюОписание
-config/etc/rid_api/config.jsonПуть к файлу конфигурации (или URL)
-host0.0.0.0Адрес прослушивания
-port8000Порт прослушивания

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

ПеременнаяПо умолчаниюОписание
APP_CONFIG/etc/rid_api/config.jsonПуть к файлу конфигурации
REDIS_URLredis://127.0.0.1:6379Адрес подключения к Redis
API_HOST0.0.0.0Адрес прослушивания
API_PORT8000Порт прослушивания
DEBUGfalseРежим отладки (true или 1)
LOG_LEVELinfoУровень журнала
TELEMETRY10 или false — отключить телеметрию
TELEMETRY_URLhttps://telemetry.whsoft.ruАдрес сервера телеметрии
TELEMETRY_STATE_FILE/var/lib/rid_api/telemetry.jsonФайл состояния телеметрии (в systemd)

Приоритет применения настроек (от низшего к высшему):

  1. Значения по умолчанию в коде
  2. JSON-файл конфигурации
  3. Переменные окружения
  4. Флаги командной строки

Проверка работоспособности

Терминал
curl http://127.0.0.1:8000/_ping
# Ответ: {"pong": "pong"}

curl http://127.0.0.1:8000/health
curl http://127.0.0.1:8000/dashboard
curl http://127.0.0.1:8000/displays
curl http://127.0.0.1:8000/metrics

Коды ответа

АдресКодОписание
/_ping200Сервис запущен
/health200Redis доступен, дисплеи сконфигурированы
/health503Redis недоступен или нет сконфигурированных дисплеев

Обновление

Повторно запустите установщик — конфиг и состояние сохраняются:

Обновление
curl -fsSL https://pkg.whsoft.ru/rid_api/install.sh | sudo sh

# или закрепить конкретную версию
curl -fsSL https://pkg.whsoft.ru/rid_api/install.sh | sudo env RID_VERSION=3.0 sh

Фоновые процессы

Телеметрия

Сервис отправляет обезличенную телеметрию, чтобы улучшать продукт: версия, ОС, число дисплеев, счётчики использования и базовая надёжность. IP-адреса, данные оборудования и содержимое экранов не передаются.

Подробнее — Политика телеметрии.

Важные замечания

Только один экземпляр сервиса. Каждый дисплей поддерживает только одно Modbus-подключение. Запуск нескольких экземпляров RID, работающих с одними и теми же дисплеями, приведёт к ошибкам соединения.