ГидроВэб · документация
Перейти в сервис

Документация по установке программы для ЭВМ «ГидроВэб»

Правообладатель: ООО «ФЬЮТЕХ» (RU). Версия: 1.1.0-alpha. Документ актуализирован: 25.08.2026.

Программа для ЭВМ «ГидроВэб» распространяется как облачный сервис (модель SaaS). Установка программного обеспечения на технические средства пользователя, включая персональный компьютер эксперта, не требуется: работа ведётся через веб-браузер по сети «Интернет». Экземпляр программы уже развёрнут правообладателем на сервере, расположенном на территории Российской Федерации, и доступен для проверки.

Документ содержит две части:

— раздел 1 — порядок получения доступа к развёрнутому экземпляру (то, что необходимо выполнить проверяющему); — разделы 2–9 — порядок разворачивания экземпляра программы на сервере. Эта часть приводится в соответствии с требованием подраздела «Документация на программное обеспечение» методических рекомендаций и адресована администратору, разворачивающему собственный экземпляр; для экспертной проверки её выполнение не требуется.


1. Порядок получения доступа к развёрнутому экземпляру (установка не требуется)

1.1 Что необходимо проверяющему

ПараметрЗначение
Адрес экземпляра программыhttps://hydroweb.online
Способ доступаВеб-браузер, подключение к сети «Интернет»
Программное обеспечение на рабочем местеНе устанавливается; достаточно браузера
Учётная запись для проверкиВыдана правообладателем; логин и пароль приведены в документе «Информация, необходимая для эксплуатации экземпляра программного обеспечения»
Права доступа учётной записиПрофессиональный уровень — открыт весь заявленный функционал

1.2 Требования к рабочему месту

ПараметрЗначение
БраузерYandex Browser, Google Chrome, Mozilla Firefox, Microsoft Edge, Safari — актуальные версии
Поддержка технологийJavaScript, HTML5 (включены по умолчанию)
Разрешение экранаНе менее 1366 × 768
Канал связиДоступ к сети «Интернет», не менее 1 Мбит/с
Операционная системаЛюбая, в которой работает перечисленный браузер (Windows, Linux, macOS)

1.3 Последовательность действий

  1. Открыть в браузере адрес https://hydroweb.online.
  2. На странице входа указать адрес электронной почты и пароль выданной учётной записи.
  3. После входа откроется перечень проектов — программа готова к работе.
  4. Формирование документов (записка, спецификации, чертежи) выполняется на стороне

браузера: файлы сохраняются средствами браузера в каталог загрузок.

  1. Завершение работы — выход из учётной записи в меню пользователя либо закрытие вкладки

браузера; несохранённые изменения проекта при этом не теряются, так как проекты хранятся на сервере.

Никакие компоненты на рабочее место не устанавливаются и не требуют настройки; программная и аппаратная защита (ключи, лицензионные файлы) не применяется.


2. Требования к аппаратному и программному обеспечению сервера (для самостоятельного разворачивания)

2.1 Сервер

ПараметрМинимальноРекомендуется
Вычислительные ядра24
Оперативная память4 ГБ8 ГБ
Дисковое пространство20 ГБ30 ГБ (при использовании реестра заключений экспертизы — дополнительно около 3 ГБ)
Операционная системаUbuntu 22.04 LTS / Debian 12 или иной дистрибутив Linux с поддержкой контейнеровUbuntu 24.04 LTS
Системное ПОDocker Engine 24+ с Docker Compose, nginx (при использовании защищённого соединения)то же

Все компоненты системного ПО распространяются на условиях свободных лицензий и доступны из репозиториев дистрибутива. Проприетарное иностранное программное обеспечение для работы программы не требуется.

2.2 Рабочее место пользователя

Веб-браузер с поддержкой JavaScript: Yandex Browser, Google Chrome, Mozilla Firefox, Microsoft Edge, Safari — актуальные версии. Установка программного обеспечения на рабочее место не требуется.


3. Состав дистрибутива

Дистрибутив передаётся в виде исходных текстов и сборочных файлов и содержит:

Каталог / файлСодержимое
hydroweb/Серверная часть: расчётное ядро, программный интерфейс, подсистема хранения
frontend/Веб-интерфейс (исходные тексты и сборочная конфигурация)
DockerfileОписание сборки контейнера приложения
docker-compose.ymlОписание запуска и параметров среды
deploy/entrypoint.shСценарий запуска процессов внутри контейнера
deploy/nginx-site.confКонфигурация веб-сервера внутри контейнера
deploy/setup-server.shСценарий первичной подготовки сервера
deploy/deploy.shСценарий обновления экземпляра
pyproject.tomlПеречень зависимостей серверной части
frontend/package.jsonПеречень зависимостей веб-интерфейса

4. Первичная подготовка сервера

Выполняется однократно с правами суперпользователя. Сценарий deploy/setup-server.sh устанавливает Docker, создаёт непривилегированную учётную запись для развёртывания, подготавливает каталог приложения и настраивает межсетевой экран:

scp deploy/setup-server.sh root@<адрес-сервера>:
ssh root@<адрес-сервера> bash setup-server.sh

Действия сценария:

  1. обновление системных пакетов;
  2. установка Docker Engine и Docker Compose;
  3. создание учётной записи deploy с правом управления контейнерами;
  4. создание каталога приложения /opt/hydroweb;
  5. установка и настройка nginx на узле для терминирования защищённого соединения.

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


5. Настройка параметров среды

В каталоге приложения создаётся файл .env со значениями параметров. Файл не входит в дистрибутив и не подлежит передаче третьим лицам.

ПараметрОбязательностьНазначение
HYDROWEB_JWT_SECRETобязательныйСекрет подписи токенов доступа. Задаётся случайной строкой не короче 32 символов
HYDROWEB_CORS_ORIGINSобязательныйПеречень доменов, которым разрешены запросы к программному интерфейсу
HYDROWEB_FRONTEND_URLобязательныйАдрес сервиса; используется в ссылках писем подтверждения
UVICORN_WORKERSнеобязательныйЧисло рабочих процессов сервера приложений (по умолчанию 2)
EGRZ_DB_PATHнеобязательныйПуть к базе реестра заключений экспертизы
HYDROWEB_SMTP_HOST, _PORT, _USER, _PASSWORD, _FROM, _TLSнеобязательныеПараметры почтового сервера для писем подтверждения адреса
YANDEX_CLIENT_ID, YANDEX_CLIENT_SECRET, YANDEX_REDIRECT_URIнеобязательныеПараметры входа через Яндекс ID
HYDROWEB_AI_PROVIDER, HYDROWEB_YANDEX_API_KEY, HYDROWEB_YANDEX_FOLDER_IDнеобязательныеПараметры подсистемы помощи

При отсутствии необязательных параметров соответствующие функции отключаются, остальная функциональность сохраняется в полном объёме.


6. Сборка и запуск

6.1 Сборка веб-интерфейса

Выполняется на машине сборки; результат помещается в контейнер:

cd frontend
npm ci
npm run build

6.2 Запуск приложения

docker compose up -d --build

Команда собирает образ (устанавливая зависимости серверной части), создаёт том для данных и запускает контейнер. Внутри контейнера запускаются сервер приложений на порту 8000 и веб-сервер, публикующий интерфейс и проксирующий обращения к программному интерфейсу. Контейнер публикуется на локальном интерфейсе узла (127.0.0.1:8080), внешний доступ организуется через nginx узла с защищённым соединением.

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

curl -f http://localhost:8080/api/profiles
docker compose ps          # состояние должно быть healthy
docker compose logs -f     # журнал запуска

В образ встроена периодическая проверка работоспособности: при отказе приложения контейнер перезапускается автоматически (политика restart: unless-stopped).


7. Первичное наполнение данными

  1. Учётная запись администратора. Регистрируется через веб-интерфейс; адреса,

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

  1. Реестр заключений экспертизы (необязательно). Импортируется из файла реестра:
   docker compose exec hydroweb python scripts/import_egrz.py <путь-к-файлу>
  1. База знаний подсистемы помощи (необязательно). Поставляется в составе образа и

переносится в том данных при первом запуске автоматически.


8. Обновление экземпляра

Обновление выполняется сценарием deploy/deploy.sh, который собирает веб-интерфейс, переносит изменившиеся файлы на сервер и пересобирает контейнер:

bash deploy/deploy.sh <адрес-сервера>

Данные пользователей размещены в отдельном томе и при обновлении сохраняются. Схема базы данных при запуске приводится к актуальной автоматически.


9. Удаление

docker compose down          # остановка и удаление контейнера
docker volume rm hydroweb_hydroweb-data   # удаление данных (необратимо)
rm -rf /opt/hydroweb         # удаление файлов приложения