本教程基于 Ubuntu 20.04 系统,搭建 Pagermaid-Pyro (非 PagerMaid-Modify 旧版),其他系统请自行修改命令安装。\
Github 开源地址:https://github.com/TeamPGM/PagerMaid-Pyro\
Gitlab 开源地址:https://gitlab.com/Xtao-Labs/PagerMaid-Pyro\
官方网站:https://xtaolabs.com/
隐私政策与免责声明
您在使用本项目代码时即表示您已经同意本隐私协议并且允许我们以评估负载和修复代码的目的记录您 Bot 的在线状态和报错文件。\
除可能使用的信息之外,我们不会记录与收集任何信息。\
本项目代码完全遵循此隐私政策,您可以随时在此项目中审查我们的源代码。\
本项目无法承诺 Userbot 行为不会被 Telegram 官方滥权,也无法承诺所有功能能在自建项目上成功运行。\
使用 Userbot 所带来的损失或可能产生的任何责任由搭建者自行承担。
Pagermaid-Pyro 简介
PagerMaid-Pyro 是一个开源的 Telegram 人形自走 Bot 方案,基于 Python 开发,使用 Pyrogram 依赖,功能强大而丰富,它通过响应账号通过其他客户端发出的命令来自动执行一系列任务,可以帮助你打造专属的便利功能。
Pagermaid-Pyro 和 Pagermaid-Modify 双版本
注:Pagermaid-Pyro 由于命令与旧版 Pagermaid-Modify 不同,故可以同时安装两个版本。\
搭建 Pagermaid-Modify 可以使用下面的一键脚本,这里不展开讲。
wget https://gitlab.com/Xtao-Labs/pagermaid-modify/-/raw/master/install.sh -O install.sh&& chmod +x install.sh && bash install.sh
使用该脚本会将 Pagermaid-Modify 安装至 /var/lib/pagermaid
目录下。\
按照本教程的步骤会将 Pagermaid-Pyro 安装至 /var/lib/pagermaid_pyro
目录下。\
这样可以实现双版本同时运行。\
本文以 Pagermaid-Pyro 为主,Pagermaid-Modify 使用方法不在本文考虑范围内。
开放端口
由于需要与 Telegram 服务器通信,首先开放服务器端口。
sudo iptables -P INPUT ACCEPT
sudo iptables -P FORWARD ACCEPT
sudo iptables -P OUTPUT ACCEPT
sudo iptables -F
如果使用了云服务,请去控制台再次开放端口。(这里使用的是 Microsoft Azure ,其他 IDC 请自行解决)\
拉取项目
在拉取项目之前,首先更新 git ,否则之后可能出现无法更新的情况。
sudo apt install --upgrade git -y
拉取项目至 /var/lib/pagermaid_pyro
目录。
sudo -i
cd /var/lib && git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid_pyro && cd pagermaid_pyro
出现以下提示即可进入下一步。\
安装软件包
首先更新 apt 包:
sudo apt update && sudo apt upgrade -y
完整安装:
sudo apt install python3-pip imagemagick neofetch libzbar-dev tesseract-ocr tesseract-ocr-all -y
软件包说明(点击展开)
安装软件包过程中,请等待一段时间,安装完成后,继续安装 Python 依赖包。
pip3 install -r requirements.txt
如果出现 ERROR: Could not open requirements file: [Errno 2] No such file or directory: 'requirements.txt'
报错,请先检查当前目录是否为 /var/lib/pagermaid_pyro
,如果位于该目录仍然报错,请重新执行 拉取项目 步骤。\
出现以下提示代表安装成功。\
修改配置文件
执行以下命令,将配置文件 config.gen.yml
复制一份并且命名为 config.yml
cp config.gen.yml config.yml
修改 config.yml
vim config.yml
不会使用 vim 的请自行查找教程,这里不提供。\
去 Telegram 官网 ,登录后点击 API development tools
,按提示填写信息,生成 API 。\
申请 API 属于高危操作,特别是新注册的 Telegram 账号和使用 VoIP 语音号码注册的账号会加大封号概率,如被封号,请尽快向客服申诉申请解封。同时请勿将 API 泄露给他人。
生成后,只需要复制 api_id
和 api_hash
值并分别填入 api_key
和 api_hash
,编辑时请注意不要删掉引号。\
当然也可以使用部分程序官方的 API (不过还是建议自己生成,官方公开的可能会受到限制,导致无法登录。)
公开的 API(点击展开)
\
按以上图片中格式填写即可。\
关于日志及报错信息记录(非必须修改):\
log: "False" # False 代表禁用,True 代表启用
log_chatid: "503691334" # 这里填写记录用的群组或频道ID
如果在国内机器搭建,需要用到代理,请填写 config.yml
中以下字段:\
代理支持 Socks5
, Http
和 MTProto
。\
proxy_addr: "" # Socks5 代理服务器地址
proxy_port: "" # Socks5 代理服务器端口
http_addr: "" # Http 代理服务器地址
http_port: "" # Http 代理服务器端口
mtp_addr: "" # MTProto 代理服务器地址
mtp_port: "" # MTProto 代理服务器端口
mtp_secret: "" # MTProto 代理服务器密钥
填写需要使用的即可,无需全部填写。\
config.yml
中其他字段无需修改,暂不做说明。
登录账号
运行以下命令:
python3 -m pagermaid
此步需要填入完整的电话号码(eg:+18888888888,需要带上国际区号)然后 Telegram 会向你的其他客户端发送验证码,填入验证码后,回车,如有两步验证密码,则再输入两步验证密码即可。
Enter phone number or bot token: #此处填入手机号
Is "+18888888888" correct? (y/N): # 号码显示正确输入 y ,错误输入 n
The confirmation code has been sent via Telegram app
Enter confirmation code: # 此处输入 Telegram APP 中收到的验证码
# 如果设置了两步验证,则会出现以下提示
The two-step verification is enabled and a password is required
Password hint: None
Enter password (empty to recover): # 此处输入两步验证密码
\
出现已启动提示,代表登录成功,此时可以去 Telegram 任意聊天发送 ,help
进行测试。\
请注意保护好您已登录的 pagermaid.session
(该文件在 Pagermaid 运行目录下)。此文件可以进行账号所有操作,请不要分享给他人使用。
进程守护
首先按下 Ctrl
键和 C
键停止运行\
然后输入以下命令:
cat <<'TEXT' > /etc/systemd/system/pagermaid_pyro.service
[Unit]
Description=PagerMaid-Pyro telegram utility daemon
After=network.target
[Install]
WantedBy=multi-user.target
[Service]
Type=simple
WorkingDirectory=/var/lib/pagermaid_pyro
ExecStart=/usr/bin/python3 -m pagermaid
Restart=always
TEXT
\
设置完成后启动程序:
systemctl start pagermaid_pyro
设置为开机自启:
systemctl enable pagermaid_pyro
至此 Pagermaid-Pyro 搭建完成,enjoy \
如需停止程序,使用以下命令即可:
systemctl stop pagermaid_pyro
插件安装
安装后只能使用自带功能,但 Pagermaid 支持通过插件扩充功能。
官方 Github 插件仓库:https://github.com/TeamPGM/PagerMaid_Plugins\
官方 Gitlab 插件仓库:https://gitlab.com/Xtao-Labs/PagerMaid_Plugins\
请选择 v2 分支,master 分支为 Pagermaid-Modify(旧版)的插件
\
如上图,插件名即为文件夹名称,在任意聊天中发送 ,apt install <插件名>
即可安装。\
如需安装第三方/自制插件,发送插件 Python 文件至任意聊天,然后回复该文件并发送 ,apt install
即可安装。