1. Руководства
Комплект эксплуатационной документации по ЕСПД поставляется вместе с дистрибутивом и публикуется в формате docx. Редакции руководств соответствуют текущей версии продукта.
| Документ | Для кого | Скачать |
|---|---|---|
| Быстрый старт | все роли: вход, смена пароля, первые шаги в интерфейсе | quickstart.docx |
| Руководство пользователя | Эксплуатант: задания, выполнение с чек-листом, документы, акты | user-guide.docx |
| Руководство администратора | Руководитель эксплуатации и Администратор: справочники, регламенты, оборудование, учётные записи, аудит | admin-guide.docx |
| Руководство системного администратора | Системный администратор: установка, переменные стека, HTTPS, ADFS, почта, резервное копирование, обновление | sysadmin-guide.docx |
2. Состав и системные требования
«ЛИИС Офис Эксплуатация» поставляется как набор готовых образов контейнеров (backend на Python/FastAPI, веб-интерфейс на React за Nginx, СУБД MySQL 8) и файл описания стека для Docker Compose или Portainer. Отдельный сервер под СУБД не требуется, доступ сервера в интернет для установки не нужен: все образы входят в поставку.
| Профиль | Процессор | Память | Диск |
|---|---|---|---|
| Минимум (пилот, до 10 пользователей) | 1 vCPU | 2 ГБ | 20 ГБ |
| Комфортно (рабочая инсталляция) | 2 vCPU | 4 ГБ | от 40 ГБ |
- сервер Linux x86_64 с Docker Engine 24+ и Compose v2.20+ либо Portainer CE 2.19+ на Standalone Docker Engine (не Swarm);
- один входящий HTTP-порт веб-интерфейса, обычно за обратным прокси с TLS; порты backend и базы данных наружу не публикуются;
- исходящий доступ к SMTP-серверу, если включена отправка почты, и исходящий HTTPS до сервера ADFS, если включён корпоративный вход;
- пользователям достаточно актуального браузера (Chrome, Edge, Firefox, Safari), интерфейс адаптирован и для телефона.
Диск планируется от объёма загружаемых документов: один файл может занимать до 50 МБ, документы хранятся в отдельном томе, база в своём томе; оба тома входят в резервное копирование. Все контейнеры запускаются без права повышения привилегий и без дополнительных возможностей ядра.
3. Установка
Дистрибутив передаётся каталогом с архивом образов, файлом описания стека, шаблоном переменных, файлом с описанием выпуска, контрольными суммами и комплектом руководств. Перед установкой сверяются контрольные суммы. Порядок установки через Portainer:
- загрузить образы на сервер (Portainer: Images, Import, либо загрузка архива на хосте);
- создать стек из файла описания без изменений (Stacks, Add stack, Web editor);
- задать переменные стека: пароли MySQL, ключ шифрования настроек, одноразовый пароль учётной записи superadmin, при необходимости параметры почты;
- открыть веб-интерфейс, войти под superadmin с одноразовым паролем и сменить его, после чего удалить одноразовый пароль из переменных стека;
- завести учётные записи и справочники: база после установки пустая, оборудование и регламенты вносит администратор.
Без Portainer та же поставка разворачивается командами Docker Compose на хосте. Работа за HTTPS, настройка корпоративного входа ADFS/OIDC и почтовых уведомлений описаны в руководстве системного администратора.
4. Обновление и резервное копирование
Версии продукта нумеруются по SemVer, номер виден в меню профиля. Обновление выполняется заменой образов на новую версию: снять резервную копию, сверить контрольные суммы новой поставки, загрузить новые образы, заменить файл описания стека содержимым из новой поставки (переменные стека сохраняются) и обновить стек. Миграции схемы данных выполняются автоматически при запуске и идемпотентны.
Миграции выполняются только вперёд. Откат на предыдущую версию выполняется восстановлением резервной копии, снятой перед обновлением, и возвратом прежнего файла описания стека. Резервная копия состоит из дампа базы данных и тома документов; порядок снятия и восстановления с командами приведён в руководстве системного администратора. Рекомендуемый минимум: ежедневная копия с хранением 14 дней.
5. Жизненный цикл и поддержка
Продукт развивается выпусками: исправления и улучшения выходят в минорных и патч-версиях, изменения, требующие действий администратора, отмечаются в описании выпуска. В течение срока поддержки заказчик получает все выпуски продукта. Уведомления о выпусках направляются на контактный адрес заказчика, указанный в договоре.
Техническая поддержка: support@simpleoffice.tech, +7 495 545-49-64, будни, 09:00–18:00 МСК, первая реакция в течение рабочего дня. Для диагностики в продукте есть проверка готовности, структурированные ошибки с кодом обращения, журнал аудита действий и метрики Prometheus.
6. Границы продукта
Система сознательно не включает:
- прямой обмен с BMS, SCADA, датчиками и инженерным оборудованием;
- мобильное приложение и офлайн-режим;
- заявки на ремонт, склад, запчасти, закупки и учёт трудозатрат;
- сложные маршруты согласования и наряды-допуски;
- конструктор отчётов: доступны оперативные представления, а не произвольная аналитика;
- автоматизированное резервное копирование как сервис: порядок ручного бэкапа описан в руководстве системного администратора.
Корпоративные учётные записи создаются и обновляются в момент входа через ADFS/OIDC; регулярной синхронизации с каталогом нет.