开源文档预览项目 kkFileView (9.9k star) ,快速入门

简介: kkFileView 是一款文件文档在线预览解决方案,采用流行的 Spring Boot 框架构建,易于上手和部署。该项目基本支持主流办公文档的在线预览,包括但不限于 doc、docx、xls、xlsx、ppt、pptx、pdf、txt、zip、rar,以及图片、视频、音频等格式。

kkFileView 是一款文件文档在线预览解决方案,采用流行的 Spring Boot 框架构建,易于上手和部署。

该项目基本支持主流办公文档的在线预览,包括但不限于 doc、docx、xls、xlsx、ppt、pptx、pdf、txt、zip、rar,以及图片、视频、音频等格式。

1 Docker 部署

  • 拉取镜像:
# 网络环境方便访问docker中央仓库
docker pull keking/kkfileview:4.1.0

# 网络环境不方便访问docker中央仓库
wget https://kkview.cn/resource/kkFileView-4.1.0-docker.tar
docker load -i kkFileView-4.1.0-docker.tar
  • 运行容器
docker run -it -p 8012:8012 keking/kkfileview:4.1.0

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

2 项目接入

上传一个文件之后,点击预览,即可查看该文件预览效果。

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

  1. 引入 js 文件
<script type="text/javascript"  src="https://cdn.jsdelivr.net/npm/js-base64@3.6.0/base64.min.js"></script>
  1. Js 代码
window.open('http://127.0.0.1:8012/onlinePreview?url='+ encodeURIComponent( Base64.encode(url) ) );

3 Mac 本地调试 & 打包

本节我们介绍如何使用 Mac 电脑本地调试 ,以及根据配置按照 windows/Linux 打对应的部署包。

从 Github 上下载 kkFileView :

git clone git@github.com:kekingcn/kkFileView.git

kkFileView 强依赖两点:

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

所以 Mac 本地调试需要先安装 LibreOffice ,进入 LibreOffice 首页,下载对应 Mac 版本即可。

当我们通过 IDEA 打开 ,进入 Server 模块,执行 ServerMain 类 :

启动日志如下:

从日志我们看到:kkFileView 会启动两个 LibreOffice 进程,每个进程有独立的端口。

当我们执行 maven 的 package 命令, 根据配置 windows/Linux 打对应的部署包。

4 Linux 环境部署

我们将打包好的 kkFileView Linux 部署包,上传到部署目录,分别执行:

# 解压缩
tar -zxvf kkFileView-4.4.0-SNAPSHOT.tar.gz

# 进入 bin 目录
cd bin

# 启动 
./startup.sh

备注: Linux 环境首次启动会自动安装 LibreOffice 默认安装 7.5 版本。

我们也可以手工安装 LibreOffice。

#将 LibreOffice_7.5.3.2_Linux_x86-64_rpm.tar.gz上传到 home 目录下
cd /home
tar -zxvf LibreOffice_7.5.3.2_Linux_x86-64_rpm.tar.gz
cd LibreOffice_7.5.3.2_Linux_x86-64_rpm/RPMS/
yum -y localinstall *.rpm

手工安装完成后,可以通过如下的命令验证是否正确:

libreoffice7.5 --version

启动 kkFileView 并不意味着配置的结束,因为还需要最后一步:安装字体

1、下载字体

wget http://kkfileview.keking.cn/fonts.zip

2、上传到 /usr/share/fonts , 并解压缩

unzip fonts.zip

3、刷新字体索引

mkfontscale
mkfontdir
fc-cache

5 总结

当我们在本地调试或者 Linux 服务器执行预览效果时,我们发现 PPT 文档文件会转换成图片的格式,比如下图:

kkFileView 本质是将文档文件转换为特定的展示文件,是一个小型的转码系统。而且转码后的文件存储都是单机模式,假如需要分布式部署,可能还是会有性能瓶颈。

最后,kkFileView 相关安装包,也可以关注勇哥的公众号,回复“kk” , 即可获取 。


如果我的文章对你有所帮助,还请帮忙点赞、在看、转发一下,你的支持会激励我输出更高质量的文章,非常感谢!

相关文章
|
3月前
|
Linux Shell Android开发
40K+Star的开源免费美化命令行工具
40K+Star的开源免费美化命令行工具
|
Kubernetes Java 数据库
GitHub置顶神作开源!世界名著《Spring实战(第6版)》全彩文档
今天给大家带来的是:[美] 克雷格·沃斯(Craig Walls) 著,张卫滨,吴国浩 译的 《Spring实战(第6版)》,也是最新的一版,本书是关于Spring核心特性的指南,延续了前几个版本一贯的清晰风格,带领你亲自动手,逐步构建出一个以数据库作为支撑的Web应用。
|
6月前
|
JavaScript 搜索推荐 前端开发
《VitePress 简易速速上手小册》第2章:Markdown 与页面创建(2024 最新版)
《VitePress 简易速速上手小册》第2章:Markdown 与页面创建(2024 最新版)
230 0
|
6月前
|
NoSQL 关系型数据库 MySQL
『GitHub项目圈选03』Star 4.9k! 很全的一款适合开发人员的在线工具集
『GitHub项目圈选03』Star 4.9k! 很全的一款适合开发人员的在线工具集
|
6月前
|
存储 搜索推荐 安全
GitHub教程-自定义个人页制作
GitHub是全球最大的代码托管平台,除了存放代码,它还允许用户个性化定制自己的主页,展示个人特色、技能和项目。本教程旨在向GitHub用户展示如何制作个性化主页,同时,介绍了GitHub Actions的应用,可以自动化更新主页内容。通过本教程,GitHub用户将学会如何打造独具个性的GitHub个人主页,吸引更多关注和合作机会。具体代码请参阅文末。
136 0
|
6月前
|
JavaScript Java 数据安全/隐私保护
我把Github上最牛b的Java教程和实战项目整合成了一个PDF文档
大家都知道 Github 是一个程序员福地,这里有各种厉害的开源框架、软件或者教程。这些东西对于我们学习和进步有着莫大的进步,所以我有了这个将 Github 上非常棒的 Java 开源项目整理下来的想法。觉得不错的话,欢迎小伙伴们去star一波。
优秀开源项目推荐之--文档库bookstack
优秀开源项目推荐之--文档库bookstack
|
存储 移动开发 前端开发
利用gitee搭建pdf在线阅读功能
利用gitee搭建pdf在线阅读功能
利用gitee搭建pdf在线阅读功能
|
机器学习/深度学习 存储 SQL
快速入门DVC(一):简介
简述 DVC的开发者为iterative.ai,成立于2017年。它是一款开源的,针对机器学习项目的版本控制系统,同时也提供企业服务。起初,DVC从数据版本化管理概念切入,之后,提供对机器学习全方位的支持。
|
存储 自然语言处理 前端开发
我用这些开源项目轻松搭建了一个在线文档平台
我用这些开源项目轻松搭建了一个在线文档平台
2230 0
我用这些开源项目轻松搭建了一个在线文档平台