<commit_before># redmine_intouch

Плагин разработан [Centos-admin.ru](http://centos-admin.ru/).

Плагин предназначен для рассылки уведомлений пользователям RedMine и Telegram.
Состоит и двух модулей - email и telegram

## Requirements

Для работы палагина необходимо установить плагин [redmine_sidekiq](https://github.com/ogom/redmine_sidekiq)

[Запуск Sidekiq как демона](https://github.com/mperham/sidekiq/wiki/Deployment#daemonization)

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

## Telegram

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

## E-mail

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

Настройки указываются для каждого треккера индивидуальные.

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

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

* токен бота Telegram (как его получить описано ниже)
* рабочее время - в это время отправляются уведомления по задачам с приорететам отличным от *Авария*
* указать какие приоритеты считать аварийными
* указать какие статусы считать *в работе* и *обратной связью*

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

```
bundle exec rake intouch:telegram:bot PID_DIR='/pid/dir'
```

* пример скрипта для `init.d` в папке `tools`

### Создание бота Telegram

Бота необходимо зарегистрировать и получить его токен. Для этого в Telegram существует специальный бот — @BotFather.

Пишем ему /start и получаем список всех его команд.
Первая и главная — /newbot — отправляем ему и бот просит придумать имя нашему новому боту. Единственное ограничение на имя — в конце оно должно оканчиваться на «bot». В случае успеха BotFather возвращает токен бота и ссылку для быстрого добавления бота в контакты, иначе придется поломать голову над именем.

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

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

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

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

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

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

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

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

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

Группы добавятся в Redmine автоматически, если в них будет добавлен бот.
<commit_msg>update README for bot update instructions<commit_after># redmine_intouch

Плагин разработан [Centos-admin.ru](http://centos-admin.ru/).

Плагин предназначен для рассылки уведомлений пользователям RedMine и Telegram.
Состоит и двух модулей - email и telegram

## Requirements

Для работы палагина необходимо установить плагин [redmine_sidekiq](https://github.com/ogom/redmine_sidekiq)

[Запуск Sidekiq как демона](https://github.com/mperham/sidekiq/wiki/Deployment#daemonization)

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

## Telegram

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

## E-mail

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

Настройки указываются для каждого треккера индивидуальные.

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

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

* токен бота Telegram (как его получить описано ниже)
* рабочее время - в это время отправляются уведомления по задачам с приорететам отличным от *Авария*
* указать какие приоритеты считать аварийными
* указать какие статусы считать *в работе* и *обратной связью*

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

```
bundle exec rake intouch:telegram:bot PID_DIR='/pid/dir'
```

* пример скрипта для `init.d` в папке `tools`

### Создание бота Telegram

Бота необходимо зарегистрировать и получить его токен. Для этого в Telegram существует специальный бот — @BotFather.

Пишем ему /start и получаем список всех его команд.
Первая и главная — /newbot — отправляем ему и бот просит придумать имя нашему новому боту. Единственное ограничение на имя — в конце оно должно оканчиваться на «bot». В случае успеха BotFather возвращает токен бота и ссылку для быстрого добавления бота в контакты, иначе придется поломать голову над именем.

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

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

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

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

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

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

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

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

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

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

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

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

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

{'fraction_non_alphanumeric': 0.054049168474331166, 'fraction_numerical': 0.0, 'mean_word_length': 5.463785046728972, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3537106', 'n_tokens_mistral': 2210, 'n_tokens_neox': 2623, 'n_words': 663}