ObrCRM — инструкция по развёртыванию проверочного экземпляра

Документ подготовлен для экспертизы Единого реестра российских программ для электронных вычислительных машин и баз данных (пункт 11 «д» Правил, утверждённых постановлением Правительства Российской Федерации от 16 ноября 2015 г. № 1236).

Правообладатель: Ярославцева Елена Николаевна. Наименование программного обеспечения: ObrCRM.

1. Что входит в комплект

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

2. Требования к среде

Минимально: 2 ядра, 4 ГБ оперативной памяти, 15 ГБ свободного места на диске. Рекомендуется: 4 ядра, 8 ГБ оперативной памяти.

Программное обеспечение: любая операционная система с Docker версии 24 и новее и Docker Compose версии 2 и новее — подойдут Astra Linux, «Ред ОС», ALT Linux, Ubuntu 22.04 и новее, Debian 12, Windows с WSL 2, macOS.

Проверить готовность среды:

docker --version
docker compose version

Во время первой сборки требуется доступ в интернет: загружаются базовые образы и библиотеки. Дальнейшая работа экземпляра интернета не требует.

3. Установка и запуск

Шаг 1. Распаковать архив и перейти в каталог комплекта:

tar xzf obrcrm-proverochnyj-ekzemplyar.tar.gz
cd obrcrm-proverochnyj-ekzemplyar

Шаг 2. Собрать и запустить:

docker compose up -d --build

Первая сборка занимает 10–20 минут: компилируется веб-интерфейс и устанавливаются зависимости серверной части. Повторные запуски — меньше минуты.

Шаг 3. Дождаться готовности. Убедиться, что все четыре составные части запущены:

docker compose ps

Ожидаемое состояние — running у postgres, api, web, nginx.

Ход подготовки базы данных виден в журнале:

docker compose logs api | tail -20

При первом запуске там появятся строки «Первый запуск — загружаем демонстрационные данные…» и «Демонстрационные данные загружены».

Шаг 4. Открыть в браузере:

http://localhost:8080

Если экземпляр развёрнут на удалённом сервере, вместо localhost укажите его адрес; порт 8080 при необходимости меняется в файле docker-compose.yml (строка "8080:80").

4. Учётные записи для проверки

Пароль для всех перечисленных учётных записей: Demo2026!

Полный перечень учётных записей можно посмотреть после входа под начальником управления в разделе «Пользователи».

5. Что рекомендуется проверить

Демонстрационная база содержит вымышленное «Тестовое управление образования», десять подведомственных организаций (школы, гимназия, лицей), более восьмисот поручений во всех состояниях, десять форм-сборов, двадцать совещаний и проекты.

1. Поручения. Раздел «Поручения» — фильтры «Просроченные», «Не приняты»,

«На проверке». Откройте любое массовое поручение: видно охват организаций и состояние по каждой.

1. Создание поручения. «Создать» — выберите несколько организаций, укажите

срок. Поручение появится у исполнителей.

1. Формы-сборы. Раздел «Формы» — откройте форму, затем период сбора: сводная

таблица по организациям, итоги, выгрузка в электронную таблицу.

1. Заполнение формы. Войдите под директором организации — «Формы» покажут

то, что нужно сдать; заполните и отправьте.

1. Совещания. Раздел «Совещания» — повестка, решения, порождённые из решений

поручения, выгрузка протокола.

1. Паспорт учреждения. Карточка организации — сведения, которые

подставляются в отчётность.

1. Аналитика. Раздел «Отчёты» — исполнительская дисциплина, просрочки,

заполнение форм за период.

1. Разграничение доступа. Войдите под сотрудником организации: видны только

свои поручения, чужие организации недоступны.

Описание программного интерфейса (перечень методов, параметры, примеры запросов) доступно по адресу http://localhost:8080/api/v1/docs.

6. Остановка, повторный запуск, удаление

Остановить, сохранив данные:

docker compose stop

Запустить снова:

docker compose start

Удалить экземпляр вместе с данными:

docker compose down -v

При следующем запуске после полного удаления демонстрационные данные будут загружены заново.

7. Возможные затруднения

Порт 8080 занят. Измените в docker-compose.yml строку "8080:80", например на "8090:80", и выполните docker compose up -d.

Сборка веб-интерфейса завершается нехваткой памяти. Увеличьте объём оперативной памяти, доступной Docker, до 4 ГБ и более (в Docker Desktop — Settings → Resources).

Страница открывается, но данные не загружаются. Проверьте состояние серверной части: docker compose logs api | tail -50. Убедитесь, что база данных готова: docker compose ps — у postgres должно быть healthy.

Нужно начать с чистой базы. docker compose down -v && docker compose up -d.

8. Техническая поддержка по развёртыванию

По вопросам установки, настройки и работы экземпляра:

Ярославцева Елена Николаевна Телефон: +7 (912) 663-67-65 Электронная почта: sintur@mail.ru

Консультации предоставляются в рабочие дни. При обращении просим сообщить операционную систему, версию Docker и содержимое журнала docker compose logs api | tail -50 — это ускорит разбор.