Документация Ломть LMS

Страница содержит документацию на программное обеспечение «Ломть LMS»: описание функциональных характеристик, сведения, необходимые для установки и эксплуатации, порядок технической поддержки и демонстрационный доступ для ознакомления.

1. Общие сведения

Наименование ПО	Ломть LMS (LOMT LMS)
Назначение	Система управления обучением (learning management system) для организации и сопровождения онлайн-курсов
Версия	1.0.0
Правообладатель	ИП Овчаренко Андрей Александрович, ИНН 611602008192, ОГРНИП 318619600238627
Страна происхождения	Российская Федерация
Лицензия	GNU General Public License версии 3 (открытая лицензия, безвозмездно)
Тип поставки	Исполняемый JAR-файл, образ контейнера Docker, облачный экземпляр правообладателя
Работающий экземпляр	https://lms.lomt.ru/
Техническая поддержка	Российская Федерация, электронная почта a@lomt.ru

Программное обеспечение представляет собой серверное веб-приложение на языке Java (Spring Boot, Vaadin) с хранением данных в СУБД PostgreSQL. Работа пользователей ведётся в веб-браузере, установка клиентского программного обеспечения не требуется. Принудительное обновление и управление программным обеспечением из-за пределов Российской Федерации не предусмотрены.

2. Функциональные характеристики

2.1. Аутентификация и разграничение доступа

Вход по адресу электронной почты и паролю; пароли хранятся в виде необратимых криптографических хэшей (BCrypt).
Две роли пользователей: администратор (ADMIN) и ученик (STUDENT), с разграничением доступа к разделам администрирования и личного кабинета ученика.
Статусы учётной записи ученика: активна, заблокирована. Блокировка и разблокировка выполняются администратором.
Автоматическое создание первой учётной записи администратора при первичном развёртывании из параметров конфигурации.
Журналирование действий: успешные и неуспешные входы, выход, переходы между разделами, операции над учениками, курсами, уроками, материалами, заданиями, назначениями и работами.

2.2. Управление учениками

Создание, редактирование и просмотр списка учеников: фамилия, имя, отчество, адрес электронной почты, статус.
Поиск и фильтрация учеников в списке.

2.3. Управление курсами и учебным контентом

Создание и редактирование курсов; статусы курса: черновик, опубликован, архив.
Создание и редактирование уроков курса, задание порядка следования уроков и его изменение.
Текстовые учебные материалы урока.
Загрузка файловых учебных материалов к уроку с ограничением максимального размера файла, хранение файлов в файловом хранилище сервера, скачивание файлов учениками через контролируемый обработчик с проверкой прав доступа.

2.4. Задания и проверка работ

Задания к урокам двух типов: текстовое задание с ручной проверкой и задание с автоматической проверкой по перечню допустимых текстовых ответов.
Отправка ответа учеником и хранение истории отправленных работ.
Автоматическая проверка ответа по заданному перечню допустимых значений.
Ручная проверка работы администратором: статусы проверки (ожидает проверки, проверена), результат (зачтено, не зачтено), текстовый комментарий проверяющего.

2.5. Назначение на курсы и контроль срока доступа

Назначение ученика на курс с указанием даты начала и даты окончания доступа, продление срока доступа.
Статусы назначения: активно, завершено, отменено.
Автоматический запрет отправки ответов на задания и отметок о прохождении уроков после истечения срока доступа.

2.6. Личный кабинет ученика

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

2.7. Настройки платформы и эксплуатационные возможности

Редактируемые параметры платформы, хранящиеся в базе данных, в том числе адрес страницы входа.
Открытый обработчик проверки работоспособности GET /actuator/health для систем мониторинга.
Ведение журналов приложения в файл с ротацией, настраиваемый уровень журналирования.
Автоматическое применение версионных миграций схемы базы данных при запуске (Flyway).
Конфигурирование через переменные окружения без изменения исходного текста.

3. Системные требования

Серверная операционная система	Linux x86-64 (в том числе российские дистрибутивы на базе Linux); поддерживается запуск в контейнере Docker
Среда исполнения	Java 21 (OpenJDK) — при запуске из JAR-файла; при запуске в контейнере среда включена в образ
СУБД	PostgreSQL 14 и выше
Процессор и память	от 2 vCPU и 2 ГБ ОЗУ для приложения, отдельно ресурсы для СУБД
Дисковое пространство	от 5 ГБ, дополнительно — под файловое хранилище учебных материалов и журналы
Рабочее место пользователя	Любая операционная система с современным веб-браузером; отдельное клиентское ПО не требуется
Сборка из исходного текста	JDK 21, Apache Maven 3.9 и выше, Docker (для интеграционных тестов)

4. Установка

Проверочный экземпляр программного обеспечения версии 1.0.0 доступен для загрузки без регистрации по прямой ссылке: https://lomt.ru/dist/lomt-lms-1.0.0.zip (73 133 677 байт, SHA-256 6f107a4ac3b6d3768c44721e59b7ed8949c1e8eae52ffb346f3c14d7702bd438). В архив входят исполняемый файл приложения, описание запуска средствами Docker Compose, полные исходные тексты версии 1.0.0 и пошаговая инструкция по развёртыванию. Состав архива и порядок развёртывания описаны на странице https://lomt.ru/dist/. Программное обеспечение распространяется на условиях лицензии GNU General Public License версии 3 и предоставляется без технических средств защиты авторских прав: лицензионные ключи, средства активации и ограничения по сроку работы, числу пользователей и оборудованию не применяются. Дистрибутив и исходный текст также предоставляются по запросу на адрес a@lomt.ru.

4.1. Подготовка базы данных

Создайте базу данных PostgreSQL и учётную запись с правами на неё. По умолчанию приложение обращается к базе site_lomt. Схема базы данных создаётся и обновляется автоматически при первом запуске средствами Flyway, ручное выполнение SQL-скриптов не требуется.

4.2. Параметры конфигурации

Конфигурирование выполняется переменными окружения:

`LOMT_DB_URL`	Строка подключения JDBC, например `jdbc:postgresql://localhost:5432/site_lomt`
`LOMT_DB_USERNAME`	Пользователь базы данных
`LOMT_DB_PASSWORD`	Пароль пользователя базы данных
`LOMT_ADMIN_EMAIL`	Адрес электронной почты первого администратора
`LOMT_ADMIN_FULL_NAME`	Фамилия, имя и отчество первого администратора
`LOMT_ADMIN_PASSWORD`	Пароль первого администратора (значение `change-me` не принимается)
`LOMT_FILE_STORAGE_PATH`	Каталог файлового хранилища учебных материалов
`LOMT_FILE_MAX_UPLOAD_SIZE_BYTES`	Предельный размер загружаемого файла
`LOMT_LMS_LOGIN_URL`	Адрес страницы входа, используемый в ссылках
`LOMT_SESSION_COOKIE_SECURE`	`true` при работе по HTTPS
`LOMT_LOG_LEVEL`, `LOMT_LOG_FILE`, `LOMT_LOG_FILE_PATTERN`	Уровень журналирования, файл журнала и шаблон его ротации
`VAADIN_PRODUCTION_MODE`	`true` для промышленной эксплуатации

4.3. Запуск из исполняемого JAR-файла

export LOMT_DB_URL='jdbc:postgresql://localhost:5432/site_lomt'
export LOMT_DB_USERNAME='lms'
export LOMT_DB_PASSWORD='<пароль базы данных>'
export LOMT_ADMIN_EMAIL='admin@example.ru'
export LOMT_ADMIN_FULL_NAME='Иванов Иван Иванович'
export LOMT_ADMIN_PASSWORD='<пароль администратора>'
export LOMT_FILE_STORAGE_PATH='/opt/lms/files'
export LOMT_LOG_FILE='/opt/lms/logs/application.log'
export LOMT_SESSION_COOKIE_SECURE='true'
export VAADIN_PRODUCTION_MODE='true'
java -jar lms-platform-1.0.0.jar

4.4. Запуск в контейнере Docker

docker build -t lomt/lms-platform:1.0.0 .
docker run -d --name lms --env-file /opt/lms/.env -p 8080:8080 \
  -v /opt/lms/files:/opt/lms/files -v /opt/lms/logs:/opt/lms/logs \
  lomt/lms-platform:1.0.0

4.5. Сборка из исходного текста

mvn -Pproduction clean package   # сборка дистрибутива
mvn test                         # автоматические тесты (требуется Docker)

4.6. Проверка установки

Запрос GET /actuator/health возвращает {"status":"UP"}.
Обращение к корневому адресу / перенаправляет неавторизованного пользователя на страницу входа /login.
Вход под учётной записью администратора, заданной переменными LOMT_ADMIN_*, открывает раздел администрирования /admin.

5. Эксплуатация

5.1. Работа администратора

Войти по адресу /login и перейти в раздел /admin.
Создать курс, задать его наименование и описание, перевести в статус «опубликован».
Добавить уроки, задать порядок их следования, наполнить текстовыми материалами и файловыми вложениями.
Создать задания к урокам: с ручной проверкой либо с автоматической проверкой по перечню допустимых ответов.
Создать учётные записи учеников и назначить их на курс с указанием срока доступа.
Проверять поступающие работы в разделе проверки: выставлять результат «зачтено» или «не зачтено» и оставлять комментарий.
При необходимости блокировать учётные записи и продлевать срок доступа к курсу.

5.2. Работа ученика

Войти по адресу /login и перейти в личный кабинет /student.
Открыть назначенный курс, изучить уроки, текстовые материалы и файловые вложения.
Отметить урок как изученный.
Отправить ответ на задание и получить результат проверки с комментарием проверяющего.

5.3. Обслуживание

Мониторинг. Состояние приложения контролируется обработчиком /actuator/health.
Журналы. Журнал приложения ведётся в файл, заданный переменной LOMT_LOG_FILE, с ротацией по шаблону LOMT_LOG_FILE_PATTERN. Для диагностики уровень журналирования переключается в DEBUG.
Резервное копирование. Резервному копированию подлежат база данных PostgreSQL и каталог файлового хранилища LOMT_FILE_STORAGE_PATH. Оба ресурса размещаются на постоянном томе.
Обновление. Обновление выполняется заменой JAR-файла или образа контейнера с последующим перезапуском; миграции схемы базы данных применяются автоматически при старте. Принудительное обновление без ведома владельца экземпляра не выполняется.
Безопасность. Рекомендуется эксплуатация за обратным прокси-сервером по HTTPS с параметром LOMT_SESSION_COOKIE_SECURE=true; доступ к порту СУБД извне не публикуется.

6. Демонстрационный доступ

Для ознакомления с программным обеспечением и проведения проверки доступен работающий экземпляр по адресу https://lms.lomt.ru/.

Адрес входа	https://lms.lomt.ru/login
Логин	`demo.mos@lomt.ru`
Пароль	`Lomt2026!`
Роль	Ученик (личный кабинет, назначенные курсы, уроки, задания, результаты проверки)

Для проверки разделов администрирования — управления учениками, курсами, уроками, учебными материалами, заданиями, назначениями на курсы и проверки работ — доступна демонстрационная учётная запись с правами администратора:

Адрес входа	https://lms.lomt.ru/login
Логин	`demo.admin@lomt.ru`
Пароль	`LomtDemoAdmin2026!`
Роль	Администратор (полный доступ к разделу `/admin`)

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

7. Процессы, обеспечивающие поддержание жизненного цикла

Поддержание жизненного цикла программного обеспечения обеспечивается правообладателем на территории Российской Федерации собственными силами.

Хранение исходного текста и сборка. Исходный текст хранится в системе контроля версий Git на сервере правообладателя, расположенном на территории Российской Федерации; там же выполняется компиляция исходного текста в объектный код средствами Apache Maven и OpenJDK 21.
Контроль качества. Каждое изменение исходного текста проходит автоматическую сборку и автоматические тесты — модульные и интеграционные, с развёртыванием СУБД PostgreSQL в контейнере.
Устранение неисправностей. Обращения принимаются по адресу a@lomt.ru. Срок реакции на обращение — 1 рабочий день, срок устранения критических неисправностей, блокирующих работу, — до 5 рабочих дней, прочих — в согласованный с пользователем срок.
Совершенствование и модернизация. Развитие программного обеспечения ведётся по плану правообладателя и по предложениям пользователей; новые версии выпускаются с указанием номера версии и перечня изменений.
Техническая поддержка. Консультирование по установке, настройке и эксплуатации выполняется по электронной почте на русском языке.
Персонал. Разработку, сопровождение и техническую поддержку осуществляет правообладатель — гражданин Российской Федерации, привлечение иностранных организаций не производится.

8. Стоимость и порядок предоставления

Программное обеспечение «Ломть LMS» распространяется на условиях открытой лицензии GNU General Public License версии 3 безвозмездно. Плата за предоставление права использования программного обеспечения не взимается. Работы по установке, настройке, доработке и сопровождению у заказчика выполняются по отдельному соглашению.

9. Контакты

ИП Овчаренко Андрей Александрович, ИНН 611602008192, ОГРНИП 318619600238627.
Электронная почта: a@lomt.ru. Страница контактов: https://lomt.ru/kontakty/.