ИНФОРМАЦИЯ, НЕОБХОДИМАЯ ДЛЯ УСТАНОВКИ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ
ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ «ВИЗОГРАФ»
Установка и первоначальный запуск
Настоящий документ описывает порядок установки и первоначального запуска программного обеспечения «Визограф» в инфраструктуре заказчика: подготовку окружения, размещение компонентов, настройку соединений, запуск и проверку работоспособности.
Документ предназначен для специалиста, выполняющего развёртывание серверного программного обеспечения. Для установки необходимы права на управление серверной средой, размещение файлов, настройку служб и сетевых соединений.
Документ содержит общий порядок установки и проверки системы. Комплект поставки дополняет его образами компонентов, файлами конфигурации и сведениями об их применении для соответствующей версии. Индивидуальные значения — адреса серверов, каталоги хранения, учётные данные и лицензионные материалы — определяются при подготовке конкретной установки.
Пользователи работают с «Визографом» через браузер. Установка отдельного клиентского приложения на рабочие места для доступа к веб-интерфейсу не требуется.
В документе рассматривается конфигурация со следующими компонентами:
| Компонент | Назначение |
|---|---|
| Серверное приложение «Визограф» с браузерным интерфейсом | Приём документов, управление обработкой, предоставление пользовательских и интеграционных функций |
| PostgreSQL | Хранение настроек, метаданных, состояний задач и результатов обработки |
| Файловое хранилище | Хранение исходных документов и производных файлов |
| Служба подготовки документов | Подготовка и преобразование документов для обработки |
| Локальная среда распознавания текста | Распознавание текста и координат текстовых областей внутри инфраструктуры заказчика |
| Агент лицензирования | Предоставление приложению сведений о состоянии лицензии |
Для сценариев с языковой моделью настраивается подключение к внешней службе с программным интерфейсом, совместимым с OpenAI и доступным по HTTPS. Эта служба не входит в состав развёртываемой системы. Её адрес, модель и условия доступа определяются отдельно. Для локального распознавания текста в сценарии «Только OCR-текст» подключение к языковой модели не требуется. Если предполагается использование сценариев с языковой моделью, её настройка и проверка обязательны до начала работы с этими сценариями.
Средства выпуска лицензий не входят в состав устанавливаемой системы и не требуются для штатной обработки документов.
3.1. Серверное окружение
До начала установки необходимо подготовить:
Совместимые версии системного программного обеспечения и объём ресурсов согласуются для конкретной поставки с учётом состава компонентов, видов документов, объёма обработки и срока хранения данных.
3.2. Сетевые соединения
Необходимо обеспечить следующие соединения:
| Направление | Назначение |
|---|---|
| Рабочее место пользователя → веб-интерфейс «Визографа» | Доступ через браузер по HTTPS |
| Сервер «Визографа» → PostgreSQL | Чтение и запись прикладных данных |
| Сервер «Визографа» → служба подготовки документов | Подготовка документов |
| Сервер «Визографа» → локальная среда распознавания текста | Выполнение распознавания |
| Сервер «Визографа» → агент лицензирования | Получение лицензионного состояния |
| Сервер «Визографа» → внешняя служба языковой модели | Соединение по HTTPS, необходимое только для сценариев с языковой моделью |
Внутренние службы и база данных не требуют прямого доступа с рабочих мест пользователей. Разрешения сетевого доступа настраиваются только для необходимых взаимодействий. Серверному приложению также предоставляются права чтения и записи в выделенное файловое хранилище.
На этапе подготовки требуется обеспечить получение образов компонентов и моделей распознавания выбранной поставки. Потребность в доступе к внешним источникам зависит от того, какие материалы уже включены в полученный комплект. Обращение к внешней языковой модели требуется при выполнении использующих её сценариев.
3.3. Рабочее место пользователя
Для работы необходим браузер с поддержкой JavaScript и доступ к адресу опубликованного веб-интерфейса по HTTPS. Используемый браузер должен доверять сертификату сервера. При проверке обработки на рабочем месте должен быть доступен контрольный файл для загрузки.
Результат подготовки: выделены ресурсы и постоянное хранилище, подготовлена среда запуска, определены адрес веб-интерфейса и необходимые сетевые соединения.
Параметры доступа и секреты передаются отдельно по согласованному защищённому каналу. В общедоступной документации они не приводятся.
Ожидаемый результат: доступны компоненты нужной версии, технические материалы и параметры, необходимые для их размещения и настройки. При неполном комплекте или обнаруженном несоответствии следует уточнить состав поставки до продолжения установки.
5.1. Размещение
При установке нового экземпляра используйте отдельные хранилища. Не заменяйте существующие базы данных и каталоги другого экземпляра. Если выбранное окружение уже содержит рабочую установку, дальнейшие действия должны выполняться по согласованному порядку обновления или переноса с предварительным резервным копированием.
Ожидаемый результат: компоненты размещены, постоянные данные отделены от заменяемых контейнеров, сетевые соединения и права доступа подготовлены.
5.2. Настройки до первого запуска
До запуска задайте инфраструктурные параметры в конфигурации Docker Compose, настройках серверного приложения и связанных служб. Конкретные имена файлов и способы передачи параметров указываются в комплекте соответствующей версии.
| Область | Что задать и проверить |
|---|---|
| База данных | Выберите PostgreSQL, задайте адрес, имя базы и учётные данные. Для описанной процедуры включите автоматическую миграцию; учётной записи нужны права на инициализацию структуры базы |
| Постоянные хранилища | Подключите каталоги или тома базы данных, документов и лицензионного состояния; проверьте права служб на чтение и запись |
| Подготовка документов | В настройках приложения включите службу подготовки документов и задайте её внутренний адрес |
| Локальное распознавание | В настройках приложения включите OCR; подготовьте среду выполнения, модели и сетевое соединение с ней |
| Лицензирование | В настройках приложения задайте адрес агента лицензирования; подключите постоянное хранилище его состояния |
| Первый администратор | В защищённых настройках приложения задайте код первоначальной настройки. Он потребуется для создания первого администратора через веб-интерфейс |
| Веб-доступ | В конфигурации публикации задайте адрес HTTPS и сертификат; проверьте передачу запросов серверному приложению |
Адреса внутренних служб должны быть доступны из среды выполнения серверного приложения. До создания первого администратора ограничьте доступ к веб-интерфейсу лицами, выполняющими установку.
Секреты размещаются в предусмотренных для этого настройках с ограничением доступа. Не используйте учётные данные из примеров или другого экземпляра. Код первоначальной настройки также относится к секретам и не публикуется.
Ожидаемый результат: подготовлены соединения, постоянные хранилища и параметры запуска; определён код для защищённого создания первого администратора.
5.3. Настройки после первого входа
После запуска и создания администратора завершите настройку через административные разделы веб-интерфейса:
| Раздел | Действия и проверка |
|---|---|
| «Провайдеры OCR» | Настройте и активируйте профиль локального распознавания с параметрами связи со средой выполнения. Проверьте распознавание контрольного документа |
| «Провайдеры LLM» — только для сценариев с языковой моделью | Задайте адрес, модель и учётные данные; сохраните и активируйте профиль. Проверьте обработку в сценарии с языковой моделью |
| «Лицензия» | Проверьте состояние лицензии; при необходимости выполните активацию. Убедитесь, что нужные операции разрешены |
| Проекты, конфигурации и пользователи | Подготовьте проект и права доступа. Для классификации и извлечения настройте типы документов и поля; для проверки используйте соответствующую конфигурацию |
Если прикладные настройки уже подготовлены в поставке, проверьте их значения и работоспособность. Параметры LLM не требуются для проверки локального сценария «Только OCR-текст».
Ожидаемый результат: веб-интерфейс доступен, административный вход выполнен, лицензия разрешает обработку, необходимые службы подключены и подготовлен проект для проверки.
Проверка проводится на контрольном документе без конфиденциальных данных с заранее известным содержимым. Для проверки локального OCR используйте сканированный документ с читаемым текстом. Для проверки классификации и извлечения дополнительно подготовьте в конфигурации проекта соответствующий тип документа и поля.
Критерий завершения установки: система доступна по HTTPS, пользователь может войти, локальное распознавание и подготовка документов работают, результаты сохраняются и доступны для просмотра. Для использования сценариев с языковой моделью дополнительно должна быть успешно проверена её работа. Без такого подключения установка может использоваться для локального OCR; готовность к классификации и извлечению через LLM при этом не подтверждена. Доступность одной страницы входа не заменяет проверку обработки.
Зафиксируйте установленную версию, дату проверки и результаты контрольных сценариев. Адрес экземпляра, сведения о доступе и параметры его сопровождения передаются ответственному за эксплуатацию отдельно.
| Наблюдаемый признак | Действие |
|---|---|
| Веб-интерфейс недоступен | Проверьте состояние приложения, адрес публикации, сетевые разрешения и настройку HTTPS |
| Приложение сообщает об ошибке базы данных | Проверьте доступность PostgreSQL, параметры подключения, права учётной записи и журнал запуска приложения |
| Ошибка чтения или сохранения файлов | Проверьте подключение постоянных хранилищ, права доступа и свободное дисковое пространство |
| Не выполняется подготовка документа | Проверьте состояние службы подготовки документов, её доступность для приложения и поддержку формата документа |
| Не выполняется локальное распознавание | Проверьте включение OCR, профиль распознавания, состояние локальной среды и доступность моделей |
| Ошибка обращения к языковой модели в использующем её сценарии | Проверьте адрес службы, выбранную модель, учётные данные и исходящее соединение по HTTPS |
| Новая обработка недоступна из-за лицензии | Проверьте лицензионное состояние, доступность агента лицензирования и соответствие лицензии установленному экземпляру |
Диагностику выполняйте по состоянию компонентов и журналам соответствующих служб. Если причина не устранена, обратитесь к поставщику по каналу сопровождения, согласованному для поставки. Укажите версию, этап установки и текст ошибки; перед передачей журналов исключите пароли, ключи доступа и содержимое обрабатываемых документов.
Не удаляйте базу данных, документы или лицензионное состояние для устранения ошибки установки. Не отключайте проверку сертификатов и средства защиты как универсальный способ восстановления доступа.