企业级在线办公套件——OnlyOffice Workspace 部署使用

2023/10/18 OnlyOffice

本文主要介绍使用 Docker 部署 OnlyOffice Workspace(包括 Community Server、Control Panel、Document Server) 的详细步骤。

OnlyOffice 版本:7.4.1(目前最新版本为 7.5,10 月 18 日发布)

官网地址 (opens new window)GitHub 仓库地址 (opens new window)

# 前言

Onlyoffice 是一款功能丰富的在线 Office 工具,类似 WPS 和 微软的 Office 套件。OnlyOffice Workspace 是由 OnlyOffice 推出的基于云计算的企业级在线协作办公平台,由文档服务(Document Server)、控制面板(Control Panel)、社区服务(Community Server)和邮件服务(Mail Server)四个组件构成,提供了文档、项目、成员、邮件等功能模块,支持文档多人协作、历史版本控制等功能,旨在帮助用户提高工作效率和工作质量。

OnlyOffice Workspace 有三个使用版本,分别为社区版(开源免费,但有使用限制)、企业版(收费)和开发版(收费)。本文主要介绍社区版 OnlyOffice Workspace 的部署和使用。

相比市面上的在线文档突出的特点(或者说使用价值):

  • 界面简洁,易操作,无广告。
  • 代码开源,支持私有化部署,数据安全。
  • 文档统一管理,功能丰富,支持文档实时协作,文档权限细粒度控制。
  • 适合企业内网使用。

# 部署

本文不涉及邮件服务(Mail Server)的部署,如有需要,请参考官方部署文档 (opens new window)

# 服务器要求

服务器空闲内存至少要 8GB,Community Server 服务依赖 Elasticsearch,内存不足会导致 Elasticsearch 服务启动失败。本人实际搭建 OnlyOffice Workspace,内存总共消耗 12GB 左右。

配置
CPU 最低 4 核,推荐 6 核
内存 最低 8GB,推荐 12GB
磁盘 40 GB
操作系统 Linux amd64 架构,内核 3.10 版本及之后版本

# 创建网络

docker network create --driver bridge onlyoffice
1

# MySQL

  1. 创建挂载目录。
sudo mkdir -p "/app/onlyoffice/mysql/conf.d";
sudo mkdir -p "/app/onlyoffice/mysql/data";
sudo mkdir -p "/app/onlyoffice/mysql/initdb";
1
2
3

2. 创建配置文件。

echo "[mysqld]
sql_mode = 'NO_ENGINE_SUBSTITUTION'
max_connections = 1000
max_allowed_packet = 1048576000
group_concat_max_len = 2048" > /app/onlyoffice/mysql/conf.d/onlyoffice.cnf
1
2
3
4
5

3. 创建脚本文件。

echo "ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'my-secret-pw';
CREATE USER IF NOT EXISTS 'onlyoffice_user'@'%' IDENTIFIED WITH mysql_native_password BY 'onlyoffice_pass';
CREATE USER IF NOT EXISTS 'mail_admin'@'%' IDENTIFIED WITH mysql_native_password BY 'Isadmin123';
GRANT ALL PRIVILEGES ON *.* TO 'root'@'%';
GRANT ALL PRIVILEGES ON *.* TO 'onlyoffice_user'@'%';
GRANT ALL PRIVILEGES ON *.* TO 'mail_admin'@'%';
FLUSH PRIVILEGES;" > /app/onlyoffice/mysql/initdb/setup.sql
1
2
3
4
5
6
7

4. 启动容器,映射端口可以根据情况调整。

sudo docker run --net onlyoffice -i -t -d -p 3306:3306 --restart=always --name onlyoffice-mysql-server \
-v /app/onlyoffice/mysql/conf.d:/etc/mysql/conf.d \
-v /app/onlyoffice/mysql/data:/var/lib/mysql \
-v /app/onlyoffice/mysql/initdb:/docker-entrypoint-initdb.d \
-e MYSQL_ROOT_PASSWORD=my-secret-pw \
-e MYSQL_DATABASE=onlyoffice \
mysql:8.0.29
1
2
3
4
5
6
7

# Document Server

Document Server (opens new window) (6.0 版本之后更名为 OnlyOffice Docs)是一个功能强大的在线文档编辑和协作平台,允许用户在 Web 浏览器中操作各种文档。

  • 支持多种文档格式,如 .docx、.xlsx、.pptx 等。
  • 支持文档共享与实时协作,多个用户可以同时编辑文档。
  • 支持私有化部署,集成到已有项目中,进行二次开发。
  • 用户能够完全掌控数据安全,实现自主托管和数据隐私控制。
  1. 创建挂载目录。
sudo mkdir -p "/app/onlyoffice/DocumentServer/data";
sudo mkdir -p "/app/onlyoffice/DocumentServer/logs";
1
2

2. 启动容器。JWT_SECRET用来配置密钥。

sudo docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-document-server  -e JWT_SECRET=my_jwt_secret  \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice  \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data  \
-v /app/onlyoffice/DocumentServer/fonts:/usr/share/fonts/truetype/custom \
-v /app/onlyoffice/DocumentServer/forgotten:/var/lib/onlyoffice/documentserver/App_Data/cache/files/forgotten onlyoffice/documentserver
1
2
3
4
5

# Control Panel

Control Panel (opens new window) 提供了丰富的功能用来快速配置和管理 Workspace,包括 LDAP 和 SSO 配置、HTTPS 配置、查看登陆日志和用户操作日志等功能。

  1. 创建挂载目录
sudo mkdir -p "/app/onlyoffice/ControlPanel/data";
sudo mkdir -p "/app/onlyoffice/ControlPanel/logs";
1
2

2. 启动容器

docker run --net onlyoffice -i -t -d --restart=always --name onlyoffice-control-panel \ 
-v /var/run/docker.sock:/var/run/docker.sock \ 
-v /app/onlyoffice/CommunityServer/data:/app/onlyoffice/CommunityServer/data \ 
-v /app/onlyoffice/ControlPanel/data:/var/www/onlyoffice/Data \ 
-v /app/onlyoffice/ControlPanel/logs:/var/log/onlyoffice onlyoffice/controlpanel
1
2
3
4
5

# Community Server

Community Server (opens new window)是一个开源的协作平台,包括文档管理、项目管理、邮件管理、成员管理等功能。

  1. 创建挂载目录。
sudo mkdir -p "/app/onlyoffice/CommunityServer/data";
sudo mkdir -p "/app/onlyoffice/CommunityServer/logs";
sudo mkdir -p "/app/onlyoffice/CommunityServer/letsencrypt";
1
2
3

2. 启动容器。配置信息可以根据情况调整(映射端口,MySQL 配置信息)

sudo docker run --net onlyoffice -i -t -d --privileged --restart=always --name onlyoffice-community-server -p 9101:80 -p 5222:5222 --cgroupns=host \
-e MYSQL_SERVER_ROOT_PASSWORD=my-secret-pw \
-e MYSQL_SERVER_DB_NAME=onlyoffice \
-e MYSQL_SERVER_HOST=onlyoffice-mysql-server \
-e MYSQL_SERVER_USER=onlyoffice_user \
-e MYSQL_SERVER_PASS=onlyoffice_pass \
-e DOCUMENT_SERVER_PORT_80_TCP_ADDR=onlyoffice-document-server \
-e CONTROL_PANEL_PORT_80_TCP=80 \
-e CONTROL_PANEL_PORT_80_TCP_ADDR=onlyoffice-control-panel \
-v /app/onlyoffice/CommunityServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/CommunityServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/CommunityServer/letsencrypt:/etc/letsencrypt \
-v /sys/fs/cgroup:/sys/fs/cgroup:rw \
onlyoffice/communityserver
1
2
3
4
5
6
7
8
9
10
11
12
13
14

3. 服务正常启动,会自动创建名为 onlyoffice 的数据库并生成所需的表,过程需要耗费一段时间。

image-20231017142926576.png

# 使用

浏览器访问ip:9101,填写用户名、密码和邮箱注册登录。登录成功后首页如下所示。至此 OnlyOffice Workspace 搭建成功。

image-20231017111430208.png

# 邮件添加账户

邮件模块可以集成第三方的邮件服务(QQ 邮箱、163 邮箱等),实现邮件的基本操作(发送、删除等)。

集成过程比较容易,但需要正确填写账户的配置信息,具体配置见下图。红框圈出来的部分替换为邮箱地址(例如 xxx@qq.com);登陆密码替换为邮件服务的授权码,注意不是邮箱的登陆密码,授权码在邮箱设置界面查看(QQ 邮箱——设置——账户)。

image-20231031161451346.png

image-20231031162824988.png

配置好之后,点击保存即可。

# Vue 集成 Document Server

Document Server 提供了大量的 API 用于将文档编辑器集成到用户的项目中,支持二次开发。 官方 API 配置文档 (opens new window)

  1. public/index.html文件中添加如下命令。IP:端口 为 Document Server 服务的地址。
<script type="text/javascript" src="http://IP:端口/web-apps/apps/api/documents/api.js"></script>
1

2. 新增 OnlyOffice 组件。jsonwebtoken依赖安装:npm install --save jsonwebtoken@8.5.1

<template>
  <div>
    <div id='OnlyOffice'></div>
  </div>
</template><script>
import jwt from 'jsonwebtoken'
export default {
  name: 'OnlyOffice',
  props: {
    option: {
      type: Object,
      default: () => {
        return {}
      },
    },
  },
  data() {
    return {
      doctype: '',
      docEditor: null,
    }
  },
  mounted() {
    if (this.option.url) {
      this.setEditor(this.option)
    }
  },
  methods: {
    // 用于初始化编辑器。参数 option,包含编辑器的各种配置选项。
    async setEditor(option) { 
      if (this.docEditor !== null) {
        this.docEditor.destroyEditor();
        this.docEditor = null;
      }
      this.doctype = this.getFileType(option.fileType)
      const document = {
        fileType: option.fileType,      // 文档类型
        key: option.key || '',          // 文档唯一值
        title: option.title,            // 文件名称
        permissions: {                  
          edit: option.isEdit,          // 是否可以编辑
          print: option.isPrint,
          download: option.isDownload,
          fillForms: true,              // 是否可以填写表单
          review: true                  // 跟踪变化
        },
        url: option.url                // 指定需打开加载文档的URL
      }const editorConfig = {
        callbackUrl: option.callbackUrl, // 编辑word后保存时回调的地址,用于后端二次开发
        lang: option.lang,              // 语言设置
        chat: {
          autosave: true,              // 是否自动保存
          chat: false,
          comments: false,
          help: false,
          //是否显示插件
          plugins: false,
        },
        user: {   // 用户信息
          id: option.user.id,
          name: option.user.name
        },
        mode: option.model ? option.model : 'edit',
      }const tokenInfo = {
        'document':document,
        'editorConfig': editorConfig 
      }const config = {
        document: document,
        documentType: this.doctype,
        editorConfig: editorConfig,
        events: {
          onAppReady: this.onAppReady,   // 当应用程序加载到浏览器时调用的函数。
          onDocumentStateChange: this.onDocumentStateChange,        // 文档被修改调用的函数。
        },
        width: '100%',          // 定义浏览器窗口中的档高度(默认为 100%)。
        height: '800px',        // 定义浏览器窗口中的文档宽度(默认为 100%)。
        token: jwt.sign( tokenInfo , "my_jwt_secret", { expiresIn: '3h' })
      }
      this.docEditor = new DocsAPI.DocEditor('OnlyOffice', config)
    },
    // 当文档被修改后调用
    onDocumentStateChange(event) { 
      console.log(event)
    },  
    /* 应用程序加载到浏览器后调用 */
    onAppReady() {
       // 创建connector连接器
      this.connector = this.docEditor.createConnector(); 
    },
    /* getFileType 方法用于根据文件类型(fileType)返回对应的文档类型(docType) */
    getFileType(fileType) {
      let docType = ''
      let fileTypesDoc = [
        'doc', 'docm', 'docx', 'dot', 'dotm', 'dotx', 'epub', 'fodt', 'htm', 'html', 'mht', 'odt', 'ott', 'pdf', 'rtf', 'txt', 'djvu', 'xps', 'word',
      ]
      let fileTypesCsv = [
        'csv', 'fods', 'ods', 'ots', 'xls', 'xlsm', 'xlsx', 'xlt', 'xltm', 'xltx',
      ]
      let fileTypesPPt = [
        'fodp', 'odp', 'otp', 'pot', 'potm', 'potx', 'pps', 'ppsm', 'ppsx', 'ppt', 'pptm', 'pptx',
      ]
      if (fileTypesDoc.includes(fileType)) {
        docType = 'text'
      }
      if (fileTypesCsv.includes(fileType)) {
        docType = 'spreadsheet'
      }
      if (fileTypesPPt.includes(fileType)) {
        docType = 'presentation'
      }
      return docType
    }
  },
  watch: {
    option: {
      handler: function (n) {
        this.setEditor(n)
        this.doctype = this.getFileType(n.fileType)
      },
      deep: true,
    }
  }
}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

3. 使用组件

<template>
  <div>
    <only-office :option="option"></only-office>
  </div>
</template><script>
import OnlyOffice from '@/components/OnlyOffice'
export default {
  data() {
    return {
      option: {
        url: 'http://ip:端口/aa.xlsx',  // 文档访问地址
        callbackUrl:'',     // 关闭文档后会调用callbackurl地址进行文档保存
        fileType: 'xlsx',   // 文件扩展名 
        key: '2222',        // 唯一,非空
        title: 'Vue集成',   // 文档文件名   
        isEdit: true,         // 是否可以编辑
        isDownload:true,      // 是否可以下载 
        lang: 'zh-CN',        // 语言:zh-CN简体中文/en英文           
        isPrint: true,        // 是否可以导出                                                 
        user: {               // 文档作者信息
          id: 666, 
          name: 'Cleaner'
        }
      }                                    
    }
  }
}
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 问题

梳理部署和使用 OnlyOffice Worksapce 过程中出现的问题,希望对大家有所帮助,如果你遇到了其他问题,欢迎留言讨论,建议大家多查看 Github Issues。

# Community Server 启动失败

Community Server 容器内部依赖于许多其他三方服务(如 Nginx、Elasticsearch、MySQL 等)。服务启动失败时,可以通过查看容器日志或者进入容器内部查看依赖服务的状态来定位问题。

  1. 服务器内存不足,Elasticsearch 服务启动失败:扩充服务器内存。
  2. MailAggregator、MailWatchdog 服务启动失败:容器启动命令中 MySQL 的配置信息有误,检查 MySQL 用户名密码等配置信息。

# 文档安全令牌未正确形成

原因:OnlyOffice 从 7.2 版本开始,加入了 JWT 验证。Document Server 和 Community Server 加密和验证时密钥不一致。解决方案有两个:一、更换 OnlyOffice 版本为 7.1,二、在 Community Server 中加入 secret 配置。

  1. 进入 Document Server 容器,查看/etc/onlyoffice/documentserver/local.json文件中 secret 的配置信息。
"secret": {
   "inbox": {
       "string": "my_jwt_secret"
   },
   "outbox": {
       "string": "my_jwt_secret"
   },
   "session": {
       "string": "my_jwt_secret"
   }
}
1
2
3
4
5
6
7
8
9
10
11
  1. 进入 Community Server 容器中,编辑/var/www/onlyoffice/WebStudio/web.appsettings.config配置文件。找到如下配置信息并修改。
<add key="files.docservice.secret" value="my_jwt_secret" />
<add key="files.docservice.secret.header" value="Authorization" />
1
2
  1. 重启 Community Server 容器
docker restart 容器id
1

# Document Server 20 人使用限制

Document Server 社区版本虽然是开源的,但是有 20 人的使用限制,打开文档数量超过 20 个之后,新文档只能以只读的方式打开,对于不超过 20 人的使用团队来说,这个足够了。如果要解除这个限制,提供三种解决思路:

  1. 降低 OnlyOffice 版本到 6.x,6.x 版本可以通过修改容器内部的配置文件,来解除限制,7.x 版本修复了这个问题。(缺点是版本只能停留在 6.x,新版本的功能使用不了)
  2. 代码反编译,修改源码后,重新编译镜像部署。(需要一定的技术能力)
  3. 购买企业版。(开销问题)
更新时间: 2023/12/20 上午2:50:10