Update docs

This commit is contained in:
xtaodada 2023-05-27 22:58:02 +08:00
parent 99d1b39321
commit cf6268ae72
Signed by: xtaodada
GPG Key ID: 4CBB3F4FA8C85659
5 changed files with 9 additions and 63 deletions

View File

@ -2,8 +2,8 @@
* [开始](README)
* 手动安装
* [第三方文档](https://owo.cab/32)
* [安装软件包依赖](install_dependencies)
* [配置环境](configure_environment)
* [安装并配置 PagerMaid](setup)
* 网页控制台
* [配置控制台](web_local)

View File

@ -1,56 +0,0 @@
# 配置环境
## 为 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 用户家目录
```

View File

@ -3,7 +3,9 @@
## 拉取项目
```bash
cd /var/lib
git clone https://github.com/TeamPGM/PagerMaid-Pyro.git pagermaid
cd pagermaid
```
## 安装依赖包
@ -30,7 +32,7 @@ pip3 install -r requirements.txt
此步是将安装插件的获取源文件更改为国内可以访问的反代源,但是可能因为 cdn 原因,插件更新不及时。
```yaml
git_source: "https://gitlab.com/Xtao-Labs/PagerMaid_Plugins/-/raw/master/"
git_source: "https://gitlab.com/Xtao-Labs/PagerMaid_Plugins_Pyro/-/raw/v2/"
```
4. 二维码登录(用于无法接收到验证码)(可选)
@ -68,9 +70,7 @@ WantedBy=multi-user.target
[Service]
Type=simple
User=pagermaid
Group=pagermaid
WorkingDirectory=/home/pagermaid/pagermaid
WorkingDirectory=/var/lib/pagermaid
ExecStart=/usr/bin/python3 -m pagermaid
Restart=always
TEXT

View File

@ -40,7 +40,7 @@
### 非 Docker 用户
请找到 PGP 的配置文件 `config.yml` ,修改如下值
请找到 PGP 的配置文件 `config.yml` 此文件的默认路径为 `/var/lib/pagermaid/config.yml`修改如下值
```yaml
web_interface:

View File

@ -6,6 +6,8 @@ PGP 采用前后端分离设计,如果你嫌内置的控制台过于丑陋,
## 连接
浏览器打开 [PagerMaid-Pyro Web Console](https://console.xtaolabs.com) ,在主界面填入你的服务地址。默认为 http://127.0.0.1:3333
浏览器打开 [PagerMaid-Pyro Web Console](https://console.xtaolabs.com) ,在主界面填入你的服务地址。
需要注意的是你需要反代控制台地址,以支持 https 链接。
![](web/6.png)