loredcast/filewizard

filewizard 镜像文档

镜像概述

filewizard 是一款自托管 Web 应用，集成文件转换、PDF OCR 与音频转录（基于 Whisper）功能。提供两种镜像版本：filewizard:small（轻量版，不含 calibre、libreoffice 和 texlive）和 filewizard:latest（完整版，包含所有工具及 tex 构建支持）。项目地址：https://github.com/LoredCast/filewizard

核心功能与特性

• 多合一文件处理：支持文件转换、PDF 光学字符识别（OCR）及音频转录
• 音频转录：集成 Whisper 模型，支持 CPU/GPU 处理
• 灵活镜像版本：轻量版（small）精简工具集，完整版（latest）包含全部功能组件
• 本地认证控制：可通过配置启用/禁用 OIDC 认证，保护访问安全
• 数据持久化：支持卷挂载，确保配置、上传及处理后文件持久存储

使用场景

• 个人或小型团队的本地化文件处理需求
• 需保护数据隐私，避免文件上传至第三方服务的场景
• 需统一管理文件转换、PDF 文本提取及音频转写工作流的场景

使用方法

1. Docker Compose 配置

创建 docker-compose.yml 文件，根据需求选择镜像版本及配置：

yaml
version: "3.9"
services:
  web:
    image: loredcast/filewizard:0.4-latest
    build:
      context: .
      # 设置构建目标阶段（关键配置）
      target: full-final # 根据需求改为 'full-final'（完整版）或 'small-final'（轻量版）
    #env_file:
    # - .env
    environment:
      - LOCAL_ONLY=True # 设置为 False 启用 OIDC 认证（需在 settings.yml 中配置）
      - SECRET_KEY= # 启用认证时必填
      - UPLOADS_DIR=/app/uploads # 容器内目录结构（非主机目录）
      - PROCESSED_DIR=/app/processed
      - OMP_NUM_THREADS=1
      - DOWNLOAD_KOKORO_ON_STARTUP=true
      #- TRANSCRIPTION_DEVICE=cpu  # 有 GPU 时可改为 'cuda'
      #- TRANSCRIPTION_COMPUTE_TYPE=int8 # GPU 可用 'float16' 或 'int8_float16'
      #- TRANSCRIPTION_DEVICE_INDEX=0 # 多 GPU 时修改索引
    #user: "1000:1000"
    ports:
      - "6969:8000"
    volumes:
      # 挂载本地目录实现持久化
      - ./config:/app/config # 可将 settings.default.yml 复制至此并重命名为 settings.yml
      - ./uploads_data:/app/uploads
      - ./processed_data:/app/processed

    # 若使用 CUDA 构建，启用 GPU 访问（取消下方注释）
    #deploy:
    #  resources:
    #    reservations:
    #      devices:
    #        - driver: nvidia
    #          count: all
    #          capabilities: [gpu]

volumes:
  uploads_data: {}
  processed_data: {}

2. 环境变量配置

主要环境变量说明

环境文件（可选）

创建 .env 文件统一管理环境变量：

env
# 应用设置
LOCAL_ONLY=True
SECRET_KEY=test_key_for_dev
# 文件路径（开发环境默认值）
UPLOADS_DIR=./uploads
PROCESSED_DIR=./processed
CHUNK_TMP_DIR=./uploads/tmp

在 docker-compose.yml 中取消 env_file: - .env 注释即可应用该文件。

3. 启动容器

配置完成后执行以下命令启动服务：

bash
docker compose up -d

服务启动后通过 http://localhost:6969 访问 Web 界面。

注意事项

• 本地挂载目录（./config、./uploads_data、./processed_data）需提前创建，避免权限错误
• 镜像版本选择：轻量版（small）通过 target: small-final 构建，不含 calibre、libreoffice 和 texlive；完整版（latest）使用 target: full-final
• GPU 支持需安装 NVIDIA Docker 运行时，并启用 deploy 配置段的 GPU 资源预留
• 启用 OIDC 认证时，需在 ./config/settings.yml 中补充 OIDC 服务端配置信息