liuweitao/paperless-ngx

Paperless-ngx Docker 镜像

镜像概述

本镜像基于 Paperless-ngx 官方镜像构建，主要增强了中文 OCR 支持，可用于将纸质文档扫描、OCR 识别并进行数字化管理，特别适合需要处理中文文档的用户。

核心功能与特性

• 基于官方 Paperless-ngx 镜像，保留其全部功能
• 内置中文 OCR 支持，包括简体中文（chi_sim）和繁体中文（chi_tra）
• 通过 GitHub Actions 自动检查并构建最新版本

使用场景

• 个人或企业纸质文档数字化管理
• 需要对中文文档进行 OCR 文字识别的场景
• 希望搭建本地化文档管理系统的用户

使用方法

快速开始

1. 创建项目目录：

bash
mkdir paperless-ngx
cd paperless-ngx

2. 下载并配置 compose 文件：

bash
# 下载 compose 文件
wget -O compose.yaml https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/refs/heads/main/docker/compose/docker-compose.postgres-tika.yml

# 将镜像地址替换为本镜像地址
sed -i 's/ghcr.io\/paperless-ngx\/paperless-ngx:latest/liuweitao\/paperless-ngx:latest/g' compose.yaml

3. 下载并配置环境文件：

bash
# 下载环境配置文件
wget https://raw.githubusercontent.com/liuweitao/DockerHub-AutoBuild/master/paperless-ngx/.env
wget https://raw.githubusercontent.com/liuweitao/DockerHub-AutoBuild/master/paperless-ngx/docker-compose.env

# 修改 docker-compose.env 中的域名配置
sed -i 's/paperless.example.com/your-domain.com/g' docker-compose.env

4. 启动服务：

bash
# 拉取镜像
docker compose pull

# 创建管理员用户
docker compose run --rm webserver createsuperuser

# 启动服务
docker compose up -d

配置说明

环境变量

目录结构

compose 文件会自动创建以下数据卷，用于持久化存储：

• data：存储数据库和索引文件
• media：存储处理后的文档
• export：文档导出目录
• consume：文档导入目录（放入此目录的文件会自动处理）

中文 OCR 支持

本镜像已预装中文 OCR 语言包，无需额外配置即可使用：

• 简体中文（chi_sim）
• 繁体中文（chi_tra）

可通过设置 PAPERLESS_OCR_LANGUAGE 环境变量指定识别语言，例如：

PAPERLESS_OCR_LANGUAGE=chi_sim+eng

注意事项

1. 首次运行前必须修改 docker-compose.env 中的域名配置（PAPERLESS_URL）
2. 确保服务器有足够磁盘空间，特别是 media 和 data 卷
3. 建议定期备份 data 和 media 目录，防止数据丢失
4. 如需启用 HTTPS，需在前端配置反向代理（如 Nginx、Traefik 等）

故障排除

如需排查问题，可通过以下命令查看服务日志：

bash
docker compose logs -f

更新说明

镜像会通过 GitHub Actions 自动同步官方最新版本，更新方法：

bash
docker compose pull
docker compose up -d

源码

本镜像属于 DockerHub-AutoBuild 项目的一部分： https://github.com/liuweitao/DockerHub-AutoBuild/

更多详细信息和更新日志，请访问上述 GitHub 仓库。