【网盘项目日志】20210413：Seafile Office系统调试日志

【网盘项目日志】20210413：Seafile Office系统调试日志

本文是对4月13日完成Office系统配置后的补档文档。

Seafile 社区版在默认状况下，并不能对各类 office 文件进行预览和编辑。不过，Seafile 社区版并没有完全将 Office 相关的扩展砍掉，而是保留了部分相关的接口，并允许服务器管理者通过接入外部 Office 服务（如 OnlyOffice、PostOffice等）的方式，重新让服务器获得对 Office 文档的支持。

在本次项目中，我选择使用 OnlyOffice。

步骤1：部署 OnlyOffice 系统

OnlyOffice 系统提供了基于 Docker 容器的部署方式。

通过以下命令可以实现 OnlyOffice 的部署：

sudo docker run -i -t -d -p 8001:80 --name office onlyoffice/documentserver

通过上述命令，可以部署 image onlyoffice/documentserver，将新建成的容器命名为 office，并将客户机 8001 端口映射到容器 80 端口内。

部署完成后，访问 localhost:8001，看到以下界面，证明部署已经完成：

步骤2：配置 Seahub

由于我是遵照 Manual 将开发运行环境部署在 Docker 中，因此我需要修改位于 /root/dev/conf/seahub_settings.py 中的设置项目，在其中添加以下内容：

# Enable Only Office
ENABLE_ONLYOFFICE = True
VERIFY_ONLYOFFICE_CERTIFICATE = False
ONLYOFFICE_APIJS_URL = 'localhost:8001/web-apps/apps/api/documents/api.js'
ONLYOFFICE_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'odt', 'fodt', 'odp', 'fodp', 'ods', 'fods')
ONLYOFFICE_EDIT_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx')

其中：

• ENABLE_ONLYOFFICE 是对 OnlyOffice 支持的总开关；
• VERIFY_ONLYOFFICE_CERTIFICATE 是 OnlyOffice 服务器是否开启 SSL 认证，这里因为我部署在本地，没有配置证书，所以不启用；
• ONLYOFFICE_APIJS_URL 是 OnlyOffice 提供的 API JS 文件地址；
• ONLYOFFICE_FILE_EXTENSION 和 ONLYOFFICE_EDIT_FILE_EXTENSION 配置在 Seafile 中可以通过 OnlyOffice 预览和编辑的文件后缀。

但是，按照上述方法配置并启动后，虽然点击 docx 文件后可以进入 OnlyOffice 界面，但是无法看到文件内容。

寻找无法看到文件内容问题的原因

经过简单研究发现：Seafile 引入了 api.js，是为了让其把 OnlyOffice 的页面以 iFrame 的形式嵌入 Seafile 页面，其步骤大概是：

1. 用户访问 Seafile 的文件预览界面；
2. Seafile 文件预览界面运行 api.js，向 OnlyOffice 服务器发送 iFrame 页面请求，并告知文件服务地址；
3. OnlyOffice 服务器按照文件服务地址下载文件；
4. OnlyOffice 服务器将下载到的文件内容显示在 iFrame 中。

在这种情况下，OnlyOffice 相当于一个独立应用，也需要能够访问到 Seafile 的服务，才能正常显示文件的内容。这在所有服务都是直接部署于客户机的情况下没问题，但是由于本例中是 Docker 部署，结构如图所示：

可以看到，在上述步骤的第 3 步中，OnlyOffice 服务器需要使用 FILE_SERVER_ROOT 信息来下载文件内容，但是由于 OnlyOffice 服务被部署在了一个隔离的容器内，因此当其访问 localhost:8082 时，它访问的是容器内的地址，而不是客户机的地址，也就是它无法访问到外部的服务器。

这种情况下，有两种解决方式，一种是把 Seahub 中 FILE_SERVER_ROOT 更改为客户机的内网 ip 地址，另一种就是将容器服务全部部署到公网，并把 FILE_SERVER_ROOT 修改为公网地址。

两种方式都有一定的局限性，方法一在内网 ip 和网络环境频繁变化的情况下，需要对配置文件频繁进行修改。而方法二则需要把资源部署到外网服务器，这样也不方面本地的编码和调试。

有没有一种办法可以让环境在本地，同时公网还能访问到呢？已知目前校园网的环境下，不可能得到公网 ip，那么我们可以考虑使用 ssh 的反向代理功能，建立跳板，并搞个端口映射。

利用学生云服务器建立反向代理

ssh 老厉害了，居然还可以建立反向代理通道。啥叫反向代理通道？就是把一个服务器的端口映射到另一个服务器，这样原本没有公网 ip 的服务器也可以被公网访问到。

比如说，有服务器 A、B，其中：

• A 是公网可以访问到的服务器；
• B 是运行服务的机器，能访问到因特网，但无法被公网访问到。

那么，在服务器 B 上使用如下命令，向 A 建立 ssh 连接，并建立反向代理通道：

ssh <user>@<ip of A> -R 0.0.0.0:<port on A>:localhost:<service port on B>

如：A 的服务器地址是 123.456.789.123，用户名 root，B 上服务的端口为 8001，将 A 上的 8001 映射到 B 上的 8001 端口，就可以使用以下命令：

ssh root@123.456.789.123 -R 0.0.0.0:8001:localhost:8001

用多组 -R flags，可以指定多组反向代理端口。在这里，我们需要把 Seahub、Seafile-Server、OnlyOffice 的端口全部进行反向代理：

ssh root@123.456.789.123 -R 0.0.0.0:8000:localhost:8000 -R 0.0.0.0:8001:localhost:8001 -R 0.0.0.0:8082:localhost:8082

然后对应将 FILE_SERVER_ROOT、ONLYOFFICE_APIJS_URL、 中的 SERVICE_URL 的 URL 中 localhost 都改成 123.456.789.123。

这里注意，有几个安全性相关的地方需要修改：

• 云服务器平台的安全组策略，要允许这三个端口的入站流量；
• 服务器系统防火墙的安全策略，要允许这三个端口的入站流量（在 Ubuntu 上用 ufw allow <port>）；
• 默认状态下 SSH 不允许在连接过程中自定义服务端开放的端口号。必须在 /etc/ssh/sshd_config 文件中添加以下语句：GatewayPorts clientspecified。

完成后，再次访问 Seafile，并点击预览 docx 文件，发现预览功能已经可以使用了。

当时出的其他问题

第一个问题，不管是什么文件，在打开的时候都会提示无法保存文件，但是使用保存按钮，实际上是可以保存的，这样非常影响用户体验。经过检查发现，是 中的 SERVICE_URL 没有修改为公网地址。修改后，问题解决。

第二个问题，浏览器通知栏产生警告，提示文件类型不正确。经检查，发现是 Seahub 中调用 OnlyOffice API 的代码适用的是老版 API，有些参数是老参数。将 Seahub 项目中 seahub/onlyoffice/utils.py 第 55 行到61行：

filetype, fileext = get_file_type_and_ext(file_path)
if fileext in ('xls', 'xlsx', 'ods', 'fods', 'csv'):document_type = 'spreadsheet'
elif fileext in ('pptx', 'ppt', 'odp', 'fodp', 'ppsx', 'pps'):document_type = 'presentation'
else:document_type = 'text'

修改为：

filetype, fileext = get_file_type_and_ext(file_path)
if fileext in ('xls', 'xlsx', 'ods', 'fods', 'csv'):document_type = 'cell'
elif fileext in ('pptx', 'ppt', 'odp', 'fodp', 'ppsx', 'pps'):document_type = 'slide'
else:document_type = 'word'

即可消除警告。