Документация, содержащая информацию, необходимую для эксплуатации экземпляра программного обеспечения, предоставленного для проведения экспертной проверки
Титульные данные
| Поле | Значение |
|---|
| Наименование ПО | Inventions |
| Условное обозначение / версия | 1.0 |
| Правообладатель | ООО «ДИТЕКС» |
| Дата документа | 15.06.2026 |
| Назначение экземпляра | Экземпляр для проведения экспертной проверки в целях включения в реестр российского ПО |
1. Назначение документа
Настоящий документ подготовлен в соответствии с п. 2.1.4 методических рекомендаций по работе с ФГИС «Реестры программ для ЭВМ и баз данных» и содержит информацию, необходимую для эксплуатации экспертного экземпляра ПО Inventions: размещение экземпляра, последовательность загрузки и управления, режимы работы, мониторинг и типовые неисправности.
2. Размещение экспертного экземпляра
2.1. Ссылка на развёрнутый экземпляр
| Параметр | Значение |
|---|
| URL веб-интерфейса | _________________________ (например, https://<хост>:7777/) |
| URL API backend (прямой доступ) | _________________________ (например, http://<хост>:13680/) |
| URL Swagger | _________________________ (например, http://<хост>:13680/api) |
| Способ доступа | HTTP(S); при удалённом стенде — VPN/SSH по согласованию |
При самостоятельном развёртывании экспертом используются инсталлируемые компоненты — Docker-образы из реестра HUB согласно 01-instruktsiya-po-ustanovke.md.
2.2. Состав комплекса
| Компонент | Сервис Compose | Порт (контейнер) | Порт хоста (по умолчанию) |
|---|
| Веб-клиент + nginx | frontend | 80 | FRONTEND_PORT (7777) |
| Сервер приложений | backend | 8080 | BACKEND_PORT (13680) |
| TimescaleDB (опц.) | timescaledb | 5432 | POSTGRES_PORT (5434) |
| Redis (опц.) | redis | 6379 | REDIS_PORT (6379) |
2.3. Схема взаимодействия
3. Последовательность действий: загрузка, запуск, выполнение, завершение
3.1. Загрузка (развёртывание)
| Шаг | Команда / действие | Описание |
|---|
| 1 | Подготовить .env | HUB, DATABASE_URL, REDIS_URL, JWT_SECRET |
| 2 | docker compose pull | Загрузка образов из реестра |
| 3 | Поднять БД и Redis | docker compose --profile db up -d или внешние сервисы |
| 4 | Применить миграции | pnpm --filter @repo/database db:migrate:deploy |
| 5 | docker compose up -d | Запуск frontend и backend |
3.2. Запуск и проверка готовности
| Действие пользователя / оператора | Ответ системы |
|---|
| Открыть URL веб-интерфейса | Страница входа /login или главная (при активной сессии) |
GET /health/live | 200 OK — процесс backend жив |
GET /health/ready | 200 OK — БД, Redis, адаптеры готовы; иначе 503 с детализацией |
3.3. Выполнение (управление программой пользователем)
Пользователь работает через веб-браузер. Основные действия:
| Действие | Способ | Ответ программы |
|---|
| Вход | Форма /login, POST /api/auth/... | Установка httpOnly-cookie сессии; редирект в приложение |
| Просмотр продуктов | Навигация UI, GET /api/products | JSON со списком; отрисовка в UI |
| Работа с гипотезами | UI, GET/POST /api/hypotheses | Данные гипотез, графики аналитики |
| Выход | POST /api/auth/logout (или аналог) | Очистка сессии |
| API-запросы (отладка) | Swagger /api, curl с cookie | JSON-ответы REST API |
Оператор управляет контейнерами через Docker Compose:
| Команда | Назначение |
|---|
docker compose ps | Статус сервисов |
docker compose logs -f backend | Журнал backend |
docker compose restart backend | Перезапуск backend |
docker compose stop | Плановая остановка |
3.4. Завершение работы
| Сценарий | Действие |
|---|
| Завершение сессии пользователя | Выход через UI или истечение refresh-токена |
| Плановая остановка стенда | docker compose down |
| Аварийная остановка | docker compose kill или остановка Docker на хосте |
4. Учётные данные для экспертов
| Параметр | Значение |
|---|
| Логин | _________________________ |
| Пароль | _________________________ |
| Примечание | Тестовая учётная запись предоставляется правообладателем; возможна регистрация через /login |
5. Режимы работы
| Режим | Действия оператора |
|---|
| Штатная работа | Контейнеры up; /health/ready успешен |
| Плановая остановка | docker compose stop / down |
| Плановое обновление | Новые теги образов, pull, up -d, миграции |
| Аварийная остановка | Остановка compose, блокировка портов |
6. Переменные окружения
Полный перечень: 01-instruktsiya-po-ustanovke.md (раздел 5), backend/apps/core-backend/.env.example.
Оператор обязан защищать JWT_SECRET, OAuth-секреты, REDIS_URL с паролем.
7. Резервное копирование
- PostgreSQL — схемы
users, analytics, sync; см. scripts/analytics-db/README.md.
- Redis — по политике правообладателя (очереди обычно допускают volatile-данные).
Пример дампа:
pg_dump --format=custom --file=inventions_backup.dump "<DATABASE_URL>"
8. Мониторинг и журналирование
| Источник | Содержание |
|---|
docker compose logs backend | Логи NestJS, [cid=…], [ALERT] |
docker compose logs frontend | nginx, Next.js |
/health/live, /health/ready | Состояние сервиса |
| OpenTelemetry (опц.) | OTEL_EXPORTER_OTLP_ENDPOINT |
9. Типовые неисправности
| Симптом | Причина | Действия |
|---|
503 readiness / redis | Redis недоступен | Проверить REDIS_URL, сеть |
503 readiness / timescale | БД, миграции | DATABASE_URL, миграции |
502 на /api/ | backend недоступен | docker compose ps, BACKEND_UPSTREAM |
| 401 | Сессия, JWT | Cookies, JWT_SECRET |
| Пустые разделы UI | Нет доменного API в поставке | См. 02-opisanie-funktsionalnyh-harakteristik.md |
10. Контакты эксплуатационной поддержки
| Роль | Контакт |
|---|
| Линия поддержки ООО «ДИТЕКС» | _________________________ |
| Ответственный за стенд экспертизы | _________________________ |
Документ подготовлен ООО «ДИТЕКС» в соответствии с п. 2.1.4 методических рекомендаций ФГИС «Реестры ПО».