aad / telgraf
dev-master
2021-08-03 13:34 UTC
Requires
- ext-json: *
- monolog/monolog: ^2.2
- ramsey/uuid: ^4.1
- respect/validation: ^2.2
Requires (Dev)
- swoole/ide-helper: @dev
This package is auto-updated.
Last update: 2024-09-10 19:06:17 UTC
README
一个简单的实时支持服务器,使用PHP Swoole Websocket和Telegram API。
使用方法
服务器设置
- 使用以下命令克隆仓库。
git clone https://github.com/ademalidurmus/telgraf.git
- 使用
cd telgraf
命令进入项目文件夹。 - 使用任何文本编辑器从
.env.example
文件更新初始凭据(BOT_TOKEN、APP_SECRET和APP_CHAT_IDS)。 - 您可以使用一些makefile命令进行配置。例如,运行
make [COMMAND]
获取详细信息,您还可以运行make help
。- 使用
make env
命令创建环境文件。在使用makefile命令之前,您需要从
.env.example
文件更新初始凭据。如果您已运行make .env
命令,您可能需要同时更新.env
和.env.example
文件。 - 运行
make build
构建telgraf应用程序。此命令还会运行composer install
安装依赖项并运行应用程序。 - 如果您已构建应用程序,只需运行
make up
来运行应用程序。要重启应用程序服务器,请运行make restart
,要停止应用程序服务器,请运行make stop
。 - 要访问CLI或容器bash,请运行
make cli
。 make status
命令显示容器状态,类似于docker ps
。要查看telgraf日志,请使用make logs
命令。make set_webhook
命令使用定义的环境设置Telegram bot webhook。make delete_webhook
命令使用定义的环境删除Telegram bot webhook。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