使用 Waitress 部署

本文档介绍使用 Waitress 部署 MrDoc 觅思文档。

> s 在进行下述操作前，请确保你已完成了 MrDoc 的简易运行，详见：[https://doc.mrdoc.pro/doc/11/](https://doc.mrdoc.pro/doc/11/)

## 安装 Waitress

Waitress 是基于 Python 编写的 WSGI 服务器，所以你可以直接使用`pip`命令下载安装。安装命令如下所示：

```shell
pip install waitress
```

## 运行 Waitress

在 MrDoc觅思文档的根目录新建一个名为`run.py`，在其中写入如下代码：

```python
import os
from waitress import serve
from MrDoc.wsgi import application

this_files_dir = os.path.dirname(os.path.abspath(__file__))
os.chdir(this_files_dir)

if __name__ == '__main__':
    serve(application,host='127.0.0.1',port=8888)
```

在命令行执行如下命令即可运行 Waitress：

```shell
python run.py
```

这时，你在浏览器访问地址`127.0.0.1:8888`即可看到 MrDoc觅思文档的首页。

## 注册为 Windows 服务

现在你已经可以在本机电脑上使用 MrDoc，但是一旦关机，就得重新执行一次运行 Waitress 脚本的命令。

如果你需要在电脑启动后始终保持 MrDoc 的运行状态，那么需要将其注册为 Widnows 服务，这将使用到 [nssm](http://nssm.cc/download "nssm") 。

下载 nssm 压缩文件后，将其进行解压

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/02/10/2023-02-10_224203_3571130.884543796128828.png)

根据自己电脑的操作系统位数，进入 win32/win64 文件夹中，里面会有一个名为`nssm.exe`的程序文件。

在文件夹内以管理员身份打开命令行终端，输入如下命令，将 Waitress 运行的脚本注册为 Windows 服务：

```bash
nssm.exe install "MrDocService" "{Python程序路径}" "{run.py文件路径}"
```

例如：

```bash
nssm.exe install "MrDocService" "C:\Users\clz\AppData\Local\Programs\Python\Python37\python.exe" "D:\YangJian\MrDocPro\run.py"
```

如果看到如下消息，说明服务注册成功：

```bash
Service "MrDocService" installed successfully!
```

接着可以启动此服务：

```
nssm.exe start MrDocService
```

停止服务的命令为：

```
nssm.exe stop MrDocService
```

如果需要删除此服务，命令为：
```
nssm.exe remove MrDocService
```

## Nginx 反向代理

通常情况下，你会使用同一端口（常见的 80 端口）在单个服务器上为多个 Web 应用程序提供服务，或者需要别的电脑也能访问到你的电脑上运行的 Web 应用。主流的解决方案是使用 Nginx。

### 下载 Nginx

https://nginx.org/en/download.html

按照自己的电脑版本下载对应的 Nginx 软件包，然后解压到 C 盘。

如下图所示：

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/03/07/2023-03-07_091340_7712170.9009313474980494.png)

### 编辑`nginx.conf`配置文件

进入`conf`目录，打开`nginx.conf`文件：

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/03/07/2023-03-07_091422_8559640.7521861499125919.png)

修改 `http` 的 `server` 的部分为以下内容：

```shell
server {
        listen       8000;
        server_name 你的IP地址或域名;

location / {
            proxy_pass http://localhost:8888/;
            proxy_set_header X-Real-IP $remote_addr;
        }
    }
```

最后启动 Nginx，就可以通过你的IP地址或域名来访问觅思文档了。