{"id":50345020,"url":"https://github.com/matrozov/trueconf-webhook-bot","last_synced_at":"2026-05-29T19:30:22.223Z","repository":{"id":351615859,"uuid":"1211583373","full_name":"matrozov/trueconf-webhook-bot","owner":"matrozov","description":"Self-hosted incoming webhooks for TrueConf Server — generate per-chat URLs in chat, deliver text and files via a simple HTTP POST.","archived":false,"fork":false,"pushed_at":"2026-04-15T19:52:21.000Z","size":80,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-15T20:16:45.492Z","etag":null,"topics":["aiohttp","asyncio","bot","chatbot","chatops","docker","incoming-webhooks","notifications","python","python3","self-hosted","slack-webhook-alternative","trueconf","trueconf-server","webhook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrozov.png","metadata":{"files":{"readme":"README-ru.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-15T14:35:17.000Z","updated_at":"2026-04-15T19:53:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/matrozov/trueconf-webhook-bot","commit_stats":null,"previous_names":["matrozov/trueconf-webhook-bot"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/matrozov/trueconf-webhook-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrozov%2Ftrueconf-webhook-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrozov%2Ftrueconf-webhook-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrozov%2Ftrueconf-webhook-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrozov%2Ftrueconf-webhook-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrozov","download_url":"https://codeload.github.com/matrozov/trueconf-webhook-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrozov%2Ftrueconf-webhook-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33668185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiohttp","asyncio","bot","chatbot","chatops","docker","incoming-webhooks","notifications","python","python3","self-hosted","slack-webhook-alternative","trueconf","trueconf-server","webhook"],"created_at":"2026-05-29T19:30:18.516Z","updated_at":"2026-05-29T19:30:22.213Z","avatar_url":"https://github.com/matrozov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TrueConf Webhook Bot\n\n\u003e [English version](README.md)\n\nIncoming webhook bot для чатов TrueConf Server. Внутри чата можно сгенерировать\nперсональную ссылку — внешний сервис отправляет на неё простой `POST`, и текст\n(с опциональными вложениями по URL) приходит в чат. Аналог incoming webhooks\nв Slack/Mattermost.\n\n## Возможности\n\n- Команды `/webhook_create`, `/webhook_list`, `/webhook_revoke` прямо в чате.\n  В групповых чатах и каналах команду нужно адресовать боту (`@bot /webhook_list`);\n  в личных чатах и «Избранных» упоминание необязательно.\n- Полный URL доставляется в личные сообщения инициатору, чтобы не светить секрет\n  в групповом чате.\n- В `/webhook_list` токены показываются с маской (`abcd…wxyz`).\n- Несколько хуков на один чат (под разные интеграции).\n- Опциональное ограничение «только админы чата» (`WEBHOOK_ADMIN_ONLY`).\n- Вложения по внешнему URL: `photo` (сжатые фото) или `document` (любые файлы).\n- Per-token rate limit.\n- Автоматический refresh JWT-токена при авторизации по логину/паролю.\n\n## Подготовка на стороне TrueConf Server\n\n1. Создайте обычную учётку для бота в TrueConf Server (например, `webhook_bot`),\n   задайте пароль.\n2. Убедитесь, что у бот-учётки есть права писать в чаты, в которых планируется\n   его использовать (приглашайте его как участника заранее).\n3. Рекомендуемый способ авторизации — логин/пароль: сервис сам будет обновлять\n   JWT раз в ~25 дней (JWT живёт 30 дней).\n\n### Альтернатива: выпустить токен руками\n\n```bash\ncurl -X POST https://video.example.com/bridge/api/client/v1/oauth/token \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"client_id\":\"chat_bot\",\"grant_type\":\"password\",\"username\":\"webhook_bot\",\"password\":\"...\"}'\n```\n\nПоместите `access_token` в `TRUECONF_TOKEN`. Токен живёт 30 дней —\nобновляйте вручную.\n\n## Установка и запуск\n\n```bash\npython -m venv .venv\nsource .venv/bin/activate     # Linux / macOS\n.venv\\Scripts\\activate        # Windows PowerShell\n\npip install --pre -e .\ncp .env.example .env\n# отредактируйте .env\n\npython -m trueconf_webhook_bot\n```\n\n## Конфигурация (.env)\n\n| Переменная | Обязательна | Значение по умолчанию |\n|---|---|---|\n| `TRUECONF_SERVER` | да | — |\n| `TRUECONF_TOKEN` | одна из авторизаций | — |\n| `TRUECONF_USERNAME` + `TRUECONF_PASSWORD` | одна из авторизаций | — |\n| `TRUECONF_HTTPS` | нет | `true` |\n| `TRUECONF_VERIFY_SSL` | нет | `true` |\n| `TRUECONF_WEB_PORT` | нет | `443` |\n| `WEBHOOK_PUBLIC_URL` | да | — |\n| `WEBHOOK_HTTP_HOST` | нет | `0.0.0.0` |\n| `WEBHOOK_HTTP_PORT` | нет | `8080` |\n| `WEBHOOK_STORAGE_PATH` | нет | `data/webhooks.json` |\n| `WEBHOOK_ADMIN_ONLY` | нет | `true` |\n| `WEBHOOK_RATE_LIMIT_PER_MINUTE` | нет | `60` |\n| `WEBHOOK_RATE_LIMIT_PER_IP_PER_MINUTE` | нет | `120` |\n| `WEBHOOK_MAX_UPLOAD_MB` | нет | `25` |\n| `WEBHOOK_MAX_ATTACHMENTS` | нет | `10` |\n\nПриоритет авторизации: если задан `TRUECONF_TOKEN` — используется он; иначе\nтребуется пара `TRUECONF_USERNAME` + `TRUECONF_PASSWORD`.\n\n## Формат входящего POST\n\n`POST \u003cWEBHOOK_PUBLIC_URL\u003e/hook/\u003ctoken\u003e` принимает два content-type; схемы\nсимметричны по полям.\n\n### JSON (`Content-Type: application/json`)\n\n```json\n{\n  \"text\": \"Деплой прошёл успешно\",\n  \"parse_mode\": \"markdown\",\n  \"images\": [\n    {\"url\": \"https://example.com/build.png\"}\n  ],\n  \"files\": [\n    {\"url\": \"https://example.com/log.txt\", \"filename\": \"build.log\"}\n  ]\n}\n```\n\n- `text` опционален, если есть хотя бы одно вложение.\n- `parse_mode`: `text` (по умолчанию), `markdown`, `html`.\n- `images[]` → `send_photo` (сжатые фото). `files[]` → `send_document` (любые файлы).\n- `filename` в `files[]` опционален.\n\n### multipart/form-data\n\nForm fields:\n\n- `text`, `parse_mode` — обычные строковые поля.\n\nRepeatable parts (семантика в имени):\n\n| Имя part | Значение | Действие |\n|---|---|---|\n| `image_url` | строка-URL | внешнее фото |\n| `file_url`  | строка-URL | внешний файл |\n| `image`     | бинарный part | загруженное фото, имя из `Content-Disposition` |\n| `file`      | бинарный part | загруженный файл, имя из `Content-Disposition` |\n\nPer-attachment caption не поддерживается — общий `text` покрывает контекст,\nлибо отправляйте несколько POST-ов.\n\n### Лимиты и безопасность\n\n- Максимум `WEBHOOK_MAX_ATTACHMENTS` вложений (`images + files`) в запросе.\n- Размер тела — `WEBHOOK_MAX_UPLOAD_MB`.\n- Все URL проходят SSRF-проверку: только `http`/`https`, без приватных\n  адресов, loopback, link-local и известных metadata-хостов.\n- Per-IP rate limit применяется ДО поиска токена (защищает от перебора);\n  per-token rate limit — после.\n\n### Коды ответов\n\n| Код | Ситуация |\n|---|---|\n| `200` | Доставлено |\n| `400` | Невалидный payload |\n| `404` | Токен не найден / отозван |\n| `429` | Rate limit (с заголовком `Retry-After`) |\n| `502` | Часть сообщений не доставлена (подробности в теле) |\n\n## Деплой через Docker\n\nСамый быстрый путь — `docker compose`. Все настройки задаются прямо в\n`docker-compose.yml` в блоке `environment:` — отдельный `.env` не нужен.\n\n```bash\n# отредактируйте docker-compose.yml:\n#   TRUECONF_SERVER, TRUECONF_USERNAME, TRUECONF_PASSWORD, WEBHOOK_PUBLIC_URL\ndocker compose up -d --build\ndocker compose logs -f\n```\n\nЧувствительные значения (`TRUECONF_PASSWORD`, `TRUECONF_TOKEN`) можно держать\nотдельно через `${VAR}`-подстановку в compose и экспортировать из shell/CI,\nчтобы не коммитить их в git.\n\nСостояние хуков хранится в именованном volume `webhook-data` и переживает\nпересборки контейнера.\n\nРучной запуск без Compose:\n\n```bash\ndocker build -t trueconf-webhook-bot .\ndocker run -d --name trueconf-webhook-bot \\\n  --restart unless-stopped \\\n  -e TRUECONF_SERVER=video.example.com \\\n  -e TRUECONF_USERNAME=webhook_bot \\\n  -e TRUECONF_PASSWORD=... \\\n  -e WEBHOOK_PUBLIC_URL=https://bot.example.com \\\n  -p 8080:8080 \\\n  -v trueconf-webhook-data:/app/data \\\n  trueconf-webhook-bot\n```\n\nВстроенный healthcheck дёргает `GET /readyz` раз в 30 секунд; при обрыве\nсвязи с TrueConf контейнер переходит в статус `(unhealthy)`. Docker сам\nне перезапускает контейнер по healthcheck — статус лишь сигнал для оператора\nили оркестратора (Kubernetes, Nomad). Для автоматического восстановления\nиспользуйте `restart: unless-stopped` совместно с healthcheck.\n\nПо умолчанию compose-файл биндит порт 8080 только на loopback\n(`\"127.0.0.1:8080:8080\"`) и ожидает reverse-proxy с TLS (Caddy, Traefik,\nnginx) впереди. Замените на `\"8080:8080\"` для прямого доступа, но\n`WEBHOOK_PUBLIC_URL` всегда должен указывать на внешне-доступный адрес\n(обычно за TLS).\n\n## Деплой через systemd\n\n```ini\n# /etc/systemd/system/trueconf-webhook-bot.service\n[Unit]\nDescription=TrueConf Webhook Bot\nAfter=network-online.target\n\n[Service]\nType=simple\nUser=trueconf-webhook\nWorkingDirectory=/opt/trueconf-webhook-bot\nEnvironmentFile=/opt/trueconf-webhook-bot/.env\nExecStart=/opt/trueconf-webhook-bot/.venv/bin/python -m trueconf_webhook_bot\nRestart=always\nRestartSec=5\n\n[Install]\nWantedBy=multi-user.target\n```\n\nЕсли используется режим готового `TRUECONF_TOKEN` — не забудьте про ежемесячное\nобновление токена (или переключитесь на login/password).\n\n## Безопасность\n\n- URL webhook'а = секрет. Храните его как пароль.\n- Утечка одной ссылки компрометирует только один хук — отозвать его достаточно,\n  чтобы восстановить контроль.\n- `/webhook_list` никогда не показывает токен полностью.\n- Сам токен при создании приходит только в личные сообщения автору.\n- Рекомендуется публиковать HTTP-эндпоинт через reverse-proxy с TLS; Host, на\n  который смотрит `WEBHOOK_PUBLIC_URL`, и внутренний `WEBHOOK_HTTP_HOST/PORT`\n  могут различаться.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrozov%2Ftrueconf-webhook-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrozov%2Ftrueconf-webhook-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrozov%2Ftrueconf-webhook-bot/lists"}