Docker-kkFileView(文件在线预览)

[kkFileView](https://kkview.cn/zh-cn/index.html) 为文件文档在线预览解决方案，该项目使用流行的spring boot搭建，易上手和部署，基本支持主流办公文档的在线预览，如doc,docx,xls,xlsx,ppt,pptx,pdf,txt,zip,rar,图片,视频,音频等等

文档在线预览项目解决方案，使用流行的 Spring Boot 框架构建，便于设置和部署。这个多功能的开源项目为广泛的文档格式提供基本支持，包括：
- doc支持, docx, xls, xlsx, xlsm, ppt, pptx, csv, tsv, , dotm, xlt, xltm, dot, xlam,等Office 文档dotx。xla,
- 支持国内WPS Office文档，如wps，，，，，。dpsetett wpt
- odt支持、ods、ots、odp、otp、six、ott、fodt等OpenOffice、LibreOffice 办公文档fods。
- 支持 Visio 流程图文件，例如vsd, vsdx.
- 支持 Windows 系统镜像文件，如wmf, emf.
- 支持 .photoshop 等软件模型文件psd。
- pdf支持、ofd和 等文档格式rtf。
- 支持软件模型文件，如xmind.
- 支持bpmn工作流文件。
- 支持eml邮件文件
- 支持epub书籍文档
- 支持 3D 模型文件，如, obj, 3ds, stl, ply, gltf, glb, off, 3dm, fbx, dae, wrl, 3mf, ifc, brep, ,等。stepigesfcstdbim
- 支持 CAD 模型文件，例如dwg, dxf.
- txt支持, xml(rendering), md(rendering), java, php, py, js,css等所有纯文本文件。
- zip支持, rar, jar, tar, gzip,7z等压缩包
- jpg支持, jpeg, png, gif, bmp, ico, jfif,webp等图片预览（翻转、缩放、镜像）。
- tif支持、 等图像信息模型文件tiff。
- 支持图像格式文件，例如tga.
- 支持矢量图像格式文件，例如svg.
- avi支持, mov, wmv, mkv, 3gp, 等多种音视频格式文件rm。

相关链接：
---
官网：https://kkview.cn/zh-cn/index.html
演示地址：https://file.kkview.cn/
GitHub：https://github.com/kekingcn/kkFileView
Gitee：https://gitee.com/kekingcn/file-online-preview
Docker：https://registry.hub.docker.com/r/keking/kkfileview
Docker核心：https://registry.hub.docker.com/r/keking/kkfileview-jdk

## 自建 docker
不使用官方 [Docker](https://registry.hub.docker.com/r/keking/kkfileview) 镜像，官方的不知为啥没有 3D模型显示，自行编译一个使用
需要 ≥java8，maven
```bash
git clone https://gitee.com/kekingcn/file-online-preview.git		# 拉取最新
cd file-online-preview		# 进入项目文件夹
mvn clean package -DskipTests		# 使用 maven编译打包
docker build -t nas.918178.xyz:10088/kkfileview .		# 构建镜像

docker run --name kkfileview -p 8012:8012 nas.918178.xyz:10088/kkfileview		# 运行容器
docker run --name kkfileview -p 8012:8012 -v $PWD:/opt/kkFileView-4.2.0-SNAPSHOT/file nas.918178.xyz:10088/kkfileview		# 运行容器,挂在数据文件到本地
```
可选参数：
---
- **KK_BASE_URL**：预览服务的地址，如果使用nginx等反向代理，需设置
- **KK_SIMTEXT**：文本类型
默认：txt,html,htm,asp,jsp,xml,json,properties,md,gitignore,log,java,py,c,cpp,sql,sh,bat,m,bas,prg,cmd
- **KK_MEDIA**：多媒体类型
默认：mp3,wav,mp4,flv
- **KK_OFFICE_PREVIEW_TYPE**：文档默认样式，默认显示为图片，可选(image,pdf)
- **KK_OFFICE_PREVIEW_SWITCH_DISABLED**：是否关闭样式切换开关，默认为false
- **KK_PDF_PRESENTATION_MODE_DISABLE**：是否禁止演示模式，默认为false
- **KK_PDF_OPEN_FILE_DISABLE**：是否禁止打开文件，默认为true
- **KK_PDF_DOWNLOAD_DISABLE**：是否禁止下载转换生成的pdf文件，默认为true
- **KK_FILE_UPLOAD_ENABLED**：是否禁用首页文件上传，默认为true
- **WATERMARK_TXT**：水印内容，为空则没有水印

更加详细的可修改参数参考 `application.properties` 每一项 `${}` 内的就是对应环境变量

### application.properties
`...\server\src\main\config\application.properties` 主要配置都在这了
注意：`任何调整后都需要重新使用 maven编译打包，然后再次构建才有用`
```yaml
#######################################不可动态配置，需要重启生效#######################################
server.port = ${KK_SERVER_PORT:8012}
server.servlet.context-path= ${KK_CONTEXT_PATH:/}
server.servlet.encoding.charset = utf-8
#文件上传限制
spring.servlet.multipart.max-file-size=50MB
spring.servlet.multipart.max-request-size=50MB
## Freemarker 配置
spring.freemarker.template-loader-path = classpath:/web/
spring.freemarker.cache = false
spring.freemarker.charset = UTF-8
spring.freemarker.check-template-location = true
spring.freemarker.content-type = text/html
spring.freemarker.expose-request-attributes = true
spring.freemarker.expose-session-attributes = true
spring.freemarker.request-context-attribute = request
spring.freemarker.suffix = .ftl

# office-plugin
## office转换服务的进程数，默认开启两个进程
office.plugin.server.ports = 22001,22002,22003,22004
## office 转换服务 task 超时时间，默认五分钟
office.plugin.task.timeout = 5m

#预览生成资源路径（默认为打包根路径下的file目录下）
#file.dir = D:\\kkFileview\\
file.dir = ${KK_FILE_DIR:default}

#允许预览的本地文件夹 默认不允许任何本地文件被预览
#file.dir = D:\\kkFileview\\
local.preview.dir = ${KK_LOCAL_PREVIEW_DIR:default}

#openoffice home路径
#office.home = C:\\Program Files (x86)\\OpenOffice 4
office.home = ${KK_OFFICE_HOME:default}

#缓存实现类型，不配默认为内嵌RocksDB(type = default)实现，可配置为redis(type = redis)实现（需要配置spring.redisson.address等参数）和 JDK 内置对象实现（type = jdk）,
cache.type =  ${KK_CACHE_TYPE:jdk}
#redis连接，只有当cache.type = redis时才有用
spring.redisson.address = ${KK_SPRING_REDISSON_ADDRESS:127.0.0.1:6379}
spring.redisson.password = ${KK_SPRING_REDISSON_PASSWORD:}
#缓存是否自动清理 true 为开启，注释掉或其他值都为关闭
cache.clean.enabled = ${KK_CACHE_CLEAN_ENABLED:true}
#缓存自动清理时间，cache.clean.enabled = true时才有用，cron表达式，基于Quartz cron
cache.clean.cron = ${KK_CACHE_CLEAN_CRON:0 0 3 * * ?}

#######################################可在运行时动态配置#######################################
#提供预览服务的地址，默认从请求url读，如果使用nginx等反向代理，需要手动设置
#base.url = https://file.keking.cn
base.url = ${KK_BASE_URL:default}

#信任站点，多个用','隔开，设置了之后，会限制只能预览来自信任站点列表的文件，默认不限制
#trust.host = kkview.cn
trust.host = ${KK_TRUST_HOST:default}

#是否启用缓存
cache.enabled = ${KK_CACHE_ENABLED:true}

#文本类型，默认如下，可自定义添加
simText = ${KK_SIMTEXT:txt,html,htm,asp,jsp,xml,json,properties,md,gitignore,log,java,py,c,cpp,sql,sh,bat,m,bas,prg,cmd}
#多媒体类型，默认如下，可自定义添加
media = ${KK_MEDIA:mp3,wav,mp4,flv}
#是否开启多媒体类型转视频格式转换,目前可转换视频格式有：avi,mov,wmv,3gp,rm
#请谨慎开启此功能，建议异步调用添加到处理队列，并且增加任务队列处理线程，防止视频转换占用完线程资源，转换比较耗费时间,并且控制了只能串行处理转换任务
media.convert.disable = ${KK_MEDIA_CONVERT_DISABLE:false}
#支持转换的视频类型
convertMedias = ${KK_CONVERTMEDIAS:avi,mov,wmv,mkv,3gp,rm}
#office类型文档(word ppt)样式，默认为图片(image)，可配置为pdf（预览时也有按钮切换）
office.preview.type = ${KK_OFFICE_PREVIEW_TYPE:image}
#是否关闭office预览切换开关，默认为false，可配置为true关闭
office.preview.switch.disabled = ${KK_OFFICE_PREVIEW_SWITCH_DISABLED:false}

#是否禁止演示模式
pdf.presentationMode.disable = ${KK_PDF_PRESENTATION_MODE_DISABLE:false}
#是否禁止打开文件
pdf.openFile.disable = ${KK_PDF_OPEN_FILE_DISABLE:true}
#是否禁止打印转换生成的pdf文件
pdf.print.disable = ${KK_PDF_PRINT_DISABLE:true}
#是否禁止下载转换生成的pdf文件
pdf.download.disable = ${KK_PDF_DOWNLOAD_DISABLE:true}
#是否禁止bookmark
pdf.bookmark.disable = ${KK_PDF_BOOKMARK_DISABLE:true}
#是否禁用首页文件上传，禁用后全部走链接
file.upload.disable = ${KK_FILE_UPLOAD_ENABLED:true}

#预览源为FTP时 FTP用户名，可在ftp url后面加参数ftp.username=ftpuser指定，不指定默认用配置的
ftp.username = ${KK_FTP_USERNAME:ftpuser}
#预览源为FTP时 FTP密码，可在ftp url后面加参数ftp.password=123456指定，不指定默认用配置的
ftp.password = ${KK_FTP_PASSWORD:123456}
#预览源为FTP时, FTP连接默认ControlEncoding(根据FTP服务器操作系统选择，Linux一般为UTF-8，Windows一般为GBK)，可在ftp url后面加参数ftp.control.encoding=UTF-8指定，不指定默认用配置的
ftp.control.encoding = ${KK_FTP_CONTROL_ENCODING:UTF-8}

#水印内容
#例：watermark.txt = ${WATERMARK_TXT:凯京科技内部文件，严禁外泄}
#如需取消水印，内容设置为空即可，例：watermark.txt = ${WATERMARK_TXT:}
watermark.txt = ${WATERMARK_TXT:造物者W}
#水印x轴间隔
watermark.x.space = ${WATERMARK_X_SPACE:20}
#水印y轴间隔
watermark.y.space = ${WATERMARK_Y_SPACE:20}
#水印字体
watermark.font = ${WATERMARK_FONT:微软雅黑}
#水印字体大小
watermark.fontsize = ${WATERMARK_FONTSIZE:18px}
#水印字体颜色
watermark.color = ${WATERMARK_COLOR:black}
#水印透明度，要求设置在大于等于0.005，小于1
watermark.alpha = ${WATERMARK_ALPHA:0.2}
#水印宽度
watermark.width = ${WATERMARK_WIDTH:180}
#水印高度
watermark.height = ${WATERMARK_HEIGHT:80}
#水印倾斜度数，要求设置在大于等于0，小于90
watermark.angle = ${WATERMARK_ANGLE:10}

#Tif类型图片浏览模式：tif（利用前端js插件浏览）；jpg（转换为jpg后前端显示）；pdf（转换为pdf后显示，便于打印）
tif.preview.type = ${KK_TIF_PREVIEW_TYPE:tif}
```
### Dockerfile
构建镜像配置文件
```yaml
# 引用的主镜像,使用 kkfileview-jdk 官方的,官方镜像已经部署好显示所需的所有环境
FROM keking/kkfileview-jdk:4.1.1
# 把编译好后的主体文件加入镜像
ADD server/target/kkFileView-*.tar.gz /opt/
# 定义 kkfileview 的 bin 文件夹所在位置
ENV KKFILEVIEW_BIN_FOLDER /opt/kkFileView-4.2.0-SNAPSHOT/bin
# 配置启动参数,定义文件编码格式UTF-8,定义 application.properties 配置文件所在位置,启动 kkFileView-4.2.0-SNAPSHOT.jar 主程序
# 主程序构建在 ...\server\target\ 下,如果名称变了,这里的启动文件也要变
# 默认存储位置为 /opt/kkFileView-4.2.0-SNAPSHOT/file,上传文件则在 demo 子目录下
ENTRYPOINT ["java","-Dfile.encoding=UTF-8","-Dspring.config.location=/opt/kkFileView-4.2.0-SNAPSHOT/config/application.properties","-jar","/opt/kkFileView-4.2.0-SNAPSHOT/bin/kkFileView-4.2.0-SNAPSHOT.jar"]
# 引导需开放端口
EXPOSE 8012
```

## Markdown 使用
```html


<iframe src="http://localhost:8012/onlinePreview?url=aHR0cHM6Ly8xOTIuMTY4LjEwMC4yMzM6MTA4MC93d3cuc3Rs" width="900" height="600"> </iframe>


```