ONLYOFFICE DocumnetServer 安装、配置、参数解析

已于 2024-07-08 17:21:35 修改
阅读量6.7k 收藏 37
点赞数 6
分类专栏： onlyoffice 文章标签： 前端 java 开源 经验分享
于 2023-03-29 16:45:56 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45099813/article/details/129838840
版权

ONLYOFFICE DocumnetServer 安装、配置、参数解析

1、安装准备：

操作系统：window server 2012 R2及以上版本

环境：

安装包：

注意：以上软件尽量安装给定的版本，不然会报很多奇奇怪怪的错误，操作系统尽量使用window server 2012 R2及以上的windows服务器，在win10下安装，可能会出现很多权限问题。其中红色的三个软件安装onlyoffice-documentserver.exe过程中会自动安装的，前提是在能够连接在外网的情况下，windows服务器不能连接外网的情况下，需要提前装好这些软件，cerbot 必须安装win32版本的，在github上1.24以后的版本都是win64的。

2、安装过程

  • Erlang和RabbitMQ安装一直点下一步就行了，默认安装在C盘，可以修改安装路径。

  • PostgreSQL安装的时候会让你设置数据库密码，这个要记住，后面会用到，PostgreSQL数据库的默认端口是5432，如果要修改端口，后续还要修改onlyoffice的配置文件，尽量使用默认端口，数据库默认安装在C盘，如果要修改数据库的安装路径需要提前建好文件夹，且要将当前账户设置为完全控制。

  • PostgreSQL安装完成后需要给onlyoffice设置角色\组和数据库，运行安装目录\pgAdmin 4\bin\pgAdmin4.exe，打开后输入刚开始设置的数据库密码，然后创建组：
    在这里插入图片描述

  • 切换到“Definition”选项卡，并在“密码”字段中输入onlyoffice。

  • 转到“Privileges”选项卡，选中“Can login?”。

  • 在这里插入图片描述

  • 然后单击保存。

  • 然后创建一个onlyoffice数据库，owner选择刚刚创建的onlyoffice，然后保存。在这里插入图片描述

  • 或者你也可以使用命令的方式创建组和数据库。在“PostgreSQL安装目录\bin“下打开命令窗口，分别执行以下命令

  • psql -U postgres -c "CREATE USER onlyoffice WITH PASSWORD 'onlyoffice';"

  • psql -U postgres -c "CREATE DATABASE onlyoffice OWNER onlyoffice;"

  • 在这里插入图片描述

  • onlyoffice-documentserver安装完成后会默认占用80端口，所以需要在安装时指定端口，在安装包路径下打开命令窗口输入：onlyoffice-documentserver.exe /DS_PORT=端口号，安装过程中会提示哪些依赖需要下载，如果已经安装了cerbot，可以去掉cerbot的勾选，没有外网还需要下载其他依赖请自行安装。安装过程如果要修改安装目录，安装完成后也需要将文件夹的权限设置为当前账户完全控制，不然没法修改配置文件。然后之后全部点下一步，就安装完成了。

3、安装完成后的配置

安装完成后访问开始安装时的端口号地址会出现以下页面：
在这里插入图片描述
点击GO TO TEST EXAMPLE，会出现以下页面
在这里插入图片描述
这是因为官方给的示例页面的服务没开启。
我们在服务器上打开任务管理器，在服务中找到下面四个服务
在这里插入图片描述
这些就是onlyoffice相关的四个服务。此时example服务是关闭的。example服务会占用3000端口，开启前请检查3000端口是否被占用。
服务打开后再次访问应该会出现以下界面，你可以在这里使用官方案例创建并编辑文档。
在这里插入图片描述
在服务器的任务管理器的详细信息中会有一个docservice.exe的进程，这个进程会占用8000端口
在这里插入图片描述
这个端口被占用也会导致文档打不开。
onlyoffice安装目录下，可能会修改以下文件夹
在这里插入图片描述

3.1 端口配置

config文件夹下，default.json和local.json是经常用到的配置文件。
在这里插入图片描述

3.1.1 docservice服务配置

修改default.json和local.json中的以下配置

"services": {
    "CoAuthoring": {
        "server": {
            "port": 8000,//默认8000
            ...
        }
            ...
     }
    ...
}

修改完成后，还需要修改http-common.conf
在这里插入图片描述
修改以下配置

## docservice的端口
upstream docservice {  
  server localhost:8000 max_fails=0 fail_timeout=0s;
}
## example服务的端口
upstream example {  
  server localhost:3000;
}

修改完成保存后，在任务管理器中将onlyoffice的四大服务重启。

3.1.2 文档服务器站点端口修改

还是nginx文件夹
在这里插入图片描述

include includes/http-common.conf;
## 默认占用80端口
server {
  listen 0.0.0.0:80;
  listen [::]:80 default_server;
  server_tokens off;
  
  set $secure_link_secret OphIwQpJulSumDiLVL4l;
  include includes/ds-*.conf;
}

修改完成保存后，在任务管理器中将onlyoffice的四大服务重启。

3.2 安装字体

onlyoffice安装时默认会读取服务器的字体文件，如果需要新增字体，请现在服务器上安装好需要的字体，然后到bin目录下运行documentserver-generate-allfonts.bat
在这里插入图片描述
执行完这个批处理文件，会自动重启相关服务，然后手动清除客户端浏览器缓存。

3.3 修改字号

注：在8.0.1版本中已经支持中文字号无需自己添加

在Microsoft Office word或者WPS文字中我们可以看见字号都有初号，一号，二号什么的字号，onlyoffice中是没有的，找到如图所示路径下的app.js ![在这里插入图片描述](https://img-blog.csdnimg.cn/a2c99ffa743f468fb086ab7b49606eed.png#pic_center) 找到{value:8,displayValue:"8"}，应该会有三处位置，然后将以下内容粘贴到这几个位置的前面。 
{value:42,displayValue:"初号"},{value:36,displayValue:"小初"},{value:26,displayValue:"一号"},{value:24,displayValue:"小一"},{value:22,displayValue:"二号"},{value:18,displayValue:"小二"},{value:16,displayValue:"三号"},{value:15,displayValue:"小三"},{value:14,displayValue:"四号"},{value:12,displayValue:"小四"},{value:10.5,displayValue:"五号"},{value:9,displayValue:"小五"},{value:7.5,displayValue:"六号"},{value:6.5,displayValue:"小六"},{value:5.5,displayValue:"七号"},{value:5,displayValue:"八号"},

修改完成保存后，重启服务，然后手动清除客户端浏览器缓存。

3.4 其他配置

如果想修改编辑器中的其他内容，请自行研究web-apps中的源码，比如修改css样式什么的

4、接口调用注意事项

4.1 引入

如果想在项目中使用文档服务器，可以参考官方的接入文档，有前端三大框架的接入方式，Angular、React、Vue

也可以直接使用script引入，其中documentserver是文档服务器的地址

<script src="http://documentserver/web-apps/apps/api/documents/api.js"></script>

注意：官方给的Angular接入方式，必须要至少Angular 14.2版本 ，过低的版本不行

我这里的angular项目是直接在index.html中使用script引入的

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>onlyoffice</title>
  <base href="/" id="BasePath">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="icon" type="image/x-icon" href="favicon.ico">
  <script src="http://documentserver/web-apps/apps/api/documents/api.js"></script>
</head>
<body>
  <app-root></app-root>
</body>
</html>

4.2 调用

在调用接口的时候请参考官方文档，我这里只说明需要注意的几点：

关于key

文档中的key是指，你当前打开的文档的唯一标识，也是实现多人协作的关键

关于协同编辑模式

要实现两个或两个以上用户共同编辑一份文件，这个文件的*document.key*值必须相同，通常情况下可以使用文件的md5值作为唯一的key。例如当一个用户打开key值为1111的文档后，文档服务器会将该文档存入缓存中，后续其他用户打开key值为1111的文件则会从缓存中获取该文档。当用户A更改文档后，文档服务器会将更改的内容发送到用户B客户端。

文档更改的内容推送有两种模式，可以根据*coEditing*参数配置，*coEditing*有两个属性，*mode*和*change*。

*mode*有两个值*fast* 或 *strict*。为*fast*时文档服务器会实时将用户的更改内容发送给其他用户，且在*view*模式下，也能实时接收到更改。为*strict*时文档服务器只会在用户按下保存按钮或者*ctrl+s*后才会将更改发送给其他用户，发送给其他用户后文档服务器会提示其他用户保存或者*ctrl+s*后才能接收到其他用户的更改，在*view*模式下将不会更新其他用户的更改内容。

*change*为true时，编辑器中会出现如下所示按钮，用户可以在编辑器中随意更改共同编辑模式，且状态存储在本地存储中，不会被代码中的配置项控制。

关于token

文档中的token，是指jwt加密字符串，需要在调用后端接口生成，其中payloadClaims是生成文档编辑器的前端配置对象，如下所示：

{
    "document": {
        "key": "Khirz6zTPdfd7",
        "permissions": {
            "comment": true,
            "commentGroups": {
                "edit": ["Group2", ""],
                "remove": [""],
                "view": ""
            },
            "copy": true,
            "deleteCommentAuthorOnly": false,
            "download": true,
            "edit": true,
            "editCommentAuthorOnly": false,
            "fillForms": true,
            "modifyContentControl": true,
            "modifyFilter": true,
            "print": true,
            "review": true,
            "reviewGroups": ["Group1", "Group2", ""]
        },
        "url": "https://example.com/url-to-example-document.docx"
    },
    "editorConfig": {
        "callbackUrl": "https://example.com/url-to-callback.ashx",
        "mode": "edit",
        "user": {
            "group": "Group1",
            "id": "78e1e841",
            "name": "Smith"
        }
    }
}

java接口示例：tokenSecret 是local.json文件中的secret

public String createToken(final Map<String, Object> payloadClaims) {
        try {
            // build a HMAC signer using a SHA-256 hash
            Signer signer = HMACSigner.newSHA256Signer(tokenSecret);
            JWT jwt = new JWT();
            for (String key : payloadClaims.keySet()) {  // run through all the keys from the payload
                jwt.addClaim(key, payloadClaims.get(key));  // and write each claim to the jwt
            }
            return JWT.getEncoder().encode(jwt, signer);  // sign and encode the JWT to a JSON string representation
        } catch (Exception e) {
            return "";
        }
    }

如果不要使用jwt令牌，可以在local.json中的browser改为false

"token": {
        "enable": {
          "request": {
            "inbox": true,
            "outbox": true
          },
          "browser": true //将这个设置为false,就不会检查token了
        },
        "inbox": {
          "header": "Authorization"
        },
        "outbox": {
          "header": "Authorization"
        }
      },

修改完记得重启服务

关于callbackUrl

这是文件保存修改的关键参数，而且这个url必须是IPv4地址当文档打开，强制保存，关闭时都会调用这个回调URL，需要和你的后端对接。
在config文件夹下的default.json文件中有一个savetimeoutdelay参数，默认是5000，也就是5秒，指的是文档发生了更改且关闭5秒后调用callbackUrl，如果是其他状态会立即调用。可以把这个设置为0，文档发生更改且关闭后马上调用回调地址。具体对接方法请参考官方文档。
如果出现文件无法保存，请联系管理员等字样的提示，大部分原因是因为callbackUrl出现问题，检查这个地址是否能进入后端程序，检查防火墙端口是否打开，进不去说明地址出现错误或者后端代码写法不对，这个回调地址必须返回一个"{\"error\":0}"

关于url

这是文档服务器访问你业务服务器中的文件的地址，且也必须时IPv4地址，这个地址访问后必须是产生一个文件，文件的类型参考官方文档。

东方_初白
关注
  • 6
    点赞
  • 踩
  • 37
    收藏
    觉得还不错? 一键收藏
  • 9
    评论
专栏目录
onlyoffice-documentserver.exe
04-05
ONLYOFFICE是一个在线办公套件,是集合管理文档、项目、团队和客户关系等多种功能为一体的协作平台。 DocumentServer是文件在线办公套件的核心部件
ONLYOFFICE Document Server API
11-05
ONLYOFFICE Document Server API,ONLYOFFICE Document Server API使用帮助
Onlyoffice本地部署超详细教程（附协作空间2.0新资讯）
热门推荐
陈老老老板的博客
12-12 4万+
相信大家已经有所了解ONLYOFFICE这个神中神办公软件真正的办公神器-ONLYOFFICE你了解多少？，最近公司产品突然提出一个需求要实现文档实时在线浏览编辑等一系列功能，需求评审我直接举手，这个活我来！之前对ONLYOFFICE有一定的了解，但是对于二次开发与整合方面一直没深入探索，正好借着本次机会，上班学习走起！本篇给大家讲一下ONLYOFFICE本地部署的相关步骤与注意事项。
使用Docker部署ONLYOFFICE Document Server
最新发布
更多内容查看博客描述。
05-24 1111
80端口上往往会运行像Apache、Nginx之类的HTTP服务，为了避免端口冲突，我们可以将Document Server映射至其它端口。在浏览器里访问https://服务器地址/。刚开始看到的可能是是502 Bad Gateway，稍等一会，刷新浏览器页面即可。HTTPS需要使用SSL证书，可以自己签发也可以用ca机构签发的，加密效果相同。但是仍然是要用HTTPS协议访问，比如：https://服务器地址:9000/登入容器，也可以将以上两个目录映射到本地，这样更方便。这是由于SELinux的阻止。
Office在线协作（一）- 在本地服务器上安装ONLYOFFICE Docs Community Edition For Windows Server - 超详细安装教程
liyi_hz2008的博客
11-07 1万+
企业版允许您在本地服务器上安装ONLYOFFICE文档，并将在线编辑器与ONLYOFFICE协作平台或其他流行系统集成。本文将详细介绍在Windows服务器上安装OnlyOffice社区版的过程，希望对大家有帮助。
onlyoffice的介绍搭建、集成过程。Windows、Linux
世上哪有什么岁月静好,不过是有人替你负重前行
10-16 3278
在本地服务器上安装ONLYOFFICE Docs Community EditionCommunity Edition允许您在本地服务器上安装ONLYOFFICE文档，并将在线编辑器与ONLYOFFICE协作平台或其他流行系统集成。ONLYOFFICE Docs是一个在线办公套件，包括文本、电子表格和演示文稿的查看器和编辑器，完全兼容office Open XML格式：.docx、.xlsx、.pptx，并支持实时协作编辑。
树莓派搭建onlyoffice-documentserver并使其可用
cpfwmsx的专栏
04-28 2606
在x86服务器上使用onlyoffice-documentserver非常简单，使用docker命令一键启动即可。然而在树莓派上却有点棘手，毕竟官方提供的镜像都是基于x86的，在hub.docker.com找了一圈发现了一个可用的arm镜像，适用于arm核心的树莓派，理论上m1芯片的电脑，如MAC机器也是可以用的
onlyoffice 安装、测试、打包、部署
txyllyyj的博客
10-18 2万+
onlyoffice 安装、添加字体、测试、打包、部署
docker上部署onlyoffice新版的jwt和token问题
m0_50919638的博客
03-08 748
onlyoffice
使用docker部署onlyoffice插件步骤及踩坑问题（win10/linux）
车马去闲闲——落日满秋山
10-11 1万+
最近公司系统插件从金格换成了OnlyOffice，需要重新安装部署，做个记录。安装onlyoffice有两种方式，第一种是独立安装nginx、epel、PostgreSQL、RabbitMQ等依赖项，再安装OnlyOffice文档插件。此种方式较为繁琐，暂不赘述，附同事分享的文档在资源内。第二种为docker安装部署，省心方便，操作快捷。这里对第二种方式进行介绍。
Java HmacSHA256 签名及验签
Glen_guilin的专栏
08-19 5318
Java HmacSHA256 签名及验签HmacSHA256 签名及验签验签参数工具代码 HmacSHA256 签名及验签 一个项目需要用到HmacSHA256 对数据进行签名 于是写了个工具类方便以后及大家直接引用。 验签参数 // 遍历排序后的字典，将所有参数按"keyvalue"格式拼接在一起 StringBuilder basestring = new StringBuilder(); for (Map.Entry<String, String> param :
在国产麒麟操作系统上如何安装ONLYOFFICE Docs 7.3
VincentYoung的专栏
02-17 1193
至于Linux操作系统如何安装部署，选择真实物理计算机还是在虚拟机软件里面安装，安装桌面环境还是不安装桌面环境仅仅安装为服务器模式，Linux安装好后一般都要先安装那些必要的软件源，等等Linux的基础问题，我都写在另外一篇攻略图文里面了。终于把麒麟操作系统的软件源配置好了，至于什么是阿里源、大清源，在国内安装Linux后必备的这些操作，比如换国内软件源来加速、装配中文输入法、安装私人飞机配置多航线标签交换BBR协议之类的，这一系列的国内特有的装机必备基础操作，在我另外一片图文中介绍。
使用Docker部署ONLYOFFICE Document Server,打开中文乱码的原因与设置默认字体为中文的解决方法
01-27
使用Docker部署ONLYOFFICE Document Server,打开文档，显示中文乱码的原因与设置默认字体为中文的解决方法。关于中文乱码问题，归根究底，是Ubuntu系统字体显示不像Windows一样中英双显
DocumentServer.zip
04-05
document server 是onlyoffice的核心，提供了office文件的在线预览、编辑、转换等功能，是唯一一家值得推荐的office在线编辑软件
OnlyOffice单独安装说明
10-11
在非 Docker 环境下，要在 CentOS 及其衍生产品上安装 ONLYOFFICE Docs 社区版，你需要遵循以下步骤： 1. **系统要求**： - CPU：双核 2 GHz 或更高 - 内存：2 GB 或更多 - 硬盘：至少 40 GB 可用空间 - 交换...
Onlyoffice安装教程.pdf
03-01
Onlyoffice安装教程
onlyOffice的https配置
01-28
onlyOffice的https配置
OnlyOffice DocumentServer安装说明
11-25
windows server 2019下安装OnlyOffice DocumentServer的方法，亲测成功
windows下安装onlyoffice document server文档服务器软件包
11-25
包括Node版本6.11.3，postgresql-11.10-1，Erlang19.1，rabbitmq-server-3.5.4，Redis-x64-3.2.100，onlyoffice-documentserver，最后来一个安装文档，包你安装成功
onlyoffice文件服务器,onlyoffice踩坑记录
05-31
好的，关于onlyoffice文件服务器和踩坑记录，我可以提供一些相关的信息和经验。 Onlyoffice文件服务器是一款开源的文件管理系统，它提供了文档协作、在线编辑和共享等功能。以下是一些可能会遇到的问题以及解决方法： 1. 部署时出现错误：如果您在部署Onlyoffice文件服务器时遇到了错误，可以尝试检查您的环境和依赖项是否正确安装，并且是否具有足够的权限。 2. 内存不足：Onlyoffice文件服务器需要一定的内存资源才能正常运行。如果您的服务器内存不足，可能会出现性能问题，甚至无法启动Onlyoffice文件服务器。您可以尝试增加内存，或者考虑使用其他更适合您的文件管理系统。 3. 兼容性问题：Onlyoffice文件服务器与某些浏览器或操作系统可能存在兼容性问题。如果您遇到了这些问题，可以尝试更新您的浏览器或操作系统，并检查是否有任何更新或修复程序可用。 4. 安全性问题：Onlyoffice文件服务器需要保护用户数据的安全性。您应该采取必要的安全措施，例如使用SSL证书、设置访问控制和加密等。 总之，Onlyoffice文件服务器是一款功能强大的文件管理系统，但在部署和使用过程中可能会遇到一些问题。如果您遇到了任何问题，建议您查阅官方文档或者寻求专业技术支持。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 9
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值