Deploy MrDoc on Windows

# Windows Deployment of MrDoc

MrDoc supports deployment on Windows systems, suitable for personal computers, intranet servers, and Windows Server environments.

The following two deployment methods are currently available:

* **Waitress Deployment**: Run MrDoc directly using Python + Waitress. Simple configuration, suitable for individual users and general intranet environments.
* **Windows Deployment Panel**: Configure the Python environment, web service, and other settings through a Windows panel. Suitable for users who prefer a visual management panel.

## Choosing the Right Deployment Method

| Deployment Method | Recommended Scenario | Difficulty | Features |
| ---------------- | ---------------- | -- | ------------ |
| **Waitress Deployment** | Personal computers, intranet servers, lightweight deployment | ⭐⭐ | Simple configuration, fewer dependencies |
| **Windows Deployment Panel** | Users who want to manage servers with a visual panel | ⭐⭐ | Graphical management, more intuitive operation |

If you are familiar with the Windows command line and Python, **Waitress Deployment is recommended as the first choice**.

If you want to manage Python projects, websites, and services through a graphical interface, you can choose the **Windows Deployment Panel**.

## Preparation Before Deployment

Before starting the deployment, please confirm that the server meets the following basic requirements:

* Windows 10 / Windows 11 or Windows Server and other Windows systems
* A 64-bit system is recommended
* Administrator privileges
* The MrDoc installation package is ready
* Ensure that the port used by MrDoc is not occupied by other programs

If you need other computers to access MrDoc, you also need to open the corresponding port according to the actual network environment.

> If you only use it on the local machine, you can access it directly through `127.0.0.1`; if you need other devices on the LAN to access it, you need to use the server's LAN IP address.

## Deployment Methods

### Deploy with Waitress

Waitress is a Python WSGI server suitable for Windows and can run MrDoc directly.

This method does not require installing an additional Linux environment or Docker, and is suitable for users who want to run MrDoc with fewer components.

👉 **[Deploy with Waitress](/d/waitress-deploy/)**

### Use the Windows Deployment Panel

If you are more accustomed to using graphical management tools, you can use the Windows Deployment Panel to complete the deployment of MrDoc.

👉 **[Windows Deployment Panel](/d/windows-deploy-panel/)**

## After Deployment Is Complete

After MrDoc starts successfully, you can access it through a browser:

```text
http://server-IP:port/
```

For example:

```text
http://127.0.0.1:10086/
```

After the first access, you can complete the initialization configuration such as the administrator account according to the page prompts.

If you need other devices to access it, replace `127.0.0.1` with the actual IP address of the server, for example:

```text
http://192.168.1.100:10086/
```

## Data and Configuration

After MrDoc is deployed, please make sure to keep the following content safe:

* MrDoc configuration file
* Database
* `media` directory
* Other data directories generated by the actual deployment method

The `media` directory is usually used to store files such as images and attachments uploaded by users.

**Before upgrading MrDoc or migrating the server, be sure to back up the data first.**

> It is not recommended to directly delete the old version directory and redeploy, otherwise the database, uploaded files, or custom configurations may be lost.

## MrDoc Upgrade

After MrDoc is updated to a new version, you can upgrade according to the deployment method currently in use.

Before upgrading, it is recommended to:

1. Back up the database.
2. Back up the `media` directory.
3. Back up custom configurations.
4. Stop the running MrDoc service.
5. Replace the old version program with the new version program.
6. Perform the necessary upgrade operations according to the new version instructions.
7. Restart MrDoc.
8. Check whether the website, login, documents, and attachments are normal.

For the specific upgrade steps of different deployment methods, please refer to the corresponding deployment documentation.

## Common Issues

### The Browser Cannot Access MrDoc

Please check in order:

1. Whether the MrDoc service is running normally.
2. Whether the access address and port are correct.
3. Whether the Windows firewall allows access to that port.
4. If accessing from another computer, confirm that the server IP address is correct.
5. Check whether the port is already occupied by another program.

### The Local Machine Can Access It, but Other Computers Cannot

If the local machine can access it through:

```text
http://127.0.0.1:port/
```

but other computers cannot access it, you usually need to check:

* Whether MrDoc is listening on the correct network address;
* Whether the Windows firewall allows the corresponding port;
* Whether the client and server are on a network where they can access each other.

### Configuration Changes Do Not Take Effect

After modifying the MrDoc configuration, you usually need to restart the MrDoc service for the configuration to take effect.

If you deployed with the panel, restart the corresponding service through the panel; if you use Waitress, restart the process or service running MrDoc.

## Further Reading

* [Waitress Deployment](/d/waitress-deploy/)
* [Windows Deployment Panel](/d/windows-deploy-panel/)
* [MrDoc Configuration Instructions](/d/configuration/)
* [MrDoc Upgrade Guide](/d/opensource-upgrade-guide/)
* [Data Backup and Recovery](/d/data-security/)