Paperless项目部署指南：从入门到生产环境-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00528/article/details/148441812

Paperless项目部署指南：从入门到生产环境

paperless Scan, index, and archive all of your paper documents 项目地址: https://gitcode.com/gh_mirrors/pa/paperless

项目概述

Paperless是一个文档管理系统，旨在帮助用户实现无纸化办公。它能够自动扫描、OCR识别、分类和存储文档，使文档管理变得简单高效。本文将详细介绍Paperless的多种部署方式，包括标准部署、Docker部署以及生产环境优化方案。

部署方式选择

Paperless提供三种主要部署方式，各有优缺点：

标准部署（裸机部署）：适合开发者和希望深度定制的用户
Docker部署：最简单快捷的部署方式，推荐大多数用户使用
Linux容器部署：介于前两者之间的折中方案

标准部署流程

1. 环境准备

首先需要安装Paperless的依赖组件，包括Python环境、数据库支持等。具体依赖项请参考项目文档中的requirements部分。

2. 配置文件设置

将paperless.conf.example复制为/etc/paperless.conf并进行配置：

cp ../paperless.conf.example /etc/paperless.conf

关键配置项包括：

PAPERLESS_CONSUMPTION_DIR：文档自动处理的目录
PAPERLESS_OCR_THREADS：OCR处理的线程数
PAPERLESS_PASSPHRASE：GPG加密的密码（可选）

3. 数据库初始化

./manage.py migrate

4. 静态文件收集

./manage.py collectstatic

5. 创建管理员用户

./manage.py createsuperuser

6. 启动服务

启动Web服务器：

./manage.py runserver <IP>:<PORT>

启动文档消费服务（需另开终端）：

./manage.py document_consumer

Docker部署方案

1. 环境准备

安装Docker和docker-compose工具，建议使用较新版本：

Docker 1.12.0+
docker-compose 1.9.0+

2. 配置文件准备

复制示例配置文件：

cp docker-compose.yml.example docker-compose.yml
cp docker-compose.env.example docker-compose.env

3. 关键配置项

在docker-compose.env中配置：

PAPERLESS_PASSPHRASE：加密密码（可选）
PAPERLESS_OCR_THREADS：OCR线程数
PAPERLESS_OCR_LANGUAGES：OCR识别语言（如"eng chi_sim"）
USERMAP_UID/GID：用户/组ID映射

4. 启动服务

docker-compose up -d

5. 创建管理员

docker-compose run --rm webserver createsuperuser

6. 文档导入

有两种主要方式导入文档：

挂载本地目录到容器中的/consume目录
使用docker cp命令直接复制文件到容器

生产环境优化

Web服务器配置

不建议使用Django开发服务器作为生产环境，推荐以下方案：

Apache + mod_wsgi

配置示例：

<VirtualHost *:80>
    ServerName example.com
    Alias /static/ /path/to/static/
    WSGIScriptAlias / /path/to/wsgi.py
    WSGIDaemonProcess example.com user=paperless group=paperless threads=5
    WSGIProcessGroup example.com
</VirtualHost>

Nginx + Gunicorn

Nginx配置片段：

server {
    listen 80;
    location /static {
        alias /path/to/static;
    }
    location / {
        proxy_pass http://127.0.0.1:8000;
    }
}

启动Gunicorn：

gunicorn --pythonpath=/path/to/src paperless.wsgi -w 2

系统服务化

Systemd配置

对于使用Systemd的系统，可以将Paperless配置为系统服务：

创建paperless用户和组
复制服务文件到系统目录
修改服务文件中的路径
启用并启动服务

systemctl enable paperless-consumer
systemctl enable paperless-webserver
systemctl start paperless-consumer
systemctl start paperless-webserver

Upstart配置

对于使用Upstart的系统（如Ubuntu 14.04及更早版本）：

start on (local-filesystems and net-device-up IFACE=eth0)
stop on shutdown
respawn
respawn limit 10 5
script
  exec /path/to/gunicorn --pythonpath=/path/to/src paperless.wsgi -w 2
end script