Bibliotheca 镜像文档

镜像概述和主要用途

Bibliotheca是一款基于Flask框架开发的自托管Web应用，主要功能为个人图书馆管理和阅读进度追踪。该镜像提供了便捷的部署方式，用户可通过Web界面管理个人藏书信息、记录阅读状态及进度，所有数据存储于本地，保障隐私安全。

核心功能和特性

核心功能

• 个人图书馆管理：支持添加、编辑、删除书籍信息（包括书名、作者、ISBN、分类、封面等）
• 阅读进度追踪：记录书籍阅读状态（未读/在读/已读）、阅读进度百分比、阅读笔记及完成日期
• 数据本地存储：采用自托管模式，所有书籍数据和阅读记录存储于本地，无需依赖第三方服务

主要特性

• 轻量高效：基于Flask框架开发，资源占用低，运行高效
• 跨设备访问：通过Web界面访问，支持电脑、平板、手机等多种设备
• 易于部署：提供Docker镜像，简化部署流程，无需复杂环境配置
• 隐私保障：数据本地存储，避免个人阅读数据泄露

使用场景和适用范围

适用场景

• 个人用户管理私人藏书库，整理实体书或电子书信息
• 阅读爱好者跟踪阅读计划，记录多本书籍的阅读进度
• 需要本地存储书籍数据，对隐私和数据控制权有较高要求的用户
• 希望构建个人化图书馆系统，替代第三方读书平台的用户

适用范围

• 个人用户（主要目标用户）
• 小型家庭或读书小组共享使用
• 对技术要求较低，需要简单部署方案的用户

使用方法和配置说明

基本部署方法

Docker Run 命令

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

docker run -d \
  --name bibliotheca \
  -p 5000:5000 \
  -v /path/to/local/data:/app/data \
  --restart unless-stopped \
  bibliotheca

• -p 5000:5000：端口映射，将容器内5000端口映射到主机5000端口（可根据需要修改主机端口）
• -v /path/to/local/data:/app/data：数据卷挂载，将容器内数据目录（/app/data）映射到主机本地目录，确保数据持久化
• --restart unless-stopped：设置容器自动重启策略

访问应用

部署完成后，通过浏览器访问 http://<主机IP>:5000 即可打开Bibliotheca Web界面。

配置参数说明

必要配置

• 数据卷挂载：必须通过 -v 参数挂载本地目录到 /app/data，否则容器重启后数据会丢失
• 端口映射：默认使用5000端口，若主机5000端口被占用，可修改为其他端口（如 -p 8080:5000）

可选环境变量

目前***未明确提供环境变量配置，如有特殊需求，可通过以下方式自定义Flask配置：

docker run -d \
  --name bibliotheca \
  -p 5000:5000 \
  -v /path/to/local/data:/app/data \
  -e FLASK_ENV=production \  # 设置Flask运行环境（默认production）
  -e SECRET_KEY=your_custom_key \  # 自定义Flask安全密钥（增强安全性）
  bibliotheca

数据持久化

容器内书籍数据和阅读记录存储于 /app/data 目录，通过 -v 参数将该目录挂载到主机本地路径（如 /home/user/bibliotheca-data），即可实现数据持久化。建议定期备份本地数据目录，防止数据丢失。

升级与维护

1. 停止并删除现有容器：

   docker stop bibliotheca && docker rm bibliotheca
   

2. 拉取最新镜像（若使用***镜像）：

   docker pull bibliotheca
   

3. 使用原数据卷重新启动容器：

   docker run -d \
     --name bibliotheca \
     -p 5000:5000 \
     -v /path/to/local/data:/app/data \
     --restart unless-stopped \
     bibliotheca