Документация на программное обеспечение «Orbo»

Правообладатель — ООО «ОРБО» (ИНН 9701327025, ОГРН 1267700119037). На этой странице размещена документация на программное обеспечение «Orbo»: описание функциональных характеристик, информация, необходимая для установки, и информация, необходимая для эксплуатации.

Документ Раздел страницы Файл
Описание функциональных характеристик программного обеспечения Раздел I PDF
Информация, необходимая для установки программного обеспечения Раздел II PDF
Информация, необходимая для эксплуатации программного обеспечения Раздел III PDF

Экземпляр программного обеспечения

  • Облачный экземпляр (SaaS): https://my.orbo.ru
  • Дистрибутив для развёртывания экземпляра: orbo-distribution.tar.gz — сборка от 2026-10-01, фиксация кода 1c728b29, 20.0 МБ
  • Контрольная сумма SHA-256: 067387403b9c76ea36700482d083ab19212e373a6776ad02a3205a3cb5325bee (файл)
  • Порядок развёртывания — раздел II этой страницы. Технические средства защиты авторских прав не применяются.

Раздел I. Описание функциональных характеристик программного обеспечения

Описание функциональных характеристик программного обеспечения «Orbo»

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

Параметр Значение
Наименование ПО Orbo — платформа управления сообществами
Правообладатель Общество с ограниченной ответственностью «ОРБО» (ООО «ОРБО»), ИНН 9701327025, ОГРН 1267700119037
Адрес правообладателя 105094, г. Москва, вн.тер.г. муниципальный округ Басманный, ул. Госпитальный Вал, д. 3 к. 4, кв. 79
Сайт ПО https://orbo.ru
Адрес экземпляра ПО https://my.orbo.ru (веб-приложение, модель SaaS)
Документация на ПО https://orbo.ru/docs/registry/documentation
Руководство пользователя по разделам https://orbo.ru/docs
Способ распространения Облачный сервис (SaaS): доступ через браузер по подписке, установка на оборудование пользователя не требуется

2. Назначение и область применения

Orbo — программное обеспечение для управления профессиональными сообществами, клубами и образовательными пространствами, действующими в российских мессенджерах Telegram и MAX.

ПО предназначено для организаторов сообществ (бизнес-клубы, ассоциации, профессиональные объединения, образовательные проекты) и решает задачи: учёт участников и их активности (CRM), проведение мероприятий с регистрацией и приёмом оплат, платное членство с автоматическим управлением доступом к закрытым ресурсам, коммуникации с участниками, аналитика жизни сообщества.

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

3.1. Пространства и организация работы

  • Создание рабочих пространств (организаций); одно ПО обслуживает множество независимых пространств (мультитенантная архитектура).
  • Роли команды: владелец, администратор; отдельные роли ограниченного доступа (регистратор мероприятий без учётной записи в системе).
  • Приглашение членов команды по ссылкам с уровнями доступа.

3.2. Интеграция с мессенджерами Telegram и MAX

  • Подключение групп, супергрупп и каналов Telegram через собственных ботов платформы; для тарифа «Клубный» — подключение собственного бота организации.
  • Подключение групп мессенджера MAX (ООО «Коммуникационная платформа», российское ПО) — сбор активности, синхронизация участников, доставка сообщений, мини-приложения.
  • Автоматическая синхронизация состава участников, отслеживание вступлений и выходов, импорт исторической переписки из выгрузок Telegram и WhatsApp.
  • Верификация аккаунтов администраторов через одноразовые коды.

3.3. CRM участников

  • Автоматическое создание карточек участников из подключённых групп; профиль, история активности, участие в мероприятиях, теги, контакты.
  • Автоматическая категоризация по вовлечённости (новичок, ядро, опытный, наблюдатель, молчун) на основе балла активности.
  • Поиск и фильтрация по десяткам признаков; «умный поиск» на естественном языке; массовые действия; экспорт в Excel.
  • Обнаружение и объединение дублирующихся профилей, в том числе между мессенджерами (Telegram ↔ MAX).

3.4. Аналитические функции с применением ИИ

  • Анализ профилей участников: определение интересов, обсуждаемых тем, актуальных запросов, роли и стиля общения.
  • Автоматическое выявление негативных обсуждений и неотвеченных вопросов в группах с уведомлением администраторов (настраиваемые правила: чувствительность, рабочие часы, адресность).
  • Еженедельный аналитический дайджест по сообществу.
  • ИИ-обработка выполняется у российских провайдеров (Yandex Cloud AI Studio, GigaChat/Сбер) на инфраструктуре, размещённой на территории РФ; персональные данные для ИИ-обработки за пределы РФ не передаются.

3.5. Мероприятия

  • Создание событий (онлайн/офлайн, разовые и регулярные серии), настраиваемые анкеты регистрации, ограничение мест, режимы доступа.
  • Регистрация участников через мини-приложения Telegram и MAX, а также веб-страницы; UTM-разметка источников.
  • Автоматические подтверждения и напоминания (мессенджер + email).
  • Электронные билеты с QR-кодом; отметка присутствия сканером на входе; аналитика регистраций и доходимости.

3.6. Платные услуги организаторов и платёжные функции

  • Приём оплат за мероприятия и членские взносы по агентской схеме через российский интернет-эквайринг (Т-Банк, CloudPayments; оплата картами МИР и через СБП) с автоматическим резервированием резервного шлюза.
  • Фискализация чеков по 54-ФЗ (интеграция с ОФД), формирование агентских отчётов и УПД, выгрузка в Контур.Эльбу.
  • Баланс организатора, заявки на вывод средств, журнал транзакций.
  • Платное членство: планы с периодами и льготным периодом, автопродление, автоматическая выдача и отзыв доступа к закрытым группам, каналам, материалам и событиям.

3.7. Коммуникации

  • Анонсы в подключённые группы Telegram и MAX и адресные рассылки зарегистрированным на событие (мессенджер, email).
  • Автоматические цепочки онбординга новых участников.
  • Транзакционные email-уведомления (российский сервис Unisender Go).

3.8. Публичный портал сообщества

  • Веб-портал пространства: афиша событий, база знаний, каталог участников, личный профиль, страница членства; брендируемый поддомен.
  • Вход участников без учётной записи организатора: Telegram (мини-приложение или код), MAX, email.

3.9. База знаний

  • Иерархическая база знаний (страницы с вложенностью), редактор с форматированием, разграничение доступа по членству.

3.10. Заявки и воронки

  • Формы заявок на вступление (лендинг + анкета) с мини-приложением Telegram, канбан-воронки обработки, автоматическая оценка спам-риска заявок.

3.11. Панель наблюдения и администрирования

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

4. Сведения о технологиях и компонентах

Компонент Технология Примечание
Серверная инфраструктура ООО «Селектел» (Санкт-Петербург, РФ) все данные хранятся и обрабатываются на территории РФ
Веб-приложение Next.js / React / TypeScript свободное ПО (лицензия MIT)
СУБД PostgreSQL 16 свободное ПО (лицензия PostgreSQL)
Контейнеризация Docker, nginx свободное ПО
Файловое хранилище S3-совместимое хранилище Селектел (РФ)
ИИ-модели Yandex Cloud AI Studio, GigaChat (Сбер) российские провайдеры
Email-рассылки Unisender Go (РФ)
Эквайринг и фискализация Т-Банк, CloudPayments, ОФД (РФ)
Репозиторий и сборка Собственный сервер Gitea (git.orbo.ru, РФ) исходный код хранится в РФ

Проприетарные компоненты иностранных правообладателей, требующие лицензионных отчислений или управляемые из-за рубежа, в составе ПО не используются. Свободные компоненты применяются на условиях открытых лицензий (MIT, Apache 2.0, PostgreSQL License), допускающих свободное коммерческое использование.

5. Требования к среде эксплуатации

ПО эксплуатируется по модели SaaS; для работы пользователю необходимы:

  • современный веб-браузер (Chrome, Safari, Firefox, Яндекс Браузер актуальных версий) на настольном или мобильном устройстве;
  • доступ в интернет;
  • для функций мессенджеров — учётная запись Telegram и/или MAX.

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

6. Проверка экземпляра ПО

  • Экземпляр ПО доступен по адресу https://my.orbo.ru.
  • Дистрибутив ПО для развёртывания проверочного экземпляра размещён по адресу https://orbo.ru/downloads/orbo-distribution.tar.gz; порядок развёртывания описан в инструкции по установке.
  • Тестовая учётная запись с демонстрационным пространством для экспертной проверки предоставляется правообладателем в составе заявления.
  • Руководство пользователя по разделам: https://orbo.ru/docs.

Раздел II. Информация, необходимая для установки программного обеспечения

Инструкция по установке экземпляра программного обеспечения «Orbo»

Информация, необходимая для установки программного обеспечения.

Документ описывает развёртывание проверочного экземпляра ПО «Orbo» из архива исходного кода в изолированной тестовой среде. Правообладатель — ООО «ОРБО» (ИНН 9701327025).

0. Два способа проверки ПО

Для экспертизы «Orbo» доступен двумя дополняющими друг друга способами:

  1. Проверочный экземпляр из исходного кода — архив исходного кода, разворачиваемый в изолированной среде по настоящей инструкции. Он подтверждает, что ПО собирается и запускается из предоставленного кода. Часть функций, требующих внешних сервисов (боты Telegram/MAX, платежи, ИИ, почта, файловое хранилище), в изолированной среде намеренно не активируется — см. раздел 4.

  2. Облачный экземпляр (боевая эксплуатация, SaaS) — работающий продукт по адресу https://my.orbo.ru. На нём проверяется полная функциональность, включая внешние интеграции. Доступ предоставляется по тестовой учётной записи (email и способ входа указаны в документе «Описание функциональных характеристик», раздел 6).

Как получить дистрибутив. Дистрибутив ПО — архив исходного кода — размещён для скачивания по постоянному адресу:

https://orbo.ru/downloads/orbo-distribution.tar.gz

Контрольная сумма SHA-256 доступна по адресу https://orbo.ru/downloads/orbo-distribution.sha256, версия и дата сборки указаны на странице документации https://orbo.ru/docs/registry/documentation. Архив формируется правообладателем из системы контроля версий командой git archive и содержит только исходный код без секретов и служебных данных. Технические средства защиты авторских прав в ПО не применяются.

Настоящая инструкция описывает установку способа № 1.

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

Параметр Требование
Операционная система Linux x86_64 (проверено на Ubuntu 22.04/24.04); допустима любая ОС с Docker, включая российские дистрибутивы (Astra Linux, РЕД ОС)
Программное обеспечение Docker Engine 24+ и Docker Compose v2
Оперативная память не менее 8 ГБ (или 4 ГБ ОЗУ + файл подкачки не менее 4 ГБ — сборка приложения требовательна к памяти)
Дисковое пространство не менее 10 ГБ
Сеть доступ в интернет на этапе сборки (загрузка базовых Docker-образов и npm-зависимостей); после сборки экземпляр работает автономно

Разворачивайте стенд на отдельной (чистой) машине или виртуальной машине. Проверочный экземпляр использует имя контейнера базы данных orbo_postgres и публикует порты 80 и 443. На хосте, где уже работает другое приложение с таким же именем контейнера или занятыми портами 80/443, возникнет конфликт. Не запускайте стенд на сервере боевой эксплуатации.

2. Состав архива

Архив содержит полный исходный код ПО. Для установки используются:

Путь в архиве Назначение
deploy/review-instance/ конфигурация проверочного стенда (docker-compose, шаблон переменных окружения)
deploy/Dockerfile сборка образа приложения
deploy/scripts/apply-migrations.sh применение миграций базы данных
db/migrations/ SQL-миграции схемы базы данных (применяются по порядку, с журналом)

3. Порядок установки

Все команды выполняются из каталога deploy/review-instance/ распакованного архива.

Шаг 1. Скачайте и распакуйте дистрибутив

curl -L -o orbo-distribution.tar.gz https://orbo.ru/downloads/orbo-distribution.tar.gz
mkdir orbo && tar -xzf orbo-distribution.tar.gz -C orbo
cd orbo/deploy/review-instance

Проверка целостности (необязательно): сравните вывод sha256sum orbo-distribution.tar.gz со значением по адресу https://orbo.ru/downloads/orbo-distribution.sha256.

Шаг 2. Задайте переменные окружения

Скопируйте шаблон и подставьте три случайных секрета одной серией команд (Linux/macOS/Git Bash) — значения генерируются и сразу вписываются в .env:

cp .env.example .env
sed -i "s/ЗАМЕНИТЕ_POSTGRES_PASSWORD/$(openssl rand -hex 16)/" .env
sed -i "s/ЗАМЕНИТЕ_AUTH_SECRET/$(openssl rand -hex 32)/"       .env
sed -i "s/ЗАМЕНИТЕ_CRON_SECRET/$(openssl rand -hex 16)/"       .env

Проверьте, что подстановка прошла (вывод должен быть пустым — незаполненных значений не осталось):

grep ЗАМЕНИТЕ_ .env

Остальные значения из шаблона менять не нужно. При желании три секрета можно вписать в .env и вручную любым текстовым редактором.

Шаг 3. Запустите базу данных

docker compose up -d postgres

Дождитесь состояния healthy: docker compose ps.

Шаг 4. Примените миграции схемы

MIGRATIONS_DIR="$(cd ../../db/migrations && pwd)" bash ../scripts/apply-migrations.sh

Скрипт применяет SQL-миграции по порядку и ведёт журнал в таблице schema_migrations; завершение без ошибок — строка «Готово: применено N миграций».

Шаг 5. Соберите и запустите приложение

docker compose up -d --build app nginx

Сборка занимает 5–15 минут в зависимости от машины (nginx при первом запуске сам создаёт самоподписанный TLS-сертификат). Проверка работоспособности:

curl -k https://localhost/api/health

Ожидаемый ответ — JSON со статусом healthy (-k — принять самоподписанный сертификат).

4. Первый вход и проверка функциональности

  1. Откройте в браузере https://localhost — браузер предупредит о самоподписанном сертификате, примите его («Дополнительно» → «Перейти на localhost»). Неавторизованный пользователь автоматически перенаправляется на страницу входа https://localhost/signin (HTTP-редирект 307 — в браузере происходит незаметно; при проверке командой curl -kL конечный адрес — /signin).

  2. Выберите вход по email, введите любой адрес (например, expert@example.com) и нажмите «Получить ссылку для входа».

  3. На стенде почта работает в консольном режиме — ссылка для входа печатается в журнал приложения. Получите её командой:

    docker compose logs app | grep links
    

    Откройте ссылку вида https://localhost/api/auth/email/verify?token=… в том же браузере — вы войдёте в систему.

  4. Создайте пространство (мастер откроется автоматически) — после этого доступны все разделы интерфейса: дашборд, участники (CRM), события, членство, материалы, анонсы, уведомления, настройки.

Ограничения изолированной среды

Функции, требующие внешних сервисов, на автономном стенде не активируются (ключи интеграций не задаются): боты Telegram и MAX, отправка реальной почты, файловое хранилище S3, ИИ-анализ (Yandex/GigaChat), приём платежей и фискализация. Данные функции проверяются на облачном экземпляре https://my.orbo.ru — тестовая учётная запись предоставляется вместе с комплектом документов (см. «Описание функциональных характеристик», раздел 6).

5. Остановка и удаление

docker compose down        # остановить
docker compose down -v     # остановить и удалить данные БД

Раздел III. Информация, необходимая для эксплуатации программного обеспечения

Руководство по эксплуатации программного обеспечения «Orbo»

Информация, необходимая для эксплуатации программного обеспечения.

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

Параметр Значение
Наименование ПО Orbo — платформа управления сообществами
Правообладатель ООО «ОРБО», ИНН 9701327025, ОГРН 1267700119037
Модель эксплуатации Интернет-сервис (SaaS), единый экземпляр для всех пользователей
Адрес экземпляра https://my.orbo.ru
Документация на ПО https://orbo.ru/docs/registry/documentation
Руководство пользователя по разделам https://orbo.ru/docs
Техническая поддержка support@orbo.ru

Настоящее руководство описывает порядок эксплуатации ПО «Orbo»: требования к рабочему месту, вход в систему, роли, основные операции пользователя, администрирование экземпляра, действия при неисправностях и порядок обращения в поддержку. Установка экземпляра описана в отдельном документе «Инструкция по установке экземпляра программного обеспечения».

2. Назначение и условия применения

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

ПО эксплуатируется как интернет-сервис: пользователь работает через веб-браузер и мини-приложения мессенджеров, установка программ на его оборудование не требуется. Серверная часть размещена на инфраструктуре правообладателя на территории Российской Федерации.

3. Требования к рабочему месту пользователя

Параметр Требование
Устройство Персональный компьютер, ноутбук, планшет или смартфон
Веб-браузер Актуальная версия Яндекс Браузера, Chrome, Safari, Firefox или Edge
Сеть Доступ в интернет по протоколу HTTPS
Мессенджеры (для соответствующих функций) Учётная запись Telegram и (или) MAX, установленное приложение мессенджера
Электронная почта Действующий адрес для входа и получения уведомлений

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

4. Роли пользователей

Роль Кто это Что доступно
Владелец Создатель пространства (организации) Все разделы, тариф и оплата, реквизиты, назначение администраторов
Администратор Член команды организатора Участники, события, членство, анонсы, материалы, настройки, кроме тарифа и состава владельцев
Участник Член сообщества Публичный портал сообщества: афиша, регистрация на события, билеты, профиль, членство, материалы
Регистратор Помощник на входе мероприятия Отметка присутствия по QR-билетам без учётной записи в системе, по ссылке от организатора

5. Вход в систему

5.1. Организатор (владелец, администратор)

  1. Открыть https://my.orbo.ru.
  2. Выбрать способ входа:
    • по электронной почте — указать адрес и нажать «Получить ссылку для входа», затем перейти по ссылке из письма (действует 1 час);
    • через Яндекс ID — нажать «Войти через Яндекс»;
    • через Telegram — сайт показывает одноразовый шестизначный код, который нужно отправить боту @orbo_start_bot (действует 10 минут).
  3. При первом входе открывается мастер создания пространства. После его прохождения доступны все разделы интерфейса.

Пароли в системе не используются: аутентификация выполняется по одноразовой ссылке или коду. Сеанс сохраняется в браузере 30 дней, выход — пункт «Выйти» в меню пользователя.

5.2. Участник сообщества

Участник попадает на портал сообщества по ссылке организатора либо через мини-приложение в Telegram или MAX. Вход выполняется через мессенджер (автоматически в мини-приложении либо по одноразовому коду) или по электронной почте. Отдельная учётная запись организатора участнику не нужна.

6. Основные операции организатора

Управление выполняется через веб-интерфейс. Ниже приведён порядок выполнения типовых операций. Пошаговые инструкции со снимками экрана по каждому разделу размещены по адресу https://orbo.ru/docs.

6.1. Создание и настройка пространства

  1. При первом входе задать название пространства.
  2. В разделе «Настройки» заполнить профиль организации: название, логотип, описание, контакты.
  3. В разделе «Настройки → Команда» пригласить администраторов по ссылке.
  4. Для приёма оплат заполнить реквизиты и подать заявку на подключение платежей в разделе «Настройки → Финансы».

6.2. Подключение групп и каналов

  1. В разделе «Группы и каналы» подтвердить свой аккаунт Telegram или MAX одноразовым кодом.
  2. Добавить бота платформы в группу или канал и назначить его администратором.
  3. Выбрать группу в списке доступных и подключить её к пространству.
  4. После подключения состав участников и активность группы отображаются в разделах «Участники» и «Дашборд».

6.3. Работа с участниками

  • Раздел «Участники» содержит карточки членов сообщества: контакты, история активности, участие в мероприятиях, членство, теги.
  • Поиск и фильтры доступны в верхней части списка; поддерживается поиск запросом на естественном языке.
  • Дублирующиеся карточки объединяются командой «Объединить» в карточке участника.
  • Список выгружается в файл командой «Экспорт».
  • Участников можно добавить вручную, импортом из файла, из истории переписки Telegram или из выгрузки WhatsApp.

6.4. Мероприятия

  1. В разделе «События» нажать «Создать событие», указать название, дату, время, место или ссылку, описание и обложку.
  2. Настроить регистрацию: поля анкеты, количество мест, режим доступа, стоимость участия (для платных событий).
  3. Опубликовать событие и распространить ссылку: веб-страница события, мини-приложение Telegram или MAX, анонс в подключённые группы.
  4. Зарегистрированным участникам автоматически направляются подтверждение с электронным билетом (QR-код) и напоминания за сутки и за час.
  5. На входе присутствие отмечается сканированием QR-кода (ссылка для регистратора выдаётся в карточке события) либо вручную в списке участников.
  6. Список участников, оплаты и отметки присутствия доступны в карточке события и выгружаются в файл.

6.5. Платное членство

  1. В разделе «Членство» создать план: название, стоимость, период, льготный период, ресурсы с ограниченным доступом (группы, каналы, материалы).
  2. Участник оплачивает членство на портале сообщества; доступ к закрытым ресурсам выдаётся автоматически.
  3. При окончании срока участник получает напоминания; при непродлении доступ отзывается автоматически.
  4. Организатор может выдать, продлить или отозвать членство вручную.

6.6. Платежи и документы

  • Раздел «Настройки → Финансы» показывает баланс организатора, журнал операций, удержанное вознаграждение и заявки на вывод средств.
  • Возврат оплаты оформляется из карточки регистрации или из списка оплат.
  • Отчётные документы (агентские отчёты, универсальные передаточные документы) формируются автоматически и доступны в разделе «Документы».
  • Кассовые чеки покупателям формируются и направляются автоматически.

6.7. Анонсы и уведомления

  • Раздел «Анонсы» позволяет отправить сообщение сразу или по расписанию в подключённые группы и адресно зарегистрированным на событие либо членам клуба.
  • Раздел «Уведомления» содержит правила оповещения администраторов: негативные обсуждения, вопросы без ответа, неактивность группы. Для каждого правила задаются группы, чувствительность и получатели.
  • Еженедельный дайджест по сообществу направляется владельцу автоматически; периодичность настраивается.

6.8. Материалы и публичный портал

  • Раздел «Материалы» содержит базу знаний: разделы, страницы, файлы, ссылки; доступ к разделам может быть ограничен членством.
  • Публичный портал сообщества (афиша, материалы, профиль участника, страница членства) включается в настройках и доступен участникам по ссылке пространства или на отдельном поддомене.

6.9. Тариф и оплата сервиса

Текущий тариф, лимиты и срок действия показаны на вкладке «Настройки → Тариф и оплата». Оплата тарифа выполняется банковской картой или по счёту, чек и акт формируются автоматически.

7. Администрирование экземпляра

Операции этого раздела выполняет персонал правообладателя, обслуживающий экземпляр ПО. Те же команды применимы к проверочному экземпляру, развёрнутому по инструкции по установке (каталог deploy/review-instance/).

7.1. Состав экземпляра

Компонент Назначение
Контейнер приложения Веб-приложение и программный интерфейс (Node.js, Next.js)
Контейнер СУБД PostgreSQL 16, хранение данных
Контейнер веб-сервера nginx: приём запросов, TLS
Объектное хранилище Файлы пользователей: обложки, материалы, аватары
Планировщик задач Плановые операции: напоминания, рассылки, синхронизация, резервное копирование

7.2. Запуск, остановка, контроль состояния

Операция Команда
Запуск docker compose up -d
Состояние контейнеров docker compose ps
Проверка работоспособности curl -k https://<адрес>/api/health — ожидается статус healthy
Журнал приложения docker compose logs -f app
Перезапуск приложения docker compose restart app
Остановка docker compose down
Остановка с удалением данных (только проверочный экземпляр) docker compose down -v

7.3. Обновление версии

  1. Получить новую версию исходного кода (архив или фиксация в системе контроля версий).
  2. Применить новые миграции схемы базы данных: bash deploy/scripts/apply-migrations.sh. Скрипт применяет миграции по порядку и ведёт журнал в таблице schema_migrations; команда с ключом --dry-run показывает перечень без применения.
  3. Собрать и запустить новую версию приложения: docker compose up -d --build app.
  4. Проверить работоспособность запросом /api/health. При отрицательном результате вернуть предыдущую версию образа.

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

7.4. Резервное копирование и восстановление

  • Резервная копия базы данных создаётся ежедневно автоматически, шифруется и выгружается в отдельное хранилище; локально хранятся копии за 7 дней.
  • Внеплановая копия создаётся командой scripts/backup.sh, с выгрузкой в хранилище — scripts/backup.sh --upload.
  • Восстановление выполняется командой scripts/restore.sh с выбором копии. После восстановления проверяется работоспособность запросом /api/health.
  • Файлы пользователей хранятся в объектном хранилище с собственным резервированием поставщика.

7.5. Контроль работы и журналы

  • Ошибки приложения записываются в журнал ошибок и доступны в служебной панели правообладателя; о критических событиях персонал оповещается автоматически.
  • Доступность экземпляра проверяется внешними автоматическими проверками.
  • Действия администраторов пространств фиксируются в журнале аудита.
  • Журнал контейнера приложения сохраняется при каждом обновлении версии.

7.6. Управление доступом персонала

Доступ к серверу выполняется по протоколу SSH с ключами, доступ к базе данных — только с сервера экземпляра. Секреты (ключи интеграций, пароли) хранятся в файле переменных окружения на сервере и в исходный код не включаются.

8. Действия при неисправностях

Признак Возможная причина Действия
Не приходит письмо со ссылкой для входа Письмо в папке «Спам», ошибка в адресе Проверить «Спам», запросить ссылку повторно, войти через Яндекс ID или Telegram
Код входа Telegram не принимается Истёк срок действия кода Вернуться на страницу входа — код обновится, отправить боту новый
Группа не появляется в списке для подключения Бот не администратор группы, аккаунт не подтверждён Назначить бота администратором, подтвердить аккаунт, обновить список
Участник не получил билет Не открыт диалог с ботом, ошибка в адресе почты В списке участников события значок у контакта покажет причину; исправить контакт и отправить повторно
Оплата не прошла Отказ банка, недостаточно средств Повторить оплату другим способом; статус оплаты виден в карточке регистрации
Страница не открывается Нет соединения, плановые работы Проверить соединение, повторить через несколько минут, обратиться в поддержку
Проверка /api/health не возвращает healthy Не запущен контейнер приложения или СУБД docker compose ps, docker compose logs app, перезапуск контейнеров
Ошибка при применении миграций Нарушен порядок или прерван запуск Повторить apply-migrations.sh: применённые миграции пропускаются по журналу

Если неисправность не устраняется перечисленными действиями, следует обратиться в техническую поддержку.

9. Техническая поддержка

Параметр Значение
Канал приёма обращений support@orbo.ru
Режим работы рабочие дни, 10:00–19:00 по московскому времени
Первичный ответ в течение 1 рабочего дня
Что указать в обращении Адрес пространства, описание проблемы, время возникновения, снимок экрана

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

Приложение. Эксплуатация проверочного экземпляра

Проверочный экземпляр разворачивается из дистрибутива по инструкции по установке и доступен по адресу https://localhost (самоподписанный сертификат TLS — принять предупреждение браузера).

  1. Открыть https://localhost — откроется страница входа.
  2. Выбрать вход по электронной почте, ввести любой адрес (например, expert@example.com) и нажать «Получить ссылку для входа».
  3. На изолированном стенде почта работает в консольном режиме: ссылка для входа печатается в журнал приложения. Получить её командой docker compose logs app | grep links и открыть в том же браузере.
  4. Пройти мастер создания пространства. После этого доступны разделы интерфейса, описанные в разделе 6.

Функции, требующие внешних сервисов, на изолированном стенде не активируются, так как ключи интеграций не задаются: боты Telegram и MAX, отправка электронной почты, объектное хранилище, ИИ-анализ, приём платежей и формирование чеков. Эти функции проверяются на облачном экземпляре https://my.orbo.ru по тестовой учётной записи.