Deploying on Zspace NAS

# Deployment on ZSpace NAS

MrDoc provides Docker images for the `amd64` and `arm64` architectures. If your ZSpace device supports Docker, you can deploy MrDoc on ZSpace via Docker.

## 1. Obtain the Docker Image

You can obtain the image in either of the following two ways.

### 1.1 Download the Image from the Registry

In the "Docker" component of ZSpace, switch to the "Images" tab, select Registry, enter "mrdoc" in the input box and click the search icon. In the search results, select the "zmister/mrdoc" image.

![](/media/202508/14003d07bc2c45c2a38663007d03d6338570.png)

Then select the latest version:

![](/media/202508/601f3cebdce74cf9b75893d4c9cf47455488.png)

Wait for the download to complete.

![](/media/202508/c3d210f909394bd18ddbadba5981bbeb1703.png)

Once the download is complete, it will appear in the Local tab of Docker images.

![](/media/202508/a434195bd0094019840e1cf046ed70d75602.png)

### 1.2 Import an Offline Image

If your network environment cannot connect to the Docker image registry, you can also download the offline image and import it into ZSpace's Docker images.

Baidu Netdisk: https://pan.baidu.com/s/1OExl7iEz62YSF4u6aQ0UGA?pwd=fr87

![](/media/202508/c734718fe67443f8a18f76d5a3b24cf98076.png)

## 2. Obtain the Code

Go to the MrDoc repository and use Git or download the "zip" archive to your local machine:

![](/media/202508/d89e983ee866453a9aa1d52aa92d63621471.png)

After downloading the zip archive, extract it locally.

Then upload the MrDoc code directory to ZSpace:

![](/media/202508/df3d1d85772a4985b49d8b0f98e2d2d97206.png)

![](/media/202508/85394857786f428c9b625b3f6e2ac8d23216.png)

Upload complete:

![](/media/202508/fedf1f8444ab4c37b76f4d1157d9e6936721.png)

## 3. Create the Container

In the Images window of the ZSpace Docker component, select the "zmister/mrdoc:v9.3" image you just downloaded or imported, and click the "Add" button:

![](/media/202508/eacd4bc874c847d8b9407b1c221481505637.png)

In the container creation window that pops up, switch to "Folder Path" and click the "Add" button:

![](/media/202508/82b91e57fe674145b2cbf6ffcc2fca2c6582.png)

Select the MrDoc code directory you just uploaded to ZSpace:

![](/media/202508/1264d71768e44e029bac1017675cdfe91043.png)

Enter `/app/MrDoc` as the mount path:

![](/media/202508/2a81ac58d08f4052bd78d0466f7376e07810.png)

Then switch to "Port" and enter the "Local Port" according to your needs. Using port `10086` is recommended here:

![](/media/202508/bcae238b05244dddaa9e5ec3163f67445949.png)

Finally, click "Apply" and the MrDoc container is created. Under the "Containers" tab, you can see the running status of the MrDoc container:

![](/media/202508/a2272828bec9413c80c598b8047d11572047.png)

Now visit `ZSpace IP address:10086` in your browser, and you will see the MrDoc interface:

![](/media/202508/b0c26a7bd1b4483fa6061b440e95560e3622.png)

This indicates that the deployment was successful.

## 4. Create an Administrator

Under the Docker "Containers" tab, click "SSH" for the MrDoc container:

![](/media/202508/575ff8d639fa42c9919cc7e1063b662f8774.png)

Select "/bin/sh" in the command bar and click Connect:

![](/media/202508/7b4125523f5c47728500fb01f92fac917558.png)

Enter the container's terminal command line interface and input the command:
```
python manage.py createsuperuser
```
Then follow the prompts to enter the username, email, and password in sequence:

![](/media/202508/fd8d0a11960b4571a843fac97c0e30207399.png)

## 5. Data Backup

MrDoc uses the file-based database `SQLite` by default. You only need to back up the `config` directory and the `media` directory in the MrDoc code directory on ZSpace to achieve data backup.

![](/media/202508/af688ae22bf34a4b960028d0703b0d711404.png)

## 6. Update

If MrDoc releases a new version, you need to first back up your data, then obtain the latest code to overwrite, and finally overwrite the backed-up `config` directory and `media` directory into the code directory.

@[frag](id=7 title=Pro edition guide - demo type)