Skip to content

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

Базовые настройки SMTP

Для активации SMTP:

  1. Войдите в Apiary в качестве администратора;
  2. В меню слева выберите Admin > SMTP;
  3. Активируйте SMTP;

  4. Заполните следующие поля:

    • Host - IP-адрес или имя хоста SMTP сервера;
    • Port - номер порта SMTP сервера;
    • Username - логин отправителя;
    • Password - пароль отправителя;
    • Connection security - использование протокола безопасности (NONE, STARTTLS, SSL/TLS);
    • From - почтовый адрес, с которого вы будете получать уведомления.

  5. Чтобы применить настройки, нажмите Save.

  6. Чтобы проверить правильность всех настроек SMTP, нажмите + Test e-mail configuration. С помощью этой опции вы можете отправить тестовое письмо на свой почтовый ящик:

    • To - адрес e-mail, на который будет отправлено тестовое письмо;
    • Subject - тема письма;
    • Message - текст письма.

  7. Нажмите Send test e-mail, чтобы отправить письмо.

Абсолютные ссылки

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

Добавьте свойство f.deck.base.url и укажите в нём доменное имя. Например:

f.deck.base.url = http(s)://Apiary.example.com:port_number

Что бы изменения вступили в силу нужно сделать reconfig.

Добавление пользовательских шаблонов писем

Чтобы добавить пользовательские шаблоны писем в Apiary на машине, на которой он установлен создайте новую директорию, например:

mkdir /opt/letter-templates

В новую директорию загрузите свой шаблон письма. Важно: имя шаблона должно быть email_notifications.json;

Теперь нужно изменить конфигурацию.

Добавьте свойство f.notification.template.dir и ней укажите путь до шаблона письма:

f.notification.template.dir = /opt/letter-templates

Что бы изменения вступили в силу нужно сделать reconfig.

Формат шаблона письма

Шаблон письма:

"email_new_issue":{
  "subject": "[{{product}}] New issue in project {{project.name}}: {{issue.name}}",
  "body": "There is 1 new issue \n{% if project %}\n{{deck_base_url}}/projects/{{project.id}} ({{ project.name }})\n{% endif %}\n{% if issue %}\n{{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} ({{ issue.name }}) {{ issue.status }}\n{% endif %} {% if issue %}\n{{ issue.name }}\n{% endif %}\n{% if issue and issue.description %} {{issue.description}}\n{% endif %}"
  },
"email_issue_status_change":{ 
  "subject": "{{product}}] New chat message in {{project.name}}: {{issue.name}}", 
  "body": "There is 1 new chat message \n{% if project %}\n{{deck_base_url}}/projects/{{project.id}} ({{ project.name }})\n{% endif %}\n{% if issue %}\n{{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} ({{ issue.name }}) {{ issue.status }}\n{% endif %} {% if issue %}\n{{ issue.name }}\n{% endif %}\n{% if issue and issue.description %} {{issue.description}}\n{% endif %}" 
  }
}

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

  • product - название Apiary;

  • deck_base_url - абсолютная ссылка на проект или уязвимость, пример:

    • {{deck_base_url}}/projects/{{project.id}} - абсолютная ссылка на ID проекта;
    • {{deck_base_url}}/projects/{{project.id}}/issues?issueId={{issue.id}} - абсолютная ссылка на ID уязвимости;

  • user - информация о пользователе, например:

    • id - ID пользователя (пример: {{user.id}});
    • login - логин пользователя (пример: {{user.login}});
    • first_name - имя пользователя (пример: {{user.first_name}});
    • last_name - фамилия пользователя (пример: {{user.last_name}});
    • email - E-mail пользователя (пример: {{user.email}});
    • is_admin - роль пользователя - администратор (пример: {{user.is_admin}});
    • is_bot - бот пользователь (пример: {{user.is_bot}});
    • created - дата создания пользователя (пример: {{user.created}});

  • issue - информация об уязвимости, например:

    • id - ID уязвимости (пример: {{issue.id}});
    • project_id - ID проекта, в котором зарегистрирована уязвимость (пример: {{issue.project_id}});
    • name - название уязвимости (пример: {{issue.name}});
    • sla - автоматически установленное значение SLA (пример: {{issue.sla}});
    • sla_manual_set - вручную установленное значение SLA (пример: {{issue.sla_manual_set}});
    • created - дата создания уязвимости (пример: {{issue.created}});
    • completed - дата устранения уязвимости (пример: {{issue.completed}});

  • project - информация о проекте, например:

    • id - ID проекта (пример: {{project.id}});
    • name - имя проекта (пример: {{project.name}});
    • description - описание проекта (пример: {{project.description}});
    • connection_name - имя соединения проекта (пример: {{project.connection_name}});
    • start_date - дата начала проекта (пример: {{project.start_date}});
    • completion_date - дата окончания проекта (пример: {{project.completion_date}});
    • scope - общая информация о проекте (пример: {{project.scope}});
    • project_type - тип проекта (пример: {{project.project_type}});

Уведомления

В Apiary существуют следующие типы уведомлений:

  1. Веб-уведомления - эти уведомления отображаются в Web интерфейсе при появлении соответствующих событий:

    • New Issue - добавлена новая уязвимость;
    • New Message - новое сообщение в чате уязвимости;
    • Issue Status Change - изменен статус уязвимости.

  2. E-mail уведомления - e-mail отправляется при появлении соответствующих событий. Для использования этой опции необходимо активировать SMTP уведомления:

    • E-mail New Issue - добавлена новая уязвимость;
    • E-mail New Message - новое сообщение в чате уязвимости;
    • E-mail Issue Status change - изменен статус уязвимости.

Чтобы просмотреть и настроить Уведомления:

  1. Нажмите на иконку в правом верхнем углу страницы;

  2. Нажмите на активное уведомление на вкладке Events, и вы будете перенаправлены в уязвимость;

  3. Перейдите на вкладку Settings;

  4. Включите или отключите необходимые уведомления с помощью кнопок.