commit 5ad221657fab53f7fbf0457466ed9f9508087849 Author: xtaodada Date: Mon Jul 25 21:01:54 2022 +0800 Pyro Docs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8a77881 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.idea/ +config.yml +downloads/ +pagermaid.session +pagermaid/ +plugins/ +unknown_errors.txt +__pycache__/ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e5ac700 --- /dev/null +++ b/LICENSE @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..010b5ce --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# 简介 + +PagerMaid-Pyro 是一个开源的 Telegram 人形自走 Bot 方案，功能强大而丰富，可以帮助你打造专属的便利功能。 + +本 Wiki 主要详细说明搭建的流程和注意事项，以便各位用户依此搭建属于自己的 Userbot 。 + +由于资金有限和部分依赖包的安装方便性，这里主要提供 `ubuntu 16.04` 、`ubuntu 20.04`、`wsl` 和 `Archlinux` 的安装过程。（欢迎其他用户提供其他系统的搭建方法） + +# 功能 + +## 快速偷取贴纸 + +回复贴纸/图片/文件 `-s` 就可快速执行，心爱的贴纸全变自己的。 + +![](gif/s.gif) + +## 远程管理 + +输入 `-sh 命令` 就可快速通过 Telegram 管理自己的服务器。 + +![](gif/sh.gif) + +## 扩展 + +安装插件使用 `-apt install 插件名`，快速安装，方便使用。 + +![](gif/apt.gif) + +## 运行状态 + +随时使用 `-status` 监控 bot 是否正常运行。 + +![](gif/status.gif) + +## 时间 + +您可以使用地区名和数字查询某时区时间 `-time` 。 + +![](gif/time.gif) + +## 快速更新 + +主程序随时可以使用 `-update` 来检查更新。 + +![](gif/update.gif) + +# 搭建 + +## 手动搭建 + +欢迎加入 [讨论群](https://t.me/Invite_Challenge_Bot?start=1) 探讨你的疑问。 diff --git a/_coverpage.md b/_coverpage.md new file mode 100644 index 0000000..5d7a0c0 --- /dev/null +++ b/_coverpage.md @@ -0,0 +1,18 @@ + + +![logo](pagermaid-logo.png) + +# PagerMaid-Pyro 1.2.3 + +> 您必备的 Telegram 聊天工具箱 + +- 轻便 +- 多功能 +- 可扩展 + +[GitHub](https://github.com/TeamPGM/PagerMaid-Pyro) +[Get Started](#%e7%ae%80%e4%bb%8b) + + + +![](bg.jpg) diff --git a/_sidebar.md b/_sidebar.md new file mode 100644 index 0000000..34191b5 --- /dev/null +++ b/_sidebar.md @@ -0,0 +1,9 @@ + + +* [开始](README) +* 手动安装 + * [Ubuntu 16.04](ubuntu16) + * [Ubuntu 20.04](ubuntu20) + * [Centos 7](centos7) + * [Wsl](wsl) + * [Archlinux](archlinux) \ No newline at end of file diff --git a/archlinux.md b/archlinux.md new file mode 100644 index 0000000..c476206 --- /dev/null +++ b/archlinux.md @@ -0,0 +1,114 @@ +# 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-Pyro` 时，登录会有问题，当出现了问题，请在应用程序的配置步骤配置唯一的 `api_key` 和 `api_hash` ，然后在您的本地电脑上执行 `python3 utils/mksession.py` ，在账号登录成功以后，将生成的 `pagermaid.session` 文件复制到服务器对应目录即可。 + +!> 请注意保护好您已登录的 `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/bg.jpg b/bg.jpg new file mode 100644 index 0000000..11dee59 Binary files /dev/null and b/bg.jpg differ diff --git a/centos7.md b/centos7.md new file mode 100644 index 0000000..45e786e --- /dev/null +++ b/centos7.md @@ -0,0 +1,110 @@ +# 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-Pyro` 时，登录会有问题，当出现了问题，请在应用程序的配置步骤配置唯一的 `api_key` 和 `api_hash` ，然后在您的本地电脑上执行 `python3 utils/mksession.py` ，在账号登录成功以后，将生成的 `pagermaid.session` 文件复制到服务器对应目录即可。 + +!> 请注意保护好您已登录的 `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/circle-cropped.png b/circle-cropped.png new file mode 100644 index 0000000..d1c50c4 Binary files /dev/null and b/circle-cropped.png differ diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000..f8d098d Binary files /dev/null and b/favicon.ico differ diff --git a/gif/apt.gif b/gif/apt.gif new file mode 100644 index 0000000..c92315d Binary files /dev/null and b/gif/apt.gif differ diff --git a/gif/hitokoto.gif b/gif/hitokoto.gif new file mode 100644 index 0000000..712d3fa Binary files /dev/null and b/gif/hitokoto.gif differ diff --git a/gif/s.gif b/gif/s.gif new file mode 100644 index 0000000..d93a6f5 Binary files /dev/null and b/gif/s.gif differ diff --git a/gif/sh.gif b/gif/sh.gif new file mode 100644 index 0000000..b565fb4 Binary files /dev/null and b/gif/sh.gif differ diff --git a/gif/status.gif b/gif/status.gif new file mode 100644 index 0000000..673c535 Binary files /dev/null and b/gif/status.gif differ diff --git a/gif/time.gif b/gif/time.gif new file mode 100644 index 0000000..c470c98 Binary files /dev/null and b/gif/time.gif differ diff --git a/gif/update.gif b/gif/update.gif new file mode 100644 index 0000000..3e21921 Binary files /dev/null and b/gif/update.gif differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..fb9b8fc --- /dev/null +++ b/index.html @@ -0,0 +1,64 @@ + + + + + PagerMaid-Pyro 用户文档 + + + + + + + + + + + + + + + + + + + + +
加载中
+ + + + + + + + + + + + diff --git a/logo-big.png b/logo-big.png new file mode 100644 index 0000000..fb996a1 Binary files /dev/null and b/logo-big.png differ diff --git a/pagermaid-logo.png b/pagermaid-logo.png new file mode 100644 index 0000000..435271f Binary files /dev/null and b/pagermaid-logo.png differ diff --git a/sw.js b/sw.js new file mode 100644 index 0000000..ab3dbd3 --- /dev/null +++ b/sw.js @@ -0,0 +1,83 @@ +/* =========================================================== + * docsify sw.js + * =========================================================== + * Copyright 2016 @huxpro + * Licensed under Apache 2.0 + * Register service worker. + * ========================================================== */ + +const RUNTIME = 'docsify' +const HOSTNAME_WHITELIST = [ + self.location.hostname, + 'fonts.gstatic.com', + 'fonts.googleapis.com', + 'cdn.jsdelivr.net' +] + +// The Util Function to hack URLs of intercepted requests +const getFixedUrl = (req) => { + var now = Date.now() + var url = new URL(req.url) + + // 1. fixed http URL + // Just keep syncing with location.protocol + // fetch(httpURL) belongs to active mixed content. + // And fetch(httpRequest) is not supported yet. + url.protocol = self.location.protocol + + // 2. add query for caching-busting. + // Github Pages served with Cache-Control: max-age=600 + // max-age on mutable content is error-prone, with SW life of bugs can even extend. + // Until cache mode of Fetch API landed, we have to workaround cache-busting with query string. + // Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190 + if (url.hostname === self.location.hostname) { + url.search += (url.search ? '&' : '?') + 'cache-bust=' + now + } + return url.href +} + +/** + * @Lifecycle Activate + * New one activated when old isnt being used. + * + * waitUntil(): activating ====> activated + */ +self.addEventListener('activate', event => { + event.waitUntil(self.clients.claim()) +}) + +/** + * @Functional Fetch + * All network requests are being intercepted here. + * + * void respondWith(Promise r) + */ +self.addEventListener('fetch', event => { + // Skip some of cross-origin requests, like those for Google Analytics. + if (HOSTNAME_WHITELIST.indexOf(new URL(event.request.url).hostname) > -1) { + // Stale-while-revalidate + // similar to HTTP's stale-while-revalidate: https://www.mnot.net/blog/2007/12/12/stale + // Upgrade from Jake's to Surma's: https://gist.github.com/surma/eb441223daaedf880801ad80006389f1 + const cached = caches.match(event.request) + const fixedUrl = getFixedUrl(event.request) + const fetched = fetch(fixedUrl, { cache: 'no-store' }) + const fetchedCopy = fetched.then(resp => resp.clone()) + + // Call respondWith() with whatever we get first. + // If the fetch fails (e.g disconnected), wait for the cache. + // If there’s nothing in cache, wait for the fetch. + // If neither yields a response, return offline pages. + event.respondWith( + Promise.race([fetched.catch(_ => cached), cached]) + .then(resp => resp || fetched) + .catch(_ => { /* eat any errors */ }) + ) + + // Update the cache with the version we fetched (only for ok status) + event.waitUntil( + Promise.all([fetchedCopy, caches.open(RUNTIME)]) + .then(([response, cache]) => response.ok && cache.put(event.request, response)) + .catch(_ => { /* eat any errors */ }) + ) + } +}) \ No newline at end of file diff --git a/ubuntu16.md b/ubuntu16.md new file mode 100644 index 0000000..2a7786e --- /dev/null +++ b/ubuntu16.md @@ -0,0 +1,104 @@ +# 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-Pyro` 时，登录会有问题，当出现了问题，请在应用程序的配置步骤配置唯一的 `api_key` 和 `api_hash` ，然后在您的本地电脑上执行 `python3 utils/mksession.py` ，在账号登录成功以后，将生成的 `pagermaid.session` 文件复制到服务器对应目录即可。 + +!> 请注意保护好您已登录的 `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 new file mode 100644 index 0000000..6150438 --- /dev/null +++ b/ubuntu20.md @@ -0,0 +1,112 @@ +# 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-Pyro` 时，登录会有问题，当出现了问题，请在应用程序的配置步骤配置唯一的 `api_key` 和 `api_hash` ，然后在您的本地电脑上执行 `python3 utils/mksession.py` ，在账号登录成功以后，将生成的 `pagermaid.session` 文件复制到服务器对应目录即可。 + +!> 请注意保护好您已登录的 `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`