本文使用的系统为Debian11
安装软件包依赖
Debian / Ubuntu
neofetch
此软件包用于显示系统信息,如您没有显示系统信息需求,您可以无需安装此软件包。
sudo apt install neofetch -y
zbar
此软件包用于处理二维码信息,如您没有处理二维码信息需求,您可以无需安装此软件包。
sudo apt install libzbar-dev -y
Pip
此软件包为必须依赖包,用于安装 Python 依赖。
sudo apt install python3-pip -y
Git
此软件包用于拉取 PagerMaid 仓库及用于 PagerMaid 的后续更新。
sudo apt install -y git
配置环境
为 PagerMaid 创建用户
为了您的操作不当而造成不可预期的后果,应避免应用直接运行在 root
用户,此处我们为 PagerMaid 创建用户。
创建用户创建 pagermaid
用户,并为其创建家目录:
sudo useradd -m pagermaid
设置密码(可选)如果您有需求为用户设置密码,只需执行
sudo passwd pagermaid
为用户提供 sudo
权限(可选)
如果您有需求让 PagerMaid 执行需要 root
权限的操作,则需进行以下操作:
提供 sudo
权限
sudo usermod -a -G sudo pagermaid
使 pagermaid 用户无需密码认证使用 sudo
在执行 visudo
后,在末尾追加以下内容:
pagermaid ALL=(ALL) NOPASSWD:ALL

设置默认 Shell(可选)默认情况下,创建用户后,用户的默认 Shell 为 sh
,对用户的操作十分不便。
通常情况下,我们选用 bash
作为我们的默认 Shell,当然,您也可以选用诸如 zsh
的 Shell。
如果您有需求修改默认 Shell,则需进行以下操作:
sudo chsh -s /bin/bash pagermaid
(如果您不使用 bash
,可以修改 /bin/bash
为你所需设置的 Shell 的路径)
进入用户进行接下来的操作
sudo su pagermaid # 进入 pagermaid 用户
cd ~ # 进入 pagermaid 用户家目录
安装并配置 PagerMaid
拉取项目
git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid
安装依赖包
pip3 install -r requirements.txt
修改配置文件
将配置 config.gen.yml
文件复制一份并且命名为 config.yml
cp config.gen.yml config.yml # 复制模板
vi config.yml # 修改文件
设置 API(可选)
在 Telegram 开发者面板 生成 API 信息,将 App api_id
和 App api_hash
分别填入 api_key
和 api_hash
代理配置(可选)
此步是将安装插件的获取源文件更改为国内可以访问的反代源,但是可能因为 cdn 原因,插件更新不及时。
git_source: "https://gitlab.com/Xtao-Labs/PagerMaid_Plugins/-/raw/master/"
二维码登录(用于无法接收到验证码)(可选)
此步是将登录方式切换到手机扫码登录,解决无法收到验证码的问题,手机扫码途径:运行 APP - 设置 - 设备 - 扫码登录新客户端
。
qrcode_login: "True"
登录账号
python3 -m pagermaid
填入完整的电话号码(如:+12569986522
),随即 Telegram 将会向你的其他客户端发送验证码,填入验证码即可。如有两步验证密码,则再输入两步验证密码即可。
完成以上步骤后,按下 Ctrl + C
终止应用。
请注意保护好您已登录的 pagermaid.session
。此文件可以进行账号所有操作,请不要分享给他人使用。
进程守护
此步骤可以方便 PagerMaid
的自动运行,您无需在 PagerMaid
意外退出或主机重启后重新登录主机进行操作。
sudo cat <<'TEXT' > /etc/systemd/system/pagermaid.service
[Unit]
Description=PagerMaid-Pyro Telegram Utility Daemon
After=network.target
[Install]
WantedBy=multi-user.target
[Service]
Type=simple
User=pagermaid
Group=pagermaid
WorkingDirectory=/home/pagermaid/pagermaid
ExecStart=/usr/bin/python3 -m pagermaid
Restart=always
TEXT
常用指令
- 启动程序:
sudo systemctl start pagermaid
- 设置为开机自启:
sudo systemctl enable pagermaid
- 停止程序:
sudo systemctl stop pagermaid
开始使用网页控制台

说明
从 PGP 的 1.3.0
版本开始,我们支持通过网页控制台管理机器人的插件和一些设置,未来也会在控制台中添加更多功能。
网页控制台的默认地址为: http://127.0.0.1:3333
功能
查看日志、重启、更新

命令别名管理

忽略群组管理

本地插件管理

插件仓库管理

开启控制台
确认 host
如果你只需要内网访问,那么你将要配置的 host
为 127.0.0.1
,如果你需要公网访问控制台,那么你将要配置的 host
为 0.0.0.0
。
绝大多数情况,你的 host
为 0.0.0.0
,请不要填入其他无关的值。
非 Docker 用户
请找到 PGP 的配置文件 config.yml
,修改为如下值
web_interface:
enable: "True"
secret_key: "控制台密码"
host: "0.0.0.0" // 或者上面你确认的 127.0.0.1
port: "3333"
origins: ["*"]
Docker 用户
由于 docker 需要进行端口映射,创建的旧容器无缝升级比较复杂,推荐使用新脚本进行重装,重装时将会询问是否开启 web 控制台。