文章目录

  • 一、概述
  • 1、官方文档
  • 2、使用
  • 二、部署服务
  • 1、传统部署方式
  • （1）环境要求
  • （2）生成部署包
  • 2、docker部署方式
  • 三、踩坑
  • 1、预览并发问题&预览首次打开慢
  • 2、字体问题乱码
  • 3、水印问题
  • 4、使用nginx代理
  • 5、docker部署指定配置


一、概述

1、官方文档

gitee源码：https://gitee.com/kekingcn/file-online-preview#5-pdf%E6%96%87%E6%A1%A3%E9%A2%84%E8%A7%88 官方文档：https://kkview.cn/zh-cn/index.html

2、使用

当您的项目内需要预览文件时，只需要调用浏览器打开本项目的预览接口，并传入须要预览文件的url，示例如下：

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

var url = 'http://127.0.0.1:8080/file/test.txt'; //要预览文件的访问地址
window.open('http://127.0.0.1:8012/onlinePreview?url='+encodeURIComponent(Base64.encode(url)));

二、部署服务

1、传统部署方式

（1）环境要求

Java: 1.8+
LibreOffice或OpenOffice(Windows下已内置，CentOS或Ubuntu下会自动下载安装，MacOS下需要自行安装)

（2）生成部署包

可以从官网下，但是需要加入知识星球（付费）。

也可以下载源码自己进行构建：

文档在线预览：keking/kkFileView踩坑记_服务器


文档在线预览：keking/kkFileView踩坑记_nginx_02


解压kkFileView-x.x.x文件（Windows用.zip包，Linux/MacOS用.tar.gz包）

打开解压后文件夹的bin目录，运行startup脚本（Windows下以管理员身份运行startup.bat，Linux以root用户运行startup.sh）

浏览器访问本机8012端口 http://127.0.0.1:8012 即可看到项目演示用首页

2、docker部署方式

官网说的是直接可以拉取镜像，但是我一直拉不下来，或许需要自己进行构建。

文档在线预览：keking/kkFileView踩坑记_nginx_03


把fonts和Dockerfile都拷贝到docker服务器，然后运行dockerbuild.txt中的命令即可构建基础镜像。

后续打出jar包进行构建即可。

三、踩坑

1、预览并发问题&预览首次打开慢

可使用预览转码队列，将需要预览的文件url放入队列中，提前进行转码，本地访问接口为：http://127.0.0.1:8012/addTask?url=http://xxx/test.txt (url参数为需要需要的文件访问地址，GET请求)

2、字体问题乱码

大部分Linux系统上并没有预装中文字体或字体不全，需要把常用字体拷贝到Linux服务器上，具体操作如下： 下载如下字体包 https://kkview.cn/resource/fonts.zip 文件解压完整拷贝到Linux下的 /usr/share/fonts目录。然后依次执行mkfontscale 、mkfontdir 、fc-cache使字体生效

3、水印问题

在预览url后面加上参数&watermarkTxt即可
例如：

var url = 'http://127.0.0.1:8080/file/test.txt'; //要预览文件的访问地址
window.open('http://127.0.0.1:8012/onlinePreview?url=' + encodeURIComponent(Base64.encode(url)) + '&watermarkTxt=' + encodeURIComponent('动态水印'));

4、使用nginx代理

例如nginx的访问地址为 https://file.keking.cn 想要使用 https://file.keking.cn/preview/来做预览，kkFileView部署在内网192.168.1.233服务器上，需要在nginx中添加反向代理如下：

location /preview {
    proxy_pass http://192.168.1.233:8012/;
}

修改kkFileView的配置文件如下两项

server.servlet.context-path = /preview
base.url = https://file.keking.cn/preview

使用如下地址来访问预览页面

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>

var url = 'https://file.keking.cn/file/test.txt'; //要预览文件的访问地址
window.open('https://file.keking.cn/preview/onlinePreview?url='+encodeURIComponent(Base64.encode(url)));

5、docker部署指定配置

针对docker运行的用户，所有配置项可以使用设置相应的环境变量来配置
环境变量的KEY为配置文件中每个配置项后${}中的KEY
例如，使用docker运行要指定base.url为http://file.keking.cn，docker运行命令如下

docker run -it -d -p 8012:8012 -e KK_BASE_URL="http://file.keking.cn" keking/kkfileview:v2.2.1