aad/telgraf

dev-master 2021-08-03 13:34 UTC

This package is auto-updated.

Last update: 2024-09-10 19:06:17 UTC


README

一个简单的实时支持服务器,使用PHP Swoole Websocket和Telegram API。

使用方法

服务器设置

  1. 使用以下命令克隆仓库。
    git clone https://github.com/ademalidurmus/telgraf.git
    
  2. 使用cd telgraf命令进入项目文件夹。
  3. 使用任何文本编辑器从.env.example文件更新初始凭据(BOT_TOKENAPP_SECRETAPP_CHAT_IDS)。
  4. 您可以使用一些makefile命令进行配置。例如,运行make [COMMAND]获取详细信息,您还可以运行make help
    1. 使用make env命令创建环境文件。

      在使用makefile命令之前,您需要从.env.example文件更新初始凭据。如果您已运行make .env命令,您可能需要同时更新.env.env.example文件。

    2. 运行make build构建telgraf应用程序。此命令还会运行composer install安装依赖项并运行应用程序。
    3. 如果您已构建应用程序,只需运行make up来运行应用程序。要重启应用程序服务器,请运行make restart,要停止应用程序服务器,请运行make stop
    4. 要访问CLI或容器bash,请运行make cli
    5. make status命令显示容器状态,类似于docker ps。要查看telgraf日志,请使用make logs命令。
    6. make set_webhook命令使用定义的环境设置Telegram bot webhook。
    7. make delete_webhook命令使用定义的环境删除Telegram bot webhook。
    8. make clean命令停止telgraf服务器,删除.env文件并清除所有日志文件。

Telegram Bot 命令

  • /start命令用于启动代理会话以接受任何客户端连接。
  • /stop命令用于停止代理会话。
  • /close命令用于停止当前客户端连接。代理将继续等待任何连接。
  • /add [CHAT_ID]命令用于将新代理添加到代理访问控制列表。
  • /remove [CHAT_ID]命令用于从代理访问控制列表中删除代理。

API 文档

wss://{your_webserver_url}

  • type: enum(message|info), 行为类型
  • content: string, 消息文本或行为详情
  • attributes: object, 消息属性
    • attributes.name: string, 客户端名称

示例Websocket消息历史记录

❌ Disconnected from wss://telgraf.durmus.me
⬇️ {"type":"info","content":"connection unassigned","attributes":[]}
⬆️ {"type":"message","content":"Test Client Message 2","attributes":{"name":"Client 1"}}
⬇️ {"type":"message","content":"Test Message 2","attributes":{"name":"Adem Ali D."}}
⬆️ {"type":"message","content":"Test Client Message 1","attributes":{"name":"Client 1"}}
⬇️ {"type":"message","content":"Test Message 1","attributes":{"name":"Adem Ali D."}}
⬇️ {"type":"info","content":"connection assigned","attributes":[]}
✔️ Connected to wss://telgraf.durmus.me

许可协议

MIT