diff --git a/README.md b/README.md index f386f35..50e3812 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ PagerMaid-Pyro 是一个开源的 Telegram 人形自走 Bot 方案，功能强 本 Wiki 主要详细说明搭建的流程和注意事项，以便各位用户依此搭建属于自己的 Userbot 。 -由于资金有限和部分依赖包的安装方便性，这里主要提供 `ubuntu 16.04` 、`ubuntu 20.04`、`wsl` 和 `Archlinux` 的安装过程。（欢迎其他用户提供其他系统的搭建方法） +由于资金有限和部分依赖包的安装方便性，这里主要提供 `Ubuntu`、`Debian`、`wsl` 和 `Arch Linux` 的安装过程。（欢迎其他用户提供其他系统的搭建方法） # 功能 diff --git a/_sidebar.md b/_sidebar.md index ab8cd7f..918acfb 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -2,10 +2,8 @@ * [开始](README) * 手动安装 - * [Ubuntu 16.04](ubuntu16) - * [Ubuntu 20.04](ubuntu20) - * [Centos 7](centos7) - * [Wsl](wsl) - * [Archlinux](archlinux) + * [安装软件包依赖](install_dependencies) + * [配置环境](configure_environment) + * [安装并配置 PagerMaid](setup) * [插件](plugins) * [websocket](websocket) diff --git a/archlinux.md b/archlinux.md deleted file mode 100644 index e4fa4c2..0000000 --- a/archlinux.md +++ /dev/null @@ -1,112 +0,0 @@ -# Archlinux - -一个经典的国内家用 Linux 。 - -# 拉取项目 - -本项目托管在 `github` ，所以您首先需要检查您是否已经安装 `git` 软件包。并且我们发现当 `git` 软件包版本过低时，无法实现程序的自动更新，所以您需要首先升级 `git` 软件包： - -```bash -sudo pacman -S git -``` - -从仓库拉取项目 - -```bash -cd /var/lib && git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid && cd pagermaid -``` - -# 安装软件包 - -## neofetch - -?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 - -```bash -sudo pacman -S neofetch -``` - -## zbar - -?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 - -```bash -sudo pacman -S zbar -``` - -# 安装依赖包 - -```bash -pip3 install -r requirements.txt -``` - -# 修改配置文件 - -将配置 `config.gen.yml` 文件复制一份并且命名为 `config.yml` - -```bash -cp config.gen.yml config.yml -``` - -然后去 [telegram 官网](https://my.telegram.org/) 生成 api 填入配置文件内，我们只需要复制 `api id` 和 `api_hash` 值 填入 `api_key` 和 `api_hash` 。 - -```bash -vi config.yml -``` - -> 按 i 进入编辑模式，粘贴好后，按下 esc 输入 shift 加冒号，输入 wq 保存退出 - -## 代理配置 - -### GitSource - -此步是将安装插件的获取源文件更改为国内可以访问的反代源，但是可能因为 cdn 原因，插件更新不及时。 - -```bash -git_source: "https://gitlab.com/Xtao-Labs/PagerMaid_Plugins/-/raw/master/" -``` - -# 登录账号 - -```bash -python3 -m pagermaid -``` - -此步需要填入完整的电话号码（eg：`+12569986522`）然后 tg 会发给你的其他客户端发送验证码，填入验证码后，回车，如有两步验证密码，则再输入两步验证密码即可。 - -停止运行： - -```bash -ctrl + c -``` - -!> 请注意保护好您已登录的 `pagermaid.session` 。此文件可以进行账号所有操作，请不要分享给他人使用。 - -# 进程守护 - -此步骤可以方便 `pagermaid` 的自动运行，您无需在 `pagermaid` 意外退出后重新登录主机进行操作。 - -```bash -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 -WorkingDirectory=/var/lib/pagermaid -ExecStart=/usr/bin/python3 -m pagermaid -Restart=always -TEXT -``` - -# 常用指令 - -启动程序：`systemctl start pagermaid` - -设置为开机自启：`systemctl enable pagermaid` - -停止程序：`systemctl stop pagermaid` diff --git a/centos7.md b/centos7.md deleted file mode 100644 index 204492f..0000000 --- a/centos7.md +++ /dev/null @@ -1,108 +0,0 @@ -# Centos 7 - -一个经典的老牌系统。 - -# 拉取项目 - -本项目托管在 `github` ，所以您首先需要检查您是否已经安装 `git` 软件包。并且我们发现当 `git` 软件包版本过低时，无法实现程序的自动更新，所以您需要首先升级 `git` 软件包： - -```bash -sudo yum install git -y -``` - -从仓库拉取项目 - -```bash -cd /var/lib && git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid && cd pagermaid -``` - -# 安装软件包 - -## neofetch - -?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 - -```bash -sudo yum install epel-release -y - -curl -o /etc/yum.repos.d/konimex-neofetch-epel-7.repo https://copr.fedorainfracloud.org/coprs/konimex/neofetch/repo/epel-7/konimex-neofetch-epel-7.repo - -sudo yum install neofetch -y -``` - -## zbar - -?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 - -```bash -sudo yum install zbar-devel -y - -sudo yum install zbar -y -``` - -# 安装依赖包 - -```bash -pip3 install -r requirements.txt -``` - -# 修改配置文件 - -将配置 `config.gen.yml` 文件复制一份并且命名为 `config.yml` - -```bash -cp config.gen.yml config.yml -``` - -然后去 [telegram 官网](https://my.telegram.org/) 生成 api 填入配置文件内，我们只需要复制 `api id` 和 `api_hash` 值 填入 `api_key` 和 `api_hash` 。 - -```bash -vi config.yml -``` - -> 按 i 进入编辑模式，粘贴好后，按下 esc 输入 shift 加冒号，输入 wq 保存退出 - -# 登录账号 - -```bash -python3 -m pagermaid -``` - -此步需要填入完整的电话号码（eg：`+12569986522`）然后 tg 会发给你的其他客户端发送验证码，填入验证码后，回车，如有两步验证密码，则再输入两步验证密码即可。 - -停止运行： - -```bash -ctrl + c -``` - -!> 请注意保护好您已登录的 `pagermaid.session` 。此文件可以进行账号所有操作，请不要分享给他人使用。 - -# 进程守护 - -此步骤可以方便 `pagermaid` 的自动运行，您无需在 `pagermaid` 意外退出后重新登录主机进行操作。 - -```bash -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 -WorkingDirectory=/var/lib/pagermaid -ExecStart=/usr/bin/python3 -m pagermaid -Restart=always -TEXT -``` - -# 常用指令 - -启动程序：`systemctl start pagermaid` - -设置为开机自启：`systemctl enable pagermaid` - -停止程序：`systemctl stop pagermaid` diff --git a/configure_environment.md b/configure_environment.md new file mode 100644 index 0000000..113df2c --- /dev/null +++ b/configure_environment.md @@ -0,0 +1,56 @@ +# 配置环境 + +## 为 PagerMaid 创建用户 + +为了您的操作不当而造成不可预期的后果，应避免应用直接运行在 `root` 用户，此处我们为 PagerMaid 创建用户。 + +1. 创建用户 + + 创建 `pagermaid` 用户，并为其创建家目录： + + ```bash + sudo useradd -m pagermaid + ``` + +2. 设置密码（可选） + + 如果您有需求为用户设置密码，只需执行 `sudo passwd pagermaid` 即可。 + +3. 为用户提供 `sudo` 权限（可选） + + 如果您有需求让 PagerMaid 执行需要 `root` 权限的操作，则需进行以下操作： + + - 提供 `sudo` 权限 + + ```bash + sudo usermod -a -G sudo pagermaid + ``` + + - 使 pagermaid 用户无需密码认证使用 `sudo` + + 在执行 `visudo` 后，在末尾追加以下内容： + + ``` + pagermaid ALL=(ALL) NOPASSWD:ALL + ``` + +4. 设置默认 Shell（可选） + + 默认情况下，创建用户后，用户的默认 Shell 为 `sh`，对用户的操作十分不便。 + + 通常情况下，我们选用 `bash` 作为我们的默认 Shell，当然，您也可以选用诸如 `zsh` 的 Shell。 + + 如果您有需求修改默认 Shell，则需进行以下操作： + + ```bash + sudo chsh -s /bin/bash pagermaid + ``` + + （如果您不使用 `bash`，可以修改 `/bin/bash` 为你所需设置的 Shell 的路径） + +5. 进入用户进行接下来的操作 + + ```bash + sudo su pagermaid # 进入 pagermaid 用户 + cd ~ # 进入 pagermaid 用户家目录 + ``` diff --git a/install_dependencies.md b/install_dependencies.md new file mode 100644 index 0000000..b45652a --- /dev/null +++ b/install_dependencies.md @@ -0,0 +1,90 @@ +# 安装软件包依赖 + +## Arch Linux + +## neofetch + +?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 + +```bash +sudo pacman -S neofetch +``` + +## zbar + +?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 + +```bash +sudo pacman -S zbar +``` + +## Git + +?> 此软件包用于拉取 PagerMaid 仓库及用于 PagerMaid 的后续更新。 + +```bash +sudo pacman -S git +``` + +## Debian / Ubuntu + +### neofetch + +?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 + +```bash +sudo apt install neofetch -y +``` + +### zbar + +?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 + +```bash +sudo apt install libzbar-dev -y +``` + +### Pip + +?> 此软件包为必须依赖包，用于安装 Python 依赖。 + +```bash +sudo apt install python3-pip -y +``` + +### Git + +?> 此软件包用于拉取 PagerMaid 仓库及用于 PagerMaid 的后续更新。 + +```bash +sudo apt install -y git +``` + +## CentOS 7 + +### neofetch + +?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 + +```bash +sudo yum install epel-release -y +curl -o /etc/yum.repos.d/konimex-neofetch-epel-7.repo https://copr.fedorainfracloud.org/coprs/konimex/neofetch/repo/epel-7/konimex-neofetch-epel-7.repo +sudo yum install neofetch -y +``` + +### zbar + +?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 + +```bash +sudo yum install zbar-devel -y +sudo yum install zbar -y +``` + +### Git + +?> 此软件包用于拉取 PagerMaid 仓库及用于 PagerMaid 的后续更新。 + +```bash +sudo yum install -y git +``` diff --git a/setup.md b/setup.md new file mode 100644 index 0000000..e94ad71 --- /dev/null +++ b/setup.md @@ -0,0 +1,83 @@ +# 安装并配置 PagerMaid + +## 拉取项目 + +```bash +git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid +``` + +## 安装依赖包 + +```bash +pip3 install -r requirements.txt +``` + +## 修改配置文件 + +1. 将配置 `config.gen.yml` 文件复制一份并且命名为 `config.yml` + + ```bash + cp config.gen.yml config.yml # 复制模板 + vi config.yml # 修改文件 + ``` + +2. 设置 API（可选） + + 在 [Telegram 开发者面板](https://my.telegram.org/) 生成 API 信息，将 `App api_id` 和 `App api_hash` 分别填入 `api_key` 和 `api_hash` + +3. 代理配置（可选） + + 此步是将安装插件的获取源文件更改为国内可以访问的反代源，但是可能因为 cdn 原因，插件更新不及时。 + + ```yaml + git_source: "https://gitlab.com/Xtao-Labs/PagerMaid_Plugins/-/raw/master/" + ``` + +4. 二维码登录（用于无法接收到验证码）（可选） + + 此步是将登录方式切换到手机扫码登录，解决无法收到验证码的问题，手机扫码途径：`运行 APP - 设置 - 设备 - 扫码登录新客户端`。 + + ```yaml + qrcode_login: "True" + ``` + +## 登录账号 + +```bash +python3 -m pagermaid +``` + +填入完整的电话号码（如：`+12569986522`），随即 Telegram 将会向你的其他客户端发送验证码，填入验证码即可。如有两步验证密码，则再输入两步验证密码即可。 + +完成以上步骤后，按下 `Ctrl + C` 终止应用。 + +!> 请注意保护好您已登录的 `pagermaid.session` 。此文件可以进行账号所有操作，请不要分享给他人使用。 + +## 进程守护 + +此步骤可以方便 `PagerMaid` 的自动运行，您无需在 `PagerMaid` 意外退出或主机重启后重新登录主机进行操作。 + +```bash +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` diff --git a/ubuntu16.md b/ubuntu16.md deleted file mode 100644 index 37cbe20..0000000 --- a/ubuntu16.md +++ /dev/null @@ -1,102 +0,0 @@ -# Ubuntu16.04 - -一个经典的老牌系统。 - -# 拉取项目 - -本项目托管在 `github` ，所以您首先需要检查您是否已经安装 `git` 软件包。并且我们发现当 `git` 软件包版本过低时，无法实现程序的自动更新，所以您需要首先升级 `git` 软件包： - -```bash -sudo apt-get install --only-upgrade git -y -``` - -从仓库拉取项目 - -```bash -cd /var/lib && git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid && cd pagermaid -``` - -# 安装软件包 - -## neofetch - -?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 - -```bash -apt-get install software-properties-common && sudo add-apt-repository ppa:dawidd0811/neofetch && sudo apt-get update && sudo apt-get install neofetch -``` - -## zbar - -?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 - -```bash -sudo apt-get install libzbar-dev -y -``` - -# 安装依赖包 - -```bash -pip3 install -r requirements.txt -``` - -# 修改配置文件 - -将配置 `config.gen.yml` 文件复制一份并且命名为 `config.yml` - -```bash -cp config.gen.yml config.yml -``` - -然后去 [telegram 官网](https://my.telegram.org/) 生成 api 填入配置文件内，我们只需要复制 `api id` 和 `api_hash` 值 填入 `api_key` 和 `api_hash` 。 - -```bash -vi config.yml -``` - -> 按 i 进入编辑模式，粘贴好后，按下 esc 输入 shift 加冒号，输入 wq 保存退出 - -# 登录账号 - -```bash -python3 -m pagermaid -``` - -此步需要填入完整的电话号码（eg：`+12569986522`）然后 tg 会发给你的其他客户端发送验证码，填入验证码后，回车，如有两步验证密码，则再输入两步验证密码即可。 - -停止运行： - -```bash -ctrl + c -``` - -!> 请注意保护好您已登录的 `pagermaid.session` 。此文件可以进行账号所有操作，请不要分享给他人使用。 - -# 进程守护 - -此步骤可以方便 `pagermaid` 的自动运行，您无需在 `pagermaid` 意外退出后重新登录主机进行操作。 - -```bash -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 -WorkingDirectory=/var/lib/pagermaid -ExecStart=/usr/bin/python3 -m pagermaid -Restart=always -TEXT -``` - -# 常用指令 - -启动程序：`systemctl start pagermaid` - -设置为开机自启：`systemctl enable pagermaid` - -停止程序：`systemctl stop pagermaid` diff --git a/ubuntu20.md b/ubuntu20.md deleted file mode 100644 index cd79327..0000000 --- a/ubuntu20.md +++ /dev/null @@ -1,110 +0,0 @@ -# Ubuntu20.04 - -一个流行的老牌系统。 - -# 拉取项目 - -本项目托管在 `github` ，所以您首先需要检查您是否已经安装 `git` 软件包。并且我们发现当 `git` 软件包版本过低时，无法实现程序的自动更新，所以您需要首先升级 `git` 软件包： - -```bash -sudo apt install --upgrade git -y -``` - -从仓库拉取项目 - -```bash -cd /var/lib && git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid && cd pagermaid -``` - -# 安装软件包 - -## neofetch - -?> 此软件包用于显示系统信息，如您没有显示系统信息需求，您可以无需安装此软件包。 - -```bash -sudo apt install neofetch -y -``` - -## zbar - -?> 此软件包用于处理二维码信息，如您没有处理二维码信息需求，您可以无需安装此软件包。 - -```bash -sudo apt install libzbar-dev -y -``` - -## Pip - -?> 此软件包为必须依赖包，用于安装 python 依赖。 - -```bash -sudo apt install python3-pip -y -``` - -# 安装依赖包 - -```bash -pip3 install -r requirements.txt -``` - -# 修改配置文件 - -将配置 `config.gen.yml` 文件复制一份并且命名为 `config.yml` - -```bash -cp config.gen.yml config.yml -``` - -然后去 [telegram 官网](https://my.telegram.org/) 生成 api 填入配置文件内，我们只需要复制 `api id` 和 `api_hash` 值 填入 `api_key` 和 `api_hash` 。 - -```bash -vi config.yml -``` - -> 按 i 进入编辑模式，粘贴好后，按下 esc 输入 shift 加冒号，输入 wq 保存退出 - -# 登录账号 - -```bash -python3 -m pagermaid -``` - -此步需要填入完整的电话号码（eg：`+12569986522`）然后 tg 会发给你的其他客户端发送验证码，填入验证码后，回车，如有两步验证密码，则再输入两步验证密码即可。 - -停止运行： - -```bash -ctrl + c -``` - -!> 请注意保护好您已登录的 `pagermaid.session` 。此文件可以进行账号所有操作，请不要分享给他人使用。 - -# 进程守护 - -此步骤可以方便 `pagermaid` 的自动运行，您无需在 `pagermaid` 意外退出后重新登录主机进行操作。 - -```bash -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 -WorkingDirectory=/var/lib/pagermaid -ExecStart=/usr/bin/python3 -m pagermaid -Restart=always -TEXT -``` - -# 常用指令 - -启动程序：`systemctl start pagermaid` - -设置为开机自启：`systemctl enable pagermaid` - -停止程序：`systemctl stop pagermaid`