GitLab项目地址:https://gitlab.com/Xtao-Labs/pagermaid-modify

一键脚本(不推荐)

我是尝试过用一键脚本安装过的,但是容易出问题,所以不建议

一键脚本安装命令:

1
wget https://gitlab.com/Xtao-Labs/pagermaid-modify/-/raw/master/install.sh -O install.sh&& chmod +x install.sh && bash install.sh

脚本已测试系统:centos 7、centos 8、ubuntu 16.04、ubuntu 18.04、ubuntu 20.04、debian 9、debian 10

理论支持系统:Centos 7-8、Ubuntu 16.04-20.04、Debian 8-10

Docker安装

我未尝试过(VPS性能渣不敢用docker)

一键脚本安装

1
2
wget https://gitlab.com/Xtao-Labs/pagermaid-modify/-/raw/master/utils/docker.sh
bash docker.sh

注:一键脚本安装的Docker将以root权限运行,在使用pagermaid时最方便。如需要自定义,请使用docker-compose安装。

docker-compose安装

  1. 准备脚本
1
2
3
git clone https://gitlab.com/Xtao-Labs/pagermaid-modify.git pagermaid
cd pagermaid
cp docker-compose.gen.yml docker-compose.yml
  1. 编辑刚刚复制的docker-compose.yml为你自己的信息,如不想解决权限问题,建议RUN_AS_ROOT=true
  2. 有些插件还额外需要安装依赖包,这些依赖包初始状态是没有安装的,例如neteasemusic插件的依赖eyed3 pycryptodomecoin插件的依赖python-binance xmltodict等等,你如果需要用到这些插件,并且希望容器自动将依赖安装好,可以将依赖列在当前目录下的requirements2.txt中(没有这个文件,需要你自己建立)。容器将在启动时自动安装这些依赖。有此requirements2.txt文件以后,重新部署容器或者更新镜像,都将自动安装这些依赖,不再需要重复地手动安装。
  3. 启动容器docker-compose up -d
  4. 运行docker exec -it pagermaid bash utils/docker-config.sh进行配置。

手动安装

看似手动安装很复杂,但是实际上一行一行命令复制黏贴一路默认Y安装完成就好了

项目官方教程参考这里

拉取项目

本项目托管在 github ,所以您首先需要检查您是否已经安装 git 软件包。并且我们发现当 git 软件包版本过低时,无法实现程序的自动更新,所以您需要首先升级 git 软件包:

1
sudo apt-get install --only-upgrade git -y

从仓库拉取项目

1
cd /var/lib && git clone https://github.com/xtaodada/PagerMaid-Modify.git pagermaid && cd pagermaid

安装软件包

imagemagick

此软件包用于处理图片,如您没有图片处理需求,您可以无需安装此软件包。

1
sudo apt-get install imagemagick -y

neofetch

此软件包用于显示系统信息,如您没有显示系统信息需求,您可以无需安装此软件包。

1
apt-get install software-properties-common  && sudo add-apt-repository ppa:dawidd0811/neofetch && sudo apt-get update && sudo apt-get install neofetch

zbar

此软件包用于处理二维码信息,如您没有处理二维码信息需求,您可以无需安装此软件包。

1
sudo apt-get install libzbar-dev -y

tesseract

此软件包用于图片光学字符识别,如你没有处理此方面的需求,你可以无需安装此软件包。

最大化安装
1
sudo apt-get install tesseract-ocr tesseract-ocr-all -y

最小化安装

1
sudo apt-get install tesseract-ocr tesseract-ocr-eng tesseract-ocr-chi-sim -y

Redis

此软件包用于记录信息,以方便软件重启后仍然可以进行上一次未完成的任务,你也可以无需安装此软件包。

1
sudo apt-get install redis-server -y

安装依赖包

1
pip3 install -r requirements.txt

修改配置文件

将配置 config.gen.yml 文件复制一份并且命名为 config.yml

1
cp config.gen.yml config.yml

然后去 telegram 官网 生成 api 填入配置文件内,我们只需要复制 api id 和 api_hash 值 填入 api_key 和 api_hash 。(登陆账号选择web直接生成即可)

telegram 官网: https://my.telegram.org/

1
vi config.yml

按 i 进入编辑模式,粘贴好后,按下 esc 输入 shift 加冒号,输入 wq 保存退出

登录账号

1
python3 -m pagermaid

此步需要填入完整的电话号码(eg:+12569986522)然后 tg 会发给你的其他客户端发送验证码,填入验证码后,回车,如有两步验证密码,则再输入两步验证密码即可。

停止运行:

1
ctrl + c

有时(或大部分时间),当您在服务器部署 PagerMaid-modify 时,登录会有问题,当出现了问题,请在应用程序的配置步骤配置唯一的 api_keyapi_hash ,然后在您的本地电脑上执行 python3 utils/mksession.py ,在账号登录成功以后,将生成的 pagermaid.session 文件复制到服务器对应目录即可。

请注意保护好您已登录的 pagermaid.session 。此文件可以进行账号所有操作,请不要分享给他人使用。

进程守护

此步骤可以方便 pagermaid 的自动运行,您无需在 pagermaid 意外退出后重新登录主机进行操作。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
cat <<'TEXT' > /etc/systemd/system/pagermaid.service
[Unit]
Description=PagerMaid-Modify telegram utility daemon
After=network.target

[Install]
WantedBy=multi-user.target

[Service]
Type=simple
WorkingDirectory=/var/lib/pagermaid
ExecStart=/usr/bin/python3 -m pagermaid
Restart=always
TEXT

常用指令

启动程序:

1
systemctl start pagermaid

设置为开机自启:

1
systemctl enable pagermaid

停止程序:

1
systemctl stop pagermaid

使用

telegram中使用 -help 查看命令,安装插件使用命令 apt install 插件名安装,比如安装ghs插件,使用apt install bingwall即可安装成功

除了bingwall以外,还有keyword和weather等好用的插件等着你去发现

项目地址: https://gitlab.com/Xtao-Labs/pagermaid-modify


以下内容是来自官方的安装教程

安装

这是开始使用 PagerMaid 所需的说明,支持各种初始化系统。

要求

您需要 Linux*BSD 系统,并且您的系统应该至少运行 python 3.6 ,推荐虚拟环境运行。

为确保 Bug reporter 的正常进行可能您需要手动私聊 @KatOnKeyboard 一次。

快速开始

如果您的系统与docker兼容,并且您想要快速且受支持的安装,Docker 将帮助您快速入门。尽管很方便,但这种安装方法将系统范围的包限制在容器内。

https://my.telegram.org/ 上创建您的应用程序,然后运行以下命令:

1
curl -fsSL https://raw.githubusercontent.com/Xtao-Labs/PagerMaid-Modify/master/utils/docker.sh | sh

如果您想在运行之前检查脚本内容:

1
2
3
4
curl https://raw.githubusercontent.com/Xtao-Labs/PagerMaid-Modify/master/utils/docker.sh -o docker.sh
vim docker.sh
chmod 0755 docker.sh
./docker.sh

配置

将文件 config.gen.yml 复制一份到 config.yml ,并使用您最喜欢的文本编辑器,编辑配置文件,直到您满意为止。

从源代码安装

PagerMaid-Modify 工作目录复制到 /var/lib ,然后输入 /var/lib/pagermaid ,激活虚拟环境(如果需要),并从 requirements.txt 安装所有依赖项

python3 -m pagermaid

1
现在确保 `zbar` , `neofetch` , `tesseract` 和 `ImageMagick` 软件包是通过软件包管理器安装的,并且您已经准备好启动 `PagerMaid` 。

python3 -m pagermaid

1
2
3
4
5
## 从PyPi安装

为 `PagerMaid` 创建一个工作目录,通常为 `/var/lib/pagermaid` ,建议设置虚拟环境。

安装PagerMaid模块:

pip3 install pagermaid

1
现在确保 `zbar` , `neofetch` , `tesseract` 和 `ImageMagick` 软件包是通过软件包管理器安装的,并且您已经准备好启动 `PagerMaid` 。

pagermaid

1
2
3
4
5
6
7
8
9
10
11
12
13
14
## 进程守护

确保您至少手动运行过 `PagerMaid` 一次,或者已经存在 session 文件。
- Runit:在 `/etc/sv/pagermaid` 中创建一个目录,然后将 `utils/run` 复制到其中
- SystemD:将 `utils/pagermaid.service` 复制到 `/ var/lib/systemd/system` 中
- 直接:运行 `utils/start.sh`

## 身份验证

有时(或大部分时间),当您在服务器部署 `PagerMaid` 时,登录会有问题,当出现了问题,请在应用程序的配置步骤配置唯一的 `application key` 和 `hash` ,然后在您的PC上运行 `utils/mksession.py` ,将 `pagermaid.session` 复制到服务器。

## 插件

`some-plugins` 已经内置了部分插件,请根据需要复制到 plugins 启用。