本地化的PDF操作神器_stirling-pdf

公众号：【可乐前端】，每天3分钟学习一个优秀的开源项目，分享web面试与实战知识，也有全栈交流学习摸鱼群，期待您的关注!

每天3分钟开源

hi，这里是每天3分钟开源，很高兴又跟大家见面了，今天介绍的开源项目简介如下：

仓库名：Stirling-Tools/Stirling-PDF

项目名：Stirling-PDF

开源地址：https://github.com/Stirling-Tools/Stirling-PDF

主要语言： Java

stars数量：20295

forks数量：1454

开源协议：GNU General Public License v3.0

一句话介绍

这是一个功能强大的本地化PDF操作工具，支持多种PDF文件操作，包括合并、分割、转换、重组、添加图片、旋转、压缩等。

详细描述

Stirling PDF 是一个强大的本地化PDF操作工具，它通过 Docker 提供基于Web的服务，让你能在本地进行各种PDF文件的操作。此工具最初是由 ChatGPT 开发的应用，随着时间的推移，它已经发展成为一个具有广泛功能的应用，能满足你所有的PDF需求。

Stirling PDF 不进行任何外部调用进行记录或追踪。所有的文件和PDF都存在于客户端之中，只在任务执行期间存在于服务器内存中，或者临时存在于文件中以便于任务执行。任何被用户下载的文件此时已经从服务器上删除。

具体功能

1.暗模式支持
2.自定义下载选项
3.并行文件处理和下载
4.提供API，可以与外部脚本集成
5.支持登录和身份验证（可选）
6.PDF特性

• 页面操作：查看和修改PDFs，自定义查看、排序和搜索多页PDF。还包括页面编辑功能，如注释、绘图和添加文本和图像。
• 合并多个PDF文件到一个文件中。
• 在指定的页码处分割PDF文件到多个文件中，或者提取所有页面为独立文件。
• 重新组织PDF页面到不同的顺序。
• 90度增量旋转PDF。
• 移除页面。
• 多页布局：将PDF格式化为多页页面。
• 缩放页面内容大小至指定%。
• 调整对比度。
• 裁剪PDF。
• 自动分割PDF（使用物理扫描的页面分隔符）。
• 提取页面。
• 将PDF转换为单页。
• 转换操作：将PDF转换为图片，将任何普通文件转换为PDF，将PDF转换为Word、Powerpoint等其他格式，将HTML转换为PDF，URL转换为PDF，Markdown转换为PDF。
• 安全和权限：添加和移除密码，更改/设置PDF权限，添加水印，证明/签署PDF，清理PDF，自动清除文本。
• 其他操作：添加/生成/写入签名，修复PDF，检测并移除空白页面，比较2个PDF并显示文本差异，向PDF添加图片，压缩PDF以减小文件大小，从PDF提取图片，从扫描件提取图片，添加页码，通过检测PDF头部文本自动重命名文件，对PDF进行OCR，对PDF进行PDF/A转换，编辑元数据，展平PDF，获取PDF的所有信息进行查看或导出为JSON。

如何使用

本地化：
请查看 本地运行指南
Docker / Podman：
请查看 Docker镜像

Docker运行代码示例：

docker run -d \
  -p 8080:8080 \
  -v /location/of/trainingData:/usr/share/tessdata \
  -v /location/of/extraConfigs:/configs \
  -v /location/of/logs:/logs \
  -e DOCKER_ENABLE_SECURITY=false \
  -e INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false \
  --name stirling-pdf \
  frooodle/s-pdf:latest
1
2
3
4
5
6
7
8
9

Docker Compose代码示例：

version: '3.3'
services:
  stirling-pdf:
    image: frooodle/s-pdf:latest
    ports:
      - '8080:8080'
    volumes:
      - /location/of/trainingData:/usr/share/tessdata #Required for extra OCR languages
      - /location/of/extraConfigs:/configs
    environment:
      - DOCKER_ENABLE_SECURITY=false
      - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=false
1
2
3
4
5
6
7
8
9
10
11
12

如果你想了解更多关于OCR功能的使用，请查看如何使用OCR。

支持的语言：
Stirling PDF 目前支持多达26种语言！

如果你想了解更多关于如何使用Stirling-PDFs的后端API，可以在这里查看所有的API文档，或者在你的stirling-pdf实例的/swagger-ui/index.html处查看你的版本文档。

对于API的使用，你必须提供一个带有X-API-Key的头和该用户的关联API密钥。

如果你想要登录验证，需要满足以下几个先决条件：

• 用户必须在docker中有./configs文件夹，以便在更新过程中保持它。
• Docker用户必须通过在环境变量中将DOCKER_ENABLE_SECURITY设置为true来下载安全jar版本。
• 然后通过settings.yml文件或通过将SECURITY_ENABLE_LOGIN设置为true来启用登录。

当你登录到Stirling PDF时，你将被重定向到/login页面，使用默认的凭据进行登录。登录后，一切应该如常运行。在设置齿轮菜单（导航栏右上角）中的帐户设置处访问你的帐户设置。在这个帐户设置菜单中，你还可以找到你的API密钥。要添加新用户，转到帐户设置的底部，点击"Admin Settings"，在这里你可以添加新用户。

Stirling PDF 还支持通过环境变量进行设置，举例来说，如果你在settings.yml中有这样的设置：

system:
  defaultLocale: 'en-US'
1
2

你可以通过环境变量SYSTEM_DEFAULTLOCALE来设定。

对于那些想要自定义Stirling-PDF的人来说，这个工具提供了很多自定义的选项，包括自定义应用名称、标语、图标、图片，甚至可以通过文件覆盖来自定义HTML。

最后

感谢您的阅读，这里每天都会推送优秀的开源项目，如果觉得有帮助的话，一键三连一下吧～