leduchuong/eink_reader repository overview

⁠E-ink Box Reader (eink_reader)

English⁠

面向 NAS/局域网的电子书阅读容器，支持 TXT/EPUB 书架管理、搜索、阅读进度与最近阅读记录。

⁠For Portainer/Synology Users

复制进 Portainer 的 Stacks，点击 Deploy。搞定。 Copy this into Portainer stacks and hit Deploy. Done.

⁠Docker Compose

services:
  app:
    image: leduchuong/eink_reader:latest
    container_name: eink-reader
    restart: unless-stopped
    environment:
      - STORAGE_PATH=/storage
    ports:
      - "2004:8000"
    volumes:
      - ./books:/storage

⁠UI 界面展示

以下截图为本项目构建后的实际界面。

⁠镜像说明

✅ Perfect for Raspberry Pi & Oracle Cloud Free Tier (ARM)

• 镜像包含的核心组件
• 主要适用场景
• 关键能力与价值
• FastAPI + 原生前端电子书阅读器（TXT/EPUB）
• 适合家庭 NAS、自托管阅读库、局域网访问
• 支持书架搜索、进度记录、最近阅读、E-ink 主题体验

⁠快速开始

⁠拉取镜像

docker pull leduchuong/eink_reader:latest

⁠运行容器

docker run --rm -p 2004:8000 -e STORAGE_PATH=/storage -v ./books:/storage leduchuong/eink_reader:latest

⁠配置说明

⁠环境变量

⁠端口

• 8000/tcp：容器内应用端口（可映射为宿主机 2004）

⁠卷

• /storage：书籍目录与状态数据库目录

⁠支持的标签与 Dockerfile

⁠使用示例

curl -I http://127.0.0.1:2004/

⁠镜像来源与更新策略

• Source Repository: 本地项目上传（未绑定公开代码仓库）
• Build Policy: 手动构建并发布 latest + 版本标签

⁠许可证

仓库内未声明开源许可证，默认仅供个人学习与测试。

⁠免责声明

使用本镜像即表示你已阅读并同意 免责声明⁠。