Deploy with Waitress

# Deploy with Waitress

This document describes how to deploy MrDoc using Waitress.

> Before performing the following operations, make sure you have completed the simple run of MrDoc. See: [https://doc.mrdoc.pro/doc/11/](https://doc.mrdoc.pro/doc/11/)

## Install Waitress

Waitress is a WSGI server written in Python, so you can download and install it directly using the `pip` command. The installation command is as follows:

```shell
pip install waitress
```

## Run Waitress

Create a new file named `run.py` in the root directory of MrDoc, and write the following code in it:

```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)
```

Execute the following command in the command line to run Waitress:

```shell
python run.py
```

At this point, you can visit the address `127.0.0.1:8888` in your browser to see the homepage of MrDoc.

## Register as a Windows Service

Now you can use MrDoc on your local computer, but once you shut down, you have to execute the command to run the Waitress script again.

If you need MrDoc to always remain running after the computer starts, you need to register it as a Windows service, which will use [nssm](http://nssm.cc/download "nssm").

After downloading the nssm compressed file, extract it.

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

According to your computer's operating system bit version, enter the win32/win64 folder, which contains a program file named `nssm.exe`.

Open a command line terminal as administrator within the folder, and enter the following command to register the Waitress running script as a Windows service:

```bash
nssm.exe install "MrDocService" "{Python program path}" "{run.py file path}"
```

For example:

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

If you see the following message, the service registration is successful:

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

Then you can start this service:

```
nssm.exe start MrDocService
```

The command to stop the service is:

```
nssm.exe stop MrDocService
```

If you need to delete this service, the command is:
```
nssm.exe remove MrDocService
```

## Nginx Reverse Proxy

Usually, you will use the same port (commonly port 80) to serve multiple web applications on a single server, or you need other computers to be able to access the web application running on your computer. The mainstream solution is to use Nginx.

### Download Nginx

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

Download the corresponding Nginx software package according to your computer version, and then extract it to the C drive.

As shown in the figure below:

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

### Edit the `nginx.conf` configuration file

Enter the `conf` directory and open the `nginx.conf` file:

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

Modify the `server` part of `http` to the following content:

```shell
server {
        listen       8000;
        server_name your IP address or domain name;

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

Finally, start Nginx, and you can access MrDoc through your IP address or domain name.