Техническое описание системы

Архитектура и взаимодействие

Оникс - клиент-серверное веб-приложение. Пользователь работает в браузере через HTTPS. Клиентская часть формирует интерфейс и обращается к серверной части через REST API; WebSocket и Socket.IO используются для взаимодействия в реальном времени.

Серверная часть реализует предметную логику, аутентификацию, разграничение доступа, работу с учебными программами, контентом, тестированием и отчётностью. Основные структурированные данные хранятся в MongoDB, кэш - в Redis. Файлы и загруженные учебные материалы хранятся отдельно от документов базы данных. Почтовые уведомления требуют настроенного SMTP-сервиса.

Доступ к СДО осуществляется через study.umcmrg.ru. Публичная информация о системе и документация размещены на портале НОЦ umcmrg.ru.

Основные компоненты

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

Уровень	Программные средства	Назначение
Клиент СДО	React 18.2.0, Next.js 14.2.35, Redux Toolkit, TypeScript	Пользовательский интерфейс и взаимодействие с API
API СДО	NestJS 10.4.17, Mongoose 7.8.7, Node.js	Серверная логика, управление доступом и обработка данных
Среда выполнения	Node.js 22.x, Docker, Docker Compose 2.x	Выполнение приложения и контейнерное развёртывание
Хранение данных	MongoDB, Redis, файловое хранилище	Основные данные, кэш и учебные материалы
Документы и уведомления	Puppeteer 23.2.2, Chrome, SheetJS 0.20.2, SMTP	Формирование документов, табличных выгрузок и почтовых уведомлений

Требования к техническим средствам

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

Область	Требования
Сервер	Базовая конфигурация: процессор с 2 ядрами, 2 ГГц; оперативная память 6 ГБ; дисковое пространство 15 ГБ без учёта учебных материалов и резервных копий
Хранилище	Дополнительный объём под учебные файлы, базы данных, журналы и резервные копии рассчитывается по фактическому наполнению
Рабочее место	Современный браузер с JavaScript, cookies и поддержкой HTTPS; PDF-просмотрщик для скачанных инструкций
Сеть	HTTPS-доступ к СДО; SMTP для отправки писем; доступ к внешним материалам только при их использовании в учебном контенте

Порядок установки и запуска

Установку и настройку выполняет администратор системы. Параметры подключения и конфигурационные файлы передаются по защищённым каналам.

Подготовить комплект поставки приложения, инструкции по развёртыванию и конфигурацию серверных сервисов.
Подготовить сервер, DNS, TLS-сертификат, среду Node.js 22.x и контейнерное окружение Docker с Docker Compose 2.x.
Настроить подключения к MongoDB и Redis, адреса приложения, параметры аутентификации, SMTP и постоянные каталоги хранения. Секреты и реквизиты доступа хранить отдельно от публичных материалов.
Установить зависимости и собрать клиентскую и серверную части приложения. Запустить сервисы в соответствии с инструкцией по развёртыванию.
Настроить обратный прокси и HTTPS. Ограничить сетевой доступ к базам данных и административным интерфейсам.
Настроить учётную запись администратора и почтовый сервис. Проверить вход, назначение программы, загрузку материалов, тестирование, отчётность и формирование документов.
Настроить резервное копирование и проверить восстановление в отдельном окружении.

Доступ и обработка данных

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

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