Stirling PDF Docker 安装指南

本指南提供了使用 Docker 安装 Stirling PDF 的说明。

使用 docker run

您可以使用以下 docker run 命令来运行 Stirling PDF：

docker run -d \
  --name stirling-pdf \
  -p 8080:8080 \
  -v "./StirlingPDF/trainingData:/usr/share/tessdata" \
  -v "./StirlingPDF/extraConfigs:/configs" \
  -v "./StirlingPDF/customFiles:/customFiles/" \
  -v "./StirlingPDF/logs:/logs/" \
  -v "./StirlingPDF/pipeline:/pipeline/" \
  -e DOCKER_ENABLE_SECURITY=false \
  -e LANGS=zh_CN,en_GB \
  docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest

参数说明:

• -d: 在后台（分离模式）运行容器。
• --name stirling-pdf: 为容器分配一个名称。
• -p 8080:8080: 将主机的 8080 端口映射到容器的 8080 端口。
• -v "./StirlingPDF/...:/...": 挂载本地目录以实现数据持久化（训练数据、配置、自定义文件、日志、管道）。请确保 ./StirlingPDF 目录存在或根据需要修改路径。
• -e DOCKER_ENABLE_SECURITY=false: 示例环境变量（有关安全含义，请参阅文档）。注意： 在生产环境中，建议仔细评估安全设置。
• -e LANGS=zh_CN,en_GB: 设置 OCR 语言（示例：简体中文、英式英语）。您可以根据需要添加更多语言代码，用逗号分隔。
• docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest: 要使用的 Docker 镜像。

使用 docker-compose

或者，您可以使用 Docker Compose。创建一个名为 docker-compose.yml 的文件，内容如下：

version: '3.3'
services:
  stirling-pdf:
    image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest
    ports:
      - '8080:8080'
    volumes:
      - ./StirlingPDF/trainingData:/usr/share/tessdata # 额外的 OCR 语言需要
      - ./StirlingPDF/extraConfigs:/configs
      - ./StirlingPDF/customFiles:/customFiles/
      - ./StirlingPDF/logs:/logs/
      - ./StirlingPDF/pipeline:/pipeline/
    environment:
      # DOCKER_ENABLE_SECURITY=false # 生产环境建议评估安全设置
      - LANGS=zh_CN,en_GB # 根据需要设置语言

然后，在 docker-compose.yml 文件所在的目录下运行以下命令：

docker-compose up -d

进阶配置

有关高级配置选项，请参阅官方 Stirling PDF 高级配置文档。

以下是一些常见的配置选项，可以通过环境变量进行设置：

常用环境变量

• LANGS: 定义要安装的 OCR 语言库。多个语言用逗号分隔，例如 zh_CN,en_GB,fr_FR。你需要提供有效的 Tesseract 语言代码。
• UI_APPNAME: 自定义应用程序的名称，显示在浏览器标签页和页面标题中。
• UI_HOMEDESCRIPTION: 自定义主页上的描述文字。
• UI_APPNAVBARNAME: 自定义导航栏上显示的应用程序名称。
• SYSTEM_ROOTURIPATH: 设置应用程序的根路径。例如，设置为 /stirlingpdf 后，应用将通过 http://<your-ip>:8080/stirlingpdf 访问。
• DOCKER_ENABLE_SECURITY: 设置为 true 以启用登录认证等安全功能（需要额外配置）。
• SYSTEM_CONNECTIONTIMEOUTMINUTES: 设置自定义的连接超时时间（分钟）。

如何应用环境变量

使用 docker run:

在 docker run 命令中添加 -e 参数来设置环境变量：

docker run -d \
  --name stirling-pdf \
  -p 8080:8080 \
  -v "./StirlingPDF/trainingData:/usr/share/tessdata" \
  -v "./StirlingPDF/extraConfigs:/configs" \
  -v "./StirlingPDF/customFiles:/customFiles/" \
  -v "./StirlingPDF/logs:/logs/" \
  -v "./StirlingPDF/pipeline:/pipeline/" \
  -e LANGS=zh_CN,en_GB \
  -e UI_APPNAME="我的 PDF 工具" \
  -e UI_HOMEDESCRIPTION="一个强大的本地 PDF 处理工具箱" \
  docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest

使用 docker-compose.yml:

在 docker-compose.yml 文件的 environment 部分添加环境变量：

version: '3.3'
services:
  stirling-pdf:
    image: docker.stirlingpdf.com/stirlingtools/stirling-pdf:latest
    ports:
      - '8080:8080'
    volumes:
      - ./StirlingPDF/trainingData:/usr/share/tessdata
      - ./StirlingPDF/extraConfigs:/configs
      - ./StirlingPDF/customFiles:/customFiles/
      - ./StirlingPDF/logs:/logs/
      - ./StirlingPDF/pipeline:/pipeline/
    environment:
      LANGS: zh_CN,en_GB,fr_FR
      UI_APPNAME: "我的 PDF 工具"
      UI_HOMEDESCRIPTION: "一个强大的本地 PDF 处理工具箱"
      # SYSTEM_ROOTURIPATH: /stirlingpdf # 如果需要，取消注释并设置路径
      # DOCKER_ENABLE_SECURITY: true # 如果需要，取消注释以启用安全功能

请根据您的需求选择并修改相应的环境变量。