corentinth/papra

极简文档管理与归档平台镜像

镜像概述

本镜像是一个极简设计的文档管理与归档平台，旨在提供轻量级、易于部署和使用的文档管理解决方案。其核心设计理念是精简功能、降低资源占用，同时满足基本的文档存储、分类、检索和归档需求，适合个人用户或小型团队快速搭建文档管理系统。

核心功能与特性

核心功能

• 文档存储：支持上传、存储各类格式文档（如PDF、TXT、DOCX、图片等）
• 文档组织：提供标签、文件夹分类功能，支持自定义文档结构
• 归档管理：支持手动或按规则自动归档过期/旧文档，释放活跃空间
• 检索功能：基础文档检索（按名称、标签、上传日期等条件）

特性

• 极简设计：无冗余功能，轻量级架构，资源占用低（CPU/内存消耗小）
• 易于部署：单容器部署，无需复杂依赖，支持数据持久化存储
• 跨平台访问：内置Web界面，通过浏览器即可访问和管理文档
• 配置灵活：支持通过环境变量自定义端口、存储路径等基础配置

使用场景与适用范围

适用场景

• 个人文档管理：用于整理个人笔记、学习资料、工作文档等
• 小型团队协作：团队内部共享项目文档、会议记录、规范文档等
• 轻量级归档需求：对历史文件、备份文档进行集中归档和长期保存
• 资源受限环境：适合部署在个人服务器、NAS或边缘设备等资源有限的环境中

不适用场景

• 大规模企业级文档管理（功能较基础，不支持复杂权限管理、版本控制等高级功能）
• 对实时协作、在线编辑有强需求的场景

使用方法与配置说明

基本部署（Docker Run）

通过以下命令快速启动容器：

bash
docker run -d \
  --name doc-archive \
  -p 8080:8080 \
  -v ./doc-data:/app/data \
  docker.xuanyuan.run/minimal-doc-archive:latest

参数说明：

• -p 8080:8080：将容器内8080端口映射到主机8080端口（可根据需求修改主机端口）
• -v ./doc-data:/app/data：挂载主机目录./doc-data到容器内/app/data，用于持久化存储文档数据
• --name doc-archive：指定容器名称为doc-archive

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  doc-archive:
    image: docker.xuanyuan.run/minimal-doc-archive:latest
    container_name: doc-archive
    ports:
      - "8080:8080"  # 主机端口:容器端口
    volumes:
      - ./doc-data:/app/data  # 持久化数据目录
    environment:
      - PORT=8080  # 容器内服务端口（默认8080，如需修改需同步端口映射）
      - DATA_DIR=/app/data  # 容器内数据存储路径（默认/app/data）
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

bash
docker-compose up -d

环境变量配置

支持以下环境变量自定义容器行为：

访问与使用

容器启动后，通过浏览器访问 http://<主机IP>:8080 即可打开Web管理界面，首次访问可根据引导完成初始配置（如设置管理员账户），之后即可开始上传、管理和归档文档。

数据持久化

为避免容器删除导致数据丢失，需通过 -v 参数将 /app/data 目录挂载到主机目录（如上述部署命令中的 ./doc-data），所有文档和配置数据将保存在该目录下。

注意事项

• 本平台为极简设计，不提供数据加密功能，建议通过外部手段（如主机文件系统权限、网络隔离）保护敏感文档
• 支持的文档格式取决于内置Web服务器配置，通常包括常见文本、图片、PDF等格式，超大文件（>100MB）可能需要额外配置
• 升级镜像时，建议先备份挂载的/app/data目录，避免数据兼容性问题