cslant/telegram-git-notifier-app

PHP应用程序，用于从Gitlab和Github事件向Telegram发送通知

维护者

详细信息

github.com/cslant/telegram-git-notifier-app

主页

源代码

问题

资助包维护！
tanhongit

安装数量: 5,603

依赖项: 0

建议者: 0

安全: 0

星标: 27

关注者: 5

分支: 6

公开问题: 4

类型：项目

v1.3.1 2023-11-08 03:28 UTC

Requires

Requires (Dev)

MIT cfb0366517f70b3ef40af29a26ca846fa8429219

notifytelegram-botgit-webhooktelegram-notifiergithub-notifiergithub-telegram-botgitlab-notifiergitlab-telegram-bottelegram-bot-github-notifytelegram-bot-gitlab-notifytelegram-git-notifiertelegram-git-notifier-appcslant

This package is auto-updated.

Last update: 2024-09-11 17:33:41 UTC

README

此包提供了集成Telegram消息服务与GitHub/GitLab的能力。使用此包，您可以创建一个Telegram机器人来接收来自GitHub或GitLab事件的提醒，并通过Telegram的消息和按钮进行自定义管理。

GitHub and GitLab notifications to telegram php

License Latest Version Test Status Code Style Status StyleCI Quality Score Maintainability

📝 信息

  • 将GitHub/GitLab仓库的提醒发送到Telegram机器人、群组、超级群组（多话题）和频道。
  • 机器人必须使用BotFather创建

🎉 特性

  1. GitHub/GitLab通知到Telegram：此包允许您配置一个Telegram机器人来接收来自各种GitHub/GitLab事件的提醒，包括提交、拉取请求、问题、发布等事件。

GitHub/GitLab Notifications to Telegram

  1. 自定义提醒：您可以通过Telegram上的选项自定义想要接收的提醒类型。
  1. 交互式按钮：此包支持在Telegram上创建交互式按钮，以执行启用或禁用提醒等操作。

  1. 事件管理：您可以管理想要接收提醒的具体事件，以便专注于项目中最重要的事情。

    • 支持多个平台：GitHub和GitLab。
    • 在不同平台之间单独管理事件提醒。

Event Management to Telegram

  1. 易于集成：此包提供API和用户友好的功能来创建Telegram机器人并将其与GitHub/GitLab账户关联。
  1. 支持多个聊天：您可以将多个聊天ID添加到.env文件中。这些聊天ID将是您的群组、频道或用户的聊天ID。此外，您还可以添加此机器人的聊天ID以接收针对自身的提醒。
  1. 对于付费用户，您可以使用以下功能
    • 支持多个话题：您可以将多个话题添加到.env文件中。这些话题将是您的超级群组的话题。

📋 要求

🔧 安装

关于安装和配置，此项目提供了两种不同的安装方式，根据您的喜好或系统的适用性选择。

方式1：通过系统Composer直接安装（系统需要安装Composer，之前的PHP版本）

方式2：通过Docker安装（系统需要安装Docker，Docker Compose）

I. 安装和配置 🛠

请从以下两种方式中选择一种来设置项目。

方式1：通过系统Composer直接安装 ⚙

首先，请通过Composer克隆并安装此项目

composer create-project cslant/telegram-git-notifier-app

运行上述命令后，您将在telegram-git-notifier-app目录下安装项目，并自动创建环境文件.env。

在storage目录中会自动创建一些JSON文件。这些文件用于存储数据并为此机器人的功能提供服务。

1. 创建新的机器人

要创建一个新机器人，您需要与BotFather进行交谈并遵循几个简单步骤。

  1. 与BotFather开启聊天并发送/newbot命令。
  2. 为您的机器人输入一个友好的名称。此名称将在联系人详情和其他地方显示。
  3. 为您的机器人输入一个唯一的用户名。它必须以bot结尾。例如：TetrisBot或tetris_bot。
  4. 复制由BotFather提供的HTTP API访问令牌并将其粘贴到您的.env文件中。
TELEGRAM_BOT_TOKEN=123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ

2. 设置您的域名和SSL证书

我们建议您使用HTTPS设置域名和webhook。您可以构建自己的服务器或使用Heroku等服务。

在这个例子中，我们将使用localhost和ngrok来设置域名和webhook

  1. 下载并安装ngrok。
  2. 进入此项目目录并在终端中运行以下命令：php -S localhost:8000
  3. 继续在终端中运行以下命令：ngrok http 8000
  4. 复制ngrok提供的HTTPS URL并将其粘贴到您的.env文件中。
TGN_APP_URL=https://123456789.ngrok.io

3. 获取您的Chat ID并将其添加到.env文件中

  1. 打开与您的机器人的聊天。
  2. 向您的机器人发送任何消息。（此句柄需要获取您的聊天ID）
  3. 转到以下URL：<TGN_APP_URL>/webhooks/getUpdate.php
  4. 查找"chat":{"id":字段并复制其后面的数字。这是您的Chat ID。
  5. 将Chat ID粘贴到您的.env文件中。
TELEGRAM_BOT_CHAT_ID=123456789

到此，源启动过程完成，请跳过方式2，继续到II. 设置webhook。

方式2：通过Docker 🐳安装

注意：此方式需要系统安装Docker和Docker Compose。

⚠ 如果您已通过方式一设置项目，请跳过此方式。 🚸

并继续到II. 设置webhook。

首先，请克隆此项目并将环境文件.env.example复制到.env

git clone git@github.com:cslant/telegram-git-notifier-app.git
cd telegram-git-notifier-app
cp .env.example .env

1. 更新环境变量

打开.env文件并更新以下变量

PHP_VERSION_SELECTED=8.2
APP_PORT=3180

# You can customize the container name to suit your needs using GitHub and GitLab
CONTAINER_NAME=tgn-app

注意

  • PHP_VERSION_SELECTED变量是在容器中想要使用的PHP版本。
  • APP_PORT变量是容器的端口。（请勿设置与主机相同的端口）
  • CONTAINER_NAME变量是您想要创建的容器的名称。

2. 安装并运行容器

运行以下命令来安装并运行容器

bash ./docker.sh

在storage目录中会自动创建一些JSON文件。这些文件用于存储数据并为此机器人的功能提供服务。

3. 创建一个新机器人

要创建一个新机器人，您需要与BotFather进行交谈并遵循几个简单步骤。

  1. 与BotFather开启聊天并发送/newbot命令。
  2. 为您的机器人输入一个友好的名称。此名称将在联系人详情和其他地方显示。
  3. 为您的机器人输入一个唯一的用户名。它必须以bot结尾。例如：TetrisBot或tetris_bot。
  4. 复制由BotFather提供的HTTP API访问令牌并将其粘贴到您的.env文件中。
TELEGRAM_BOT_TOKEN=123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ

4. 设置您的域名和SSL证书

这种方式，我们使用容器中的代理和ngrok来设置域名和webhook

  1. 检查容器的代理：docker inspect <CONTAINER_NAME>-nginx | grep IPAddress

注意：将<CONTAINER_NAME>替换为.env文件中的容器名称。

示例

image

  1. 下载并安装ngrok。
  2. 继续在终端中运行以下命令：ngrok http <CONTAINER_IP>

注意：将<CONTAINER_IP>替换为步骤1中的容器IP地址。

示例

ngrok http 172.28.0.3
  1. 复制ngrok提供的HTTPS URL并将其粘贴到您的.env文件中。
TGN_APP_URL=https://123456789.ngrok-free.app

5. 获取您的Chat ID并将其添加到.env文件中

  1. 打开与您的机器人的聊天。
  2. 向您的机器人发送任何消息。（此句柄需要获取您的聊天ID）
  3. 转到以下URL：<TGN_APP_URL>/webhooks/getUpdate.php
  4. 查找"chat":{"id":字段并复制其后面的数字。这是您的Chat ID。
  5. 将Chat ID粘贴到您的.env文件中。
TELEGRAM_BOT_CHAT_ID=123456789

II. 设置webhook

我们有两种方式来设置webhook

1. 从本项目设置webhook

在设置域名和SSL证书后，您需要为您的机器人设置webhook。

转到

<APP_URL>/webhooks/set.php

注意：将 <APP_URL> 替换为您的应用程序 URL 到 .env 文件中。

如果您看到以下消息，则表示 webhook 已成功发送。

{"ok":true,"result":true,"description":"Webhook was set"}

2. 从 Telegram 手动设置 webhook

如果您想手动设置 webhook，可以使用以下 URL

https://api.telegram.org/bot<YourTelegramBotToken>/setWebhook?url=<APP_URL>

注意：将 <YourTelegramBotToken> 替换为您的 bot 令牌，并将 <APP_URL> 替换为您的应用程序 URL 到 .env 文件中。

III. 将您想接收通知的聊天 ID 添加到 .env 文件

1. 将多个聊天 ID 添加到 .env 文件。

这些聊天 ID 将是您的群组、频道或用户的聊天 ID。

您还可以添加 此 bot 的聊天 ID 以接收针对自身的外部通知。

TELEGRAM_NOTIFY_CHAT_IDS="-978339113;-1001933979183"

2. 为有高级用户的超级群组添加主题（线程 ID）

您可以为有高级用户的超级群组添加主题（线程 ID）。

这些主题将是您的超级群组主题。

TELEGRAM_NOTIFY_CHAT_IDS="-978339113;-1001933979183:topic_1;"

3. 为有高级用户的超级群组添加多个主题（线程 ID）

您可以为每个有高级用户的超级群组添加多个主题（线程 ID）。

TELEGRAM_NOTIFY_CHAT_IDS="-978339113;-1001933979183:topic_1,topic_2;"

注意

  • 请使用分号 ";" 来分隔聊天 ID
    • 使用冒号 ":" 来分隔聊天 ID 和主题
    • 如果您想添加多个主题，请使用逗号 ","

现在您的配置已完成。并且 .env 文件将如下所示

TGN_APP_NAME='Telegram GitHub/GitLab Notify Bot'

# Set your app URL here (Required for the bot to work properly)
TGN_APP_URL=https://123456789.ngrok.io

TELEGRAM_BOT_TOKEN=6162840106:AAH3g20lMQIkG_wHHu8R_ngdtG541uzoq4
TELEGRAM_BOT_CHAT_ID=6872320129

# Set the chat IDs that will receive notifications here.
# You can add the owner bot ID, group id, ...
# -------------------------------------------------------
# Note:
# Please use semicolon ";" to separate chat ids
# And use a colon ":" to separate chat ID and thread ID
# And use comma "," if you want to add multiple thread ids
# -------------------------------------------------------
# The environment variable is expected to be in the format:
# "chat_id1;chat_id2:thread_id2;chat_id3:thread_id3_1,thread_id3_2;..."
TELEGRAM_NOTIFY_CHAT_IDS="-978339113;-1001933979183:2,13;6872320129"

TIMEZONE=Asia/Ho_Chi_Minh

PHP_VERSION_SELECTED=8.2
CONTAINER_NAME=tgn-bot
APP_PORT=3180

🚀 使用方法

现在您可以向您的 bot 发送消息，您将收到来自 bot 的欢迎消息。

/start

如果您想检查菜单，可以向您的 bot 发送以下消息。

/menu

🎊 到此为止，您的 Telegram bot 配置过程已完成。您可以使用此 bot 的所有功能。🎉🎉

Menu features of this bot

为了提高易用性，让我们为您创建一个带有列出命令的菜单。

请向您的 bot 发送以下消息以创建菜单按钮。

/set_menu

Set menu Set menu

现在您需要添加 GitHub 和 GitLab 仓库的 Webhook 以接收通知。

📌 在您的 GitHub 仓库上添加 Webhook 以接收通知

  1. 进入您的仓库设置。
  2. 进入 Webhooks 部分。
  3. 点击 添加 webhook。
  4. 将 Payload URL 设置为 <APP_URL>。
  5. 将 Content type 设置为 application/x-www-form-urlencoded。
  6. 您想触发此 webhook 的哪些事件？选择 让我选择单个事件。。
  7. 点击 Active 复选框和添加 webhook 按钮。
  8. 完成。当您的仓库有新事件时，您将收到通知。

以下是您将收到的第一条通知

Github ping event notification

📌 在您的 GitLab 仓库上添加 Webhook 以接收通知

  1. 进入您的仓库设置。
  2. 进入 Webhooks 部分。
  3. 点击 添加新 webhook。
  4. 将 URL 设置为 <APP_URL>。
  5. 选择任何 Trigger。
  6. 点击 Enable SSL verification 复选框和添加 webhook 按钮。

注意：您可以为不同的仓库设置此 webhook。请为每个仓库类似地设置 webhook。

然后每当这些仓库出现事件时，此 Telegram bot 将立即向您发送通知。