Files
MessageGateway/docs/README.md
Sergey Antropov b90def35ed Initial commit: Message Gateway project
- FastAPI приложение для отправки мониторинговых алертов в мессенджеры
- Поддержка Telegram и MAX/VK
- Интеграция с Grafana, Zabbix, AlertManager
- Автоматическое создание тикетов в Jira
- Управление группами мессенджеров через API
- Декораторы для авторизации и скрытия эндпоинтов
- Подробная документация в папке docs/

Автор: Сергей Антропов
Сайт: https://devops.org.ru
2025-11-12 20:25:11 +03:00

33 lines
2.0 KiB
Markdown

# Документация Message Gateway
Добро пожаловать в документацию проекта Message Gateway!
## Содержание
### Основная документация
- [Настройка ботов](bots.md) - как создать ботов в Telegram и MAX/VK
- [Конфигурация групп](groups.md) - как настроить группы мессенджеров
- [Шаблоны сообщений](templates.md) - как работают шаблоны Jinja2
- [Конфигурация Jira Mapping](jira-mapping.md) - как настроить маппинг алертов в Jira
- [Отправка сообщений](messaging.md) - как работает отправка сообщений
### Настройка систем мониторинга
- [Настройка Grafana](monitoring/grafana.md) - как настроить Grafana для отправки алертов
- [Настройка Zabbix](monitoring/zabbix.md) - как настроить Zabbix для отправки алертов
- [Настройка AlertManager](monitoring/alertmanager.md) - как настроить AlertManager для отправки алертов
### API документация
- [API для управления группами](api/groups.md) - управление группами мессенджеров через API
- [API для отправки сообщений](api/message.md) - отправка простых сообщений в мессенджеры
- [API для проверки здоровья](api/health.md) - проверка здоровья и готовности приложения
- [API для отладки](api/debug.md) - сохранение JSON данных для отладки
- [Декораторы API](api/decorators.md) - декораторы для авторизации и скрытия эндпоинтов
---
**Автор:** Сергей Антропов
**Сайт:** https://devops.org.ru