README-RU.md

English version

redmine_intouch

Плагин предназначен для рассылки уведомлений пользователям Redmine через Telegram или E-mail.

Пожалуйста, помогите нам сделать этот плагин лучше, сообщая во вкладке Issues обо всех проблемах, с которыми Вы столкнётесь при его использовании. Мы готовы ответить на Все ваши вопросы, касающиеся этого плагина.

Установка

Требования

• Ruby 2.3+
• Redmine 3.1+
• Настроенный redmine_telegram_common
• У Вас должен быть бот в Telegram
• Установите Redis 2.8 или выше. Запустите Redis и добавьте его запуск в автозагрузку.
• Установите плагин redmine_sidekiq.
• Настройте Sidekiq на обработку очереди default и telegram. Пример конфига - разместите его в папке redmine/config (Можно скопировать из plugins/redmine_intouch/extras/sidekiq.yml в config/sidekiq.yml).
• Плагин устанавливается стандартно:

cd {REDMINE_ROOT}
git clone https://github.com/centosadmin/redmine_intouch.git plugins/redmine_intouch
bundle install RAILS_ENV=production
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Примеры конфигурационного файла и скрипта для init.d находятся в папке extras

Обновление с 1.0.2 до 1.1.0+

Начиная с версии 1.1.0 redmine_intouch (так же, как и другие telegram-плагины от Southbridge) использует бота из redmine_telegram_common. Чтобы произвести миграцию для использования единого бота, нужно выполнить команду bundle exec rake telegram_common:migrate_to_single_bot. Token бота будет взят из одного из установленных плагинов от Southbridge в следующем приоритете:

• redmine_chat_telegram
• redmine_intouch
• redmine_2fa

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

Обновление с 0.3 на 1.0.0+

Начиная с версии 1.0.0 этот плагин использует redmine_telegram_common версии 0.1.0, в которой ушли от зависимости от Telegram CLI. Обратите внимание на новые зависимости.

Обновление с 0.2 на 0.3+

Начиная с версии 0.3 этот плагин использует [redmine_telegram_common](https://github .com/centosadmin/redmine_telegram_common).

Перед обновлением установите этот плагин.

После обновления запустите bundle exec rake intouch:common:migrate RAILS_ENV=production для миграции пользоватльских данных в новую таблицу.

В версии 0.4 модель TelegramUser будет упразднена, в месте с ней будет удалена старая таблица telegram_users.

Настройка плагина

Общие настройки

В секции "Протоколы" указываются требуемые протоколы уведомлений. В настоящий момент доступны - telegram и email.

В секции "Рабочие дни" указываются:

• время начала и завершения рабочего дня
• какие дни недели являются рабочими

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

Плагин содержит функционал периодических уведомлений о задачах "В работе" или со статусом "Обратная связь". Для правильной интерпретации этих статусов плагином, укажите их в соответствующих секциях.

Запуск бота

Перед запуском бота на странице настройки плагина нужно указать:

• рабочее время - в это время отправляются уведомления по не срочным задачам
• указать какие приоритеты считать срочными
• указать какие статусы считать в работе и обратной связью
• сохранить настройки

Добавление аккаунта Telegram к пользователю

После того как бот запущен и пользователь поприветствовал его командой /start, бот предложит ввести команду /connect [email protected].

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

Если бота обновили

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

То есть через поиск найти @YourTelegramBot и написать ему /start

Добавление группы Telegram

Группы добавятся в Redmine автоматически, если в них будет добавлен бот.

Название группы сохраняется сразу при добавлении. Если, какое-то время спустя, вы изменили название группы и хотите, чтобы в Redmine название также обновилось - выполните команду /rename в групповом чате.

Доступные команды

• /help - справка по командам

В чате с ботом

• /connect [email protected] - связать аккаунты Telegram и Redmine
• /update - обновить информацию об аккаунте Telegram (если сменили имя или ник)

В групповом чате

• /update - обновить название группы (если переименовали группу в Telegram)

Подсказки для команд бота

Чтобы добавить подсказки команд для бота, используйте команду /setcommands в беседе с @BotFather. Нужно написать боту список команд с описанием:

start - Начало работы с ботом
connect - Связывание аккаунтов Redmine и Telegram
update - Обновить информацию об аккаунте Telegram или групповом чате (в зависимости от контекста)
help - Справка по командам

Шаблоны настроек

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

Расписание регулярных уведомлений

В плагине предусмотрены

• Уведомления о задачах со статусом "В работе"
• Уведомления о задачах со статусом "Обратная связь"
• Уведомления о неназначенных задачах
• Уведомления о просроченных задачах

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

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

При первой установке плагина, нужно инициализировать периодические задачи.

Для этого нужно нажать ссылку Инициализировать периодические задачи на вкладке Расписание периодических задач в настройках плагина.

После этого можно настроить удобное вам расписание периодических уведомлений.

Расписание настраивается используя синтаксис CRON.

Важно отметить, что на этой вкладке настраивается то, как часто проверять наличие задач, по которым требуется отправить уведомления. Периодичность самих уведомлений указывается в каждом проекте индивидуально, либо с использованием шаблонов.

Настройка модуля внутри проекта

В настройках проекта на вкладке "Модули" нужно выбрать модуль Intouch. В результате в настройках появится вкладка "Intouch".

На этой вкладке есть три секции:

• Мгновенные уведомления при смене статуса/приоритета задачи
• Периодические уведомления
• Группы исполнителей - уведомления, адресованные Исполнителю, будут отправлены только, если Исполнитель входит в одну из отмеченных в этой секции групп.

Мгновенные уведомления при смене статуса/приоритета задачи

В этой секции настраиваются мгновенные уведомления для следующих получателей:

• автор
• исполнитель - уведомления, адресованные Исполнителю, будут отправлены только, если Исполнитель входит в одну из групп отмеченных в секции "Группы исполнителей".
• наблюдатели за задачей
• группы Telegram

Важное замечание: для того, чтобы пользователь Telegram получал сообщения, нужно чтобы он предварительно написал команду /start боту

Периодические уведомления

Общие настройки

В общих настройках указываются интервалы периодических уведомлений для различных приоритетов.

В работе / Обратная связь

На этих вкладках указываются получатели периодических уведомлений о задачах со статусами "В работе" и "Обратная связь"

Неназначенные / Назначенные на группу

На этой вкладке указываются получатели периодических уведомлений о задачах

• без назначенного исполнителя
• назначенные на группу

Просроченные / Без даты завершения

На этой вкладке указываются получатели периодических уведомлений о задачах

• дата завершения которых находится в прошлом
• с неуказанной датой завершения

FAQ

Из-за чего бот может не слать сообщения в канал?

Возможно у вас не инициализировано Расписание периодических задач.

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

Автор плагина

Плагин разработан Southbridge