Настройка «МойОфис Документы Онлайн»
Перед запуском чат-бота убедитесь, что в Системе хранения данных (PGS) включена отправка уведомлений. При отключении чат-бота уведомления должны быть отключены.
Настройка интеграции со стороны МойОфис Документы Онлайн может быть выполнена автоматически, в процессе установки системы. Подробнее см. документ «Система редактирования и совместной работы (СО). Руководство по установке». Переменные, используемые для автоматической интеграции, находятся в файле main.yaml и описаны в таблице основных переменных.
Чтобы настроить интеграцию вручную:
- Откройте окно сервера конфигурации
ETCD-browserСистемы хранения данных. АдресETCD-browserзависит от выбранного типа установки и указывается при развертывании Системы хранения данных. - Перейдите в раздел chatbot: root > nct > co > config > chatbot.
- Настройте обязательные параметры chatbot в соответствии с требованиями в таблице. Пример заполнения представлен на рисунке ниже.
| Параметр | Описание |
|---|---|
feature.open_document_chat * | Включение (true) или отключение (false) возможности создавать и открывать чаты по документу в МойОфис Документы ОнлайнПо умолчанию false |
messenger | Название мессенджера, с которым производится интеграция. В данном случае SQUADUS |
squadusBot.login | Имя пользователя-бота, заданное при настройке интеграции на стороне МойОфис Сквадус |
squadusBot.server | Ссылка на стенд МойОфис Сквадус без слеша (/) в конце, с https в начале:https://im[-<domain_env>].<domain_name> |
squadusBot.token | Токен пользователя-бота, заданный при настройке интеграции на стороне МойОфис Сквадус |
logger.fluent.tag | Тег для идентификации источника логов в Fluentd |
logger.fluent.host | Адрес Fluentd-сервера для отправки логов |
logger.fluent.hostName | Имя текущего сервера, записываемое в логи |
logger.fluent.ident | Идентификатор приложения в системе логирования |
logger.fluent.enabled | Включение/отключение отправки логов в Fluentd, по умолчанию выключено |
logger.fluent.port | Порт Fluentd-сервера |
logger.console.enabled | Включение/отключение вывода логов в консоль Docker-контейнера (по умолчанию включено) |
rateLimitMinutes | Максимальное количество запросов в минуту с одного IP (защита от DDoS), по умолчанию 15 |
* — Если существуют созданные чаты по документу, при установке для переменной feature.open_document_chat значения false чаты сохраняют свою работу без поддержки функциональности чата по документу.
- Нажмите кнопку Send в правом верхнем углу и ожидайте перезапуск чат-бота (обычно менее 1 минуты).
- Для остальных параметров chatbot в большинстве случаев используются значения по умолчанию. Описание параметров и требования к заполнению указаны в таблице.
| Параметр | Описание |
|---|---|
chatbot.api.json | URL-адрес, по которому доступен API чат-бота в формате JSON |
logger.modules.default | Уровень логирования чат-ботом (по умолчанию info).Логи можно посмотреть в Kibana: ident:co.chatbot.nodejs.chatbot. |
chatbot.base.url | URL-адрес, по которому доступен чат-бот в формате:https://coapi[-<domain_env>].<domain_name> |
chatbot.coapi.url | URL-адрес, по которому чат-бот может обратиться к серверу МойОфис Документы Онлайн в формате:https://coapi[-<domain_env>].<domain_name> |
Если порт по умолчанию уже используется, необходимо после установки на хосте с ролью lb_core_auth выполнить следующую команду:
docker inspect openresty-lb-core-auth
- Перейдите в раздел root > nct > co > config > wfe и установите значение для переменной
deploy.dateна 15 дней ранее текущей даты. Пример: сегодня 15 января 2000, нужное значение —2000-01-01. - Нажмите кнопку Send в правом верхнем углу и ожидайте перезапуск чат-бота (обычно менее 1 минуты).
- Настройте параметры в корневом разделе wfe в соответствии с требованиями, представленными в таблице. Пример заполнения представлен на рисунке ниже.
| Параметр | Описание |
|---|---|
csp_allowed_frame_ancestors.json | Ссылка на «МойОФис Документы Онлайн» в формате:https://im[-<domain_env>].<domain_name>https://meet[-<domain-env>].<domain_name> |
csp_allowed_frame_sources.json | Ссылка на «МойОФис Документы Онлайн» в формате:https://im[-<domain_env>].<domain_name> |
cors.allowed_origins.json | Ссылка на «МойОФис Документы Онлайн» в формате:https://im[-<domain_env>].<domain_name> |
- Нажмите кнопку Send в правом верхнем углу и ожидайте перезапуск чат-бота (обычно менее 1 минуты).
- Перейдите в раздел wfe > oauth2_clients и добавьте новое свойство: нажмите Add Property и укажите в появившихся полях параметры в соответствии с таблицей. Пример заполнения представлен на рисунке ниже.
| Параметр | Описание |
|---|---|
| Enter Property Name | Значение параметра Идентификатор, заданное при настройке интеграции на стороне МойОфис Сквадус |
| Enter Property value | Объект с параметрами client_secret и redirect_uri в формате:`{ "client_secret": "1234567890", "redirect_uri": "https://im[-<domain_env>].<domain_name>/_oauth/private_cloud" }` |
client_secret | Значение параметра Секрет, заданное при настройке интеграции на стороне МойОфис Сквадус |
redirect_uri | Обратный адрес — должен совпадать с адресом из начала настроек интеграции с МойОфис Документы Онлайн на панели администрирования «МойОФис Документы Онлайн»:https://im[-<domain_env>].<domain_name>/_oauth/private_cloud |
-
Нажмите кнопку Send в правом верхнем углу и ожидайте перезапуск чат-бота (обычно менее 1 минуты).
-
Вы можете включить оповещение пользователей об изменениях документов, на которые они подписаны, а также о запросах и выдаче прав доступа к файлам. Оповещения будут приходить в «МойОФис Документы Онлайн». Пользователи смогут настроить способ уведомления в своём профиле. Для включения и отключения оповещений:
- Перейдите в раздел root > nct > co > config > nm.
- Установите для переменной
chatbot.enabledзначениеtrueилиfalse. Перезагрузится сервис NM.