stefanlachner/paperless-to-lexoffice Docker 镜像 - 轩辕镜像

paperless-ngx-to-lexoffice 同步工具 Docker 镜像

镜像概述

该Docker镜像用于在paperless-ngx与lexoffice之间实现文档自动同步，旨在简化文档流转流程，减少手动操作，适用于需要将paperless-ngx中管理的文档自动转移至lexoffice的场景，提升工作效率。

核心功能和特性

• 自动同步：支持定时或事件触发式文档同步，无需人工干预
• 文档筛选：可通过配置筛选规则（如标签、文档类型、日期范围等）同步指定文档
• 双向API集成：适配paperless-ngx和lexoffice官方API接口，确保数据兼容性
• 错误处理：同步失败时支持重试机制，并生成详细日志便于问题排查
• 轻量级设计：基于Alpine或类似轻量基础镜像构建，资源占用低，运行稳定

使用场景和适用范围

• 小型企业/自由职业者：使用paperless-ngx管理发票、收据等财务文档，需同步至lexoffice进行会计处理的用户
• 自动化办公流程：需减少paperless-ngx与lexoffice间手动文档转移操作的场景
• 定向文档同步：仅需同步特定标签（如"客户发票"、"供应商收据"）或类型文档的场景

使用方法和配置说明

环境变量配置

使用该镜像需配置以下环境变量，其中标记为必填的为启动必需参数：

部署示例

Docker Run 命令

bash
docker run -d \
  --name paperless-lexoffice-sync \
  -e PAPERLESS_URL="[***]" \
  -e PAPERLESS_API_KEY="your_paperless_api_key" \
  -e LEXOFFICE_API_KEY="your_lexoffice_api_key" \
  -e SYNC_INTERVAL="3600" \
  -e SYNC_FILTER_TAGS="invoice,receipt" \
  -e LOG_LEVEL="INFO" \
  --restart unless-stopped \
  [镜像名称]:[标签]

Docker Compose 配置

yaml
version: '3.8'

services:
  paperless-lexoffice-sync:
    image: [镜像名称]:[标签]
    container_name: paperless-lexoffice-sync
    environment:
      - PAPERLESS_URL=[***]
      - PAPERLESS_API_KEY=your_paperless_api_key
      - LEXOFFICE_API_KEY=your_lexoffice_api_key
      - SYNC_INTERVAL=3600
      - SYNC_FILTER_TAGS=invoice,receipt
      - LOG_LEVEL=INFO
    restart: unless-stopped
    networks:
      - paperless-network  # 确保与paperless-ngx在同一网络

networks:
  paperless-network:
    external: true  # 假设paperless-ngx已使用此网络

详细使用步骤

1. 获取API密钥

• paperless-ngx：登录后进入"用户设置" → "API密钥"，点击"生成新密钥"并保存
• lexoffice：登录后进入"账户设置" → "API访问"，创建API密钥并授予文档写入权限

2. 配置同步规则

• 通过SYNC_FILTER_TAGS指定需同步的文档标签（如"tax_invoice"）
• 可选通过SYNC_DOCUMENT_TYPES限制文档类型（如仅同步"invoice"类型）
• 设置SYNC_INTERVAL调整同步频率（建议生产环境设置为3600秒及以上）

3. 启动与验证

• 启动容器后，通过docker logs paperless-lexoffice-sync查看运行日志
• 同步成功时日志将显示"Sync completed: X documents transferred"
• 在lexoffice文档管理界面检查是否收到同步文档

注意事项

• 确保paperless-ngx和lexoffice服务可被容器访问（同一网络或使用公网地址）
• API密钥需妥善保管，避免泄露导致安全风险
• 首次同步大量文档时可能耗时较长，建议通过日志监控进度
• 若lexoffice为云服务，需确保容器具备互联网访问权限