Papermerge 开源文档管理系统安装与配置指南
1. 项目基础介绍和主要编程语言
项目基础介绍
Papermerge 是一个开源的文档管理系统,专为数字档案(扫描文档)设计。它通过 OCR 技术从扫描文档中提取文本,并进行索引,以便进行全文搜索。Papermerge 提供了现代桌面文件浏览器的感觉,支持双面板文档浏览器、拖放操作、标签、层次文件夹和全文搜索等功能。它支持 PDF、TIFF、JPEG 和 PNG 等文档格式,非常适合长期存储文档。
主要编程语言
Papermerge 主要使用 Python 编程语言开发。
2. 项目使用的关键技术和框架
关键技术和框架
- Django: 一个高级 Python Web 框架,用于快速开发安全和可维护的网站。
- OCR (Optical Character Recognition): 用于从扫描文档中提取文本。
- REST API: 提供多用户支持的 API。
- Docker: 用于容器化部署,简化安装和配置过程。
3. 项目安装和配置的准备工作和详细安装步骤
准备工作
-
安装 Docker 和 Docker Compose:
- 访问 Docker 官网 下载并安装 Docker 和 Docker Compose。
- 确保 Docker 服务已启动。
-
获取项目代码:
- 使用 Git 克隆项目代码到本地:
git clone https://github.com/ciur/papermerge.git cd papermerge
- 使用 Git 克隆项目代码到本地:
详细安装步骤
-
配置环境变量:
- 在项目根目录下创建一个
.env
文件,并添加以下内容:PAPERMERGE_SECRET_KEY=your_secret_key PAPERMERGE_DB_NAME=papermerge PAPERMERGE_DB_USER=papermerge PAPERMERGE_DB_PASSWORD=your_db_password PAPERMERGE_DB_HOST=db PAPERMERGE_DB_PORT=5432
- 替换
your_secret_key
和your_db_password
为你的安全密钥和数据库密码。
- 在项目根目录下创建一个
-
启动 Docker 容器:
- 在项目根目录下运行以下命令启动 Docker 容器:
docker-compose up -d
- 这将启动 Papermerge 及其依赖服务(如数据库)。
- 在项目根目录下运行以下命令启动 Docker 容器:
-
初始化数据库:
- 进入 Papermerge 容器并运行数据库迁移命令:
docker-compose exec web python manage.py migrate
- 进入 Papermerge 容器并运行数据库迁移命令:
-
创建管理员用户:
- 在容器内创建一个管理员用户:
docker-compose exec web python manage.py createsuperuser
- 按照提示输入用户名、电子邮件和密码。
- 在容器内创建一个管理员用户:
-
访问 Papermerge:
- 打开浏览器,访问
http://localhost:8000
。 - 使用之前创建的管理员用户登录。
- 打开浏览器,访问
配置完成
至此,Papermerge 已经成功安装并配置完成。你可以开始使用它来管理你的扫描文档了。
通过以上步骤,你可以轻松地在本地环境中安装和配置 Papermerge 开源文档管理系统。希望这篇指南对你有所帮助!