docspell/dsc

Docspell DSC Docker镜像文档

镜像概述和主要用途

Docspell DSC 镜像包含 Docspell 文档管理系统的命令行客户端（CLI），名为 dsc（docspell client 的缩写）。该客户端用于通过命令行与 Docspell 服务交互，支持文档上传、查询、账户管理等操作，为用户提供便捷的自动化和脚本化文档管理能力。

核心功能和特性

• 命令行交互：通过终端命令直接操作 Docspell 服务，支持上传文档、查询文档列表、管理用户账户等核心功能。
• 跨平台兼容：基于 Docker 镜像封装，无需依赖本地系统环境，可在任何支持 Docker 的平台（如 Linux、Windows、macOS）运行。
• 版本化标签：提供多版本标签，满足不同场景需求（如开发测试、生产环境）。
• 轻量高效：作为 CLI 工具，镜像体积小巧，执行命令响应快速，适合集成到自动化脚本或工作流中。

使用场景和适用范围

• 家庭/个人用户：通过脚本定时上传扫描文档（如家庭账单、证件），实现本地文件与 Docspell 服务的自动同步。
• 小团体/公司：团队成员通过命令行批量处理文档（如批量分类、标签管理），或集成到内部工作流（如邮件附件自动上传）。
• 开发/测试环境：使用 nightly 标签验证最新功能，或通过 vX.Y.Z 标签锁定稳定版本，确保生产环境兼容性。

标签说明

镜像标签对应不同构建版本，用户可根据需求选择：

• nightly：基于 master 分支构建，包含最新开发更新，适用于测试新功能（稳定性未保障）。
• latest：指向最新正式发布版本，与最新的 vX.Y.Z 标签内容一致，适用于生产环境。
• vX.Y.Z：基于同名 Git 标签的发布版本（如 v0.12.0），版本号对应具体发布节点，适合需要版本锁定的场景。

详细使用方法和配置说明

前提条件

• 已安装 Docker 环境（参考 Docker 官方安装指南）。
• 已部署 Docspell 服务，并获取服务访问地址（如 https://docspell.example.com）及认证信息（用户名/密码或 API 令牌）。

拉取镜像

根据需求拉取对应标签的镜像：

bash
# 拉取最新正式版
docker pull docspell/dsc:latest

# 拉取开发测试版（nightly）
docker pull docspell/dsc:nightly

# 拉取指定版本（如 v0.12.0）
docker pull docspell/dsc:v0.12.0

基本命令格式

通过 docker run 执行 dsc 命令，基本格式如下：

bash
docker run --rm docspell/dsc:<tag> [dsc-command] [options]

• --rm：容器退出后自动删除，避免残留临时文件。
• <tag>：指定镜像标签（如 latest、vX.Y.Z）。
• [dsc-command]：dsc 支持的具体命令（如 upload、search、help）。
• [options]：命令参数（如服务地址、认证信息、文件路径等）。

常用命令示例

1. 查看帮助信息

获取 dsc 支持的命令列表及参数说明：

bash
docker run --rm docspell/dsc:latest --help

2. 上传文档

将本地文档上传至 Docspell 服务（需挂载本地目录到容器内，并指定服务地址和认证信息）：

bash
# 挂载本地文档目录 /path/to/local/docs 到容器内 /docs，上传文件 example.pdf
docker run --rm -v /path/to/local/docs:/docs docspell/dsc:latest \
  upload \
  --server https://docspell.example.com \
  --user your-email@example.com \
  --password your-password \
  /docs/example.pdf

3. 查询文档

搜索 Docspell 服务中的文档（需认证信息）：

bash
docker run --rm docspell/dsc:latest \
  search \
  --server https://docspell.example.com \
  --auth-token your-auth-token \
  "invoice"

环境变量配置

为避免重复输入服务地址、认证信息等参数，可通过环境变量传递配置（推荐用于脚本或批量操作）：

示例：通过环境变量简化上传命令

bash
docker run --rm -v /path/to/local/docs:/docs \
  -e DOCSPELL_SERVER=https://docspell.example.com \
  -e DOCSPELL_AUTH_TOKEN=your-auth-token \
  docspell/dsc:latest \
  upload /docs/receipt.pdf

Docker Compose 配置示例

若需集成到现有服务栈（如与 Docspell 服务联动），可通过 docker-compose.yml 定义服务：

yaml
version: "3"
services:
  dsc:
    image: docspell/dsc:latest
    volumes:
      - ./local-docs:/docs  # 挂载本地文档目录
    environment:
      - DOCSPELL_SERVER=https://docspell.example.com
      - DOCSPELL_AUTH_TOKEN=your-auth-token
    # 示例：定时上传文档（需结合外部定时任务工具如 crontab）
    command: upload /docs/daily-scan.pdf

补充说明

更多详细命令参数、配置选项及最佳实践，请参考官方文档：

• https://github.com/docspell/dsc
• Docspell CLI 工具文档