Документация

Руководство пользователя

Этот краткий раздел описывает базовый сценарий работы аналитика в системе Crisis-Monitor.

Настройка переменных окружения

Ниже перечислены ключевые параметры из .env.example:

  • SECRET_KEY – секретный ключ Flask.
  • MAIL_SERVER / MAIL_PORT – адрес и порт SMTP сервера.
  • MAIL_USERNAME, MAIL_PASSWORD – учётные данные для отправки почты.
  • ALERT_EMAIL_FROM – адрес отправителя уведомлений.
  • ALERT_EMAIL_TO – адрес получателя уведомлений.
  • TELEGRAM_TOKEN – токен Telegram‑бота.
  • DEFAULT_LOCALE – язык интерфейса.
  • DEFAULT_TIMEZONE – часовой пояс.
  • DEFAULT_CURRENCY, BASE_CURRENCY – валюты по умолчанию.

В продакшене рекомендуется задать SECRET_KEY, MAIL_USERNAME, MAIL_PASSWORD, ALERT_EMAIL_TO и ALERT_EMAIL_FROM. По умолчанию используются безопасные тестовые значения. Также желательно указать DEFAULT_LOCALE, DEFAULT_TIMEZONE, DEFAULT_CURRENCY и BASE_CURRENCY.

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

  1. Откройте страницу /login и введите имя пользователя и пароль.
  2. После входа откроется оперативная панель.

Сбор ссылок

  1. На странице /buffer можно сохранять внешние материалы.
  2. Заполните поле URL и нажмите «Добавить». Система попытается извлечь заголовок и изображение.
  3. Нажмите «Создать тикет» напротив нужной записи, чтобы открыть форму с уже заполненными полями.

Создание инцидента

  1. Заполните основные сведения: заголовок, описание, время и место.
  2. Укажите категорию и при необходимости добавьте теги.
  3. Прикрепите файлы и ссылки на источники.
  4. Нажмите «Создать» – тикет появится в общем списке.

Работа с тикетом

  1. Изменяйте статус и назначайте ответственных на странице деталей тикета.
  2. Вкладка «Регламент» содержит типовые шаги реагирования.
  3. История изменений доступна в журнале действий.

Правила эскалации

  1. Раздел /admin/escalation_rules позволяет настроить автоматические уведомления.
  2. Укажите условия (например, статус и риск) и выберите действия.
  3. Перед сохранением воспользуйтесь блоком «Test rule», чтобы убедиться, что условие сработает.

Отчёты и оперативная панель

  1. В /dashboard доступны графики по статусам и типам инцидентов.
  2. Раздел /reports позволяет выгрузить PDF или CSV со сводной информацией.

Поиск и навигация

  1. Нажмите Ctrl+K (или ⌘+K на macOS), чтобы открыть «Command Palette». Если курсор находится в поле ввода, сочетание не сработает – сначала нажмите Esc или щёлкните вне поля, а затем повторите Ctrl+K.
  2. Начните вводить название тикета, пользователя или команды – результаты появятся в выпадающем списке.