Генератор PDF-отчётов

Генератор PDF-отчётов (далее — генератор) — сервис, предназначенный для создания отчётов в формате PDF на основе данных сканирований, хранящихся в серверной части. Он поддерживает обработку данных из файлов в формате JSON, а также создание отчётов с возможностью локализации на различные языки.

Развёртывание

Подробную информацию о развёртывании можно найти в следующих разделах:

• Установка через Docker Compose
• Установка на GNU/Linux

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

Конфигурация сервиса задаётся через переменные окружения. По умолчанию эти переменные задаются в файле /etc/default/solidpoint-scan-report-generator.

Переменная	Значение по умолчанию	Описание
STATE_DIRECTORY	/tmp/reporter	Директория для хранения данных.
LOG_LEVEL	info	Уровень журналирования. Допустимые значения: info, warn, error.
LISTEN	localhost:9090	Адрес gRPC-сервиса для прослушивания серверной частью.

Предупреждение

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

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

Генератор отчётов прослушивает заданный в настройках адрес, используя протокол gRPC. Взаимодействие с генератором осуществляется с помощью HTTP API серверной части.

Примечание

Для получения более подробной информации о доступных методах HTTP API и их параметрах рекомендуется использовать спецификацию OpenAPI.

Примечания

1. Переменная STATE_DIRECTORY задаётся автоматически в systemd. Если для неё не будет никакого значения, то по умолчанию генератор будет работать в каталоге /tmp/reporter.

   При запуске генератор создаст следующие директории в своем рабочем каталоге:

   • /intermediate — для хранения промежуточных и временных файлов,
   • /reports — для хранения результатов генерации (отчётов).

   Генератор удаляет все промежуточные файлы при запуске, а также сразу после генерации.

2. При запуске генератор может установить браузер Сhrome, необходимый для его работы. Это занимает некоторое время и требуется только при обновлениях версии библиотеки. Установленный браузер хранится в домашней папке пользователя, запускающего генератор.

3. При стандартной установке из deb-пакета для генератора создается специальный системный пользователь solidpoint-scan-report-generator.

4. Запуск генератора пользователем root не предусмотрен (ограничение со стороны используемых компонентов). Это необходимо учитывать при запуске с помощью контейнеров.