OnlyOffice integration

# 📝 OnlyOffice Integration

> d For Docker deployment, the image needs to be upgraded to the official Docker image version v6 or above. For other deployment methods, handle system dependencies on your own.

MrDoc Pro edition supports uploading local Office files as documents for browsing. If you need to edit these Office documents online or create and edit Office documents directly within MrDoc, you need to deploy and integrate the OnlyOffice service.

## 1. Deploy OnlyOffice

> i This section references the OnlyOffice deployment documentation.
>
> You can deploy OnlyOffice according to the official [deployment guide](https://api.onlyoffice.com/zh/editors/getdocs). We recommend using the official [Docker image](https://github.com/ONLYOFFICE/Docker-DocumentServer) provided by OnlyOffice for deployment.

### Deploy OnlyOffice with Docker

> i Official OnlyOffice Docker image documentation: https://hub.docker.com/r/onlyoffice/documentserver

```shell
docker run -d --restart=always --name oo \
-p 8123:80 \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/DocumentServer/lib:/var/lib/onlyoffice \
-v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql \
onlyoffice/documentserver:latest
```

The above command will run an OnlyOffice container named `oo` on port `8123`, and mount OnlyOffice data in the `/app/onlyoffice/DocumentServer/` directory.

### View JWT Token

Enter the following command in the terminal to get the default JWT token value of OnlyOffice. Copy it for configuration use.
```
docker exec oo /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'
```

### Additional Configuration: Reverse Proxy - WebSocket Support

If you use Nginx or other tools such as BT Panel Nginx to reverse proxy the deployed OnlyOffice, you need to add additional Nginx configuration to support WebSocket:
```
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
```

Taking BT Panel as an example, you can add the following configuration in the reverse proxy:

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/08/15/2023-08-15_183621_8759720.0426048922232104.png)

### Additional Configuration: Reverse Proxy - HTTPS Additional Configuration

If the OnlyOffice you deployed uses HTTPS, you also need to add the following configuration:
```
proxy_set_header X-Forwarded-Proto https;
```
Image omitted, refer to the BT Panel settings above.

## 2. Configure MrDoc

After the OnlyOffice service is deployed, you need to fill in the OnlyOffice-related configuration information in MrDoc. Once the configuration is complete, you can directly use OnlyOffice-based Office documents in MrDoc.

Go to the "Admin" -- "Site Settings" page, select "Project, Document, Material Settings", fill in the OnlyOffice service address and [JWT token](#h3-view-jwt-token) under "OnlyOffice Configuration", and finally enable the OnlyOffice feature switch and save the configuration.

> d Please note that the OnlyOffice service address URL must end with a slash `/`, for example: `https://onlyoffice.mrdoc.pro/`.

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/08/09/2023-08-09_210339_7052330.6912929240951615.png)

### 2.1 HTTPS Additional Configuration

If your MrDoc uses HTTPS, be sure to add the following configuration to MrDoc's Nginx reverse proxy configuration:

```
proxy_set_header X-Forwarded-Proto $scheme;
```

Otherwise, an error message like "==This file cannot be saved. Please check the connection settings or contact the administrator...==" may appear.

## 3. Usage

When the OnlyOffice feature switch is enabled, a "OnlyOffice" option will appear in the new menu bar at the top of the homepage, project, and document pages. Click it to enter the OnlyOffice document creation page.

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/08/09/2023-08-09_210740_2176380.9085379089580656.png)

Here, you can directly choose to create Word, Excel, PPT, form files, etc., or upload an Office file from local:

![](http://file.mrdoc.pro/mrdoc-oss/img/2023/08/09/2023-08-09_210843_0630720.04988627209768215.png)

After selection, the OnlyOffice editing interface will be rendered. After editing is complete, follow the normal document publishing process.

![](http://file.mrdoc.pro/mrdoc-oss/img/2025/01/03/8271beb2d80f438cb9457b205a9b96cd4850.png)

## 4. Other Issues

1. When the time of the MrDoc server and the OnlyOffice server are inconsistent, a prompt may pop up: "This document cannot be saved. Please check the connection settings or contact your administrator. When you click the 'OK' button, the system will prompt you to download the document."

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