b1n4ryj4n/koreader-sync Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Koreader 位置同步服务器

镜像概述

这是KOReader（[***]

核心功能和特性

• 提供KOReader阅读位置同步服务，支持自托管
• 基于FastAPI构建，轻量高效
• 使用TinyDB作为数据存储，无需复杂数据库配置
• 支持Docker部署，兼容arm和amd64架构
• 可通过环境变量配置服务器行为
• 包含健康检查功能，可通过HTTP端点监控服务状态

依赖项

• FastAPI: [***]
• TinyDB: [***]
• Uvicorn: [***]
• Python-dotenv: [***]

安装与运行

直接运行

bash
# 安装依赖
pip install -r requirements.txt

# 启动服务
uvicorn kosync:app --host 0.0.0.0 --port 8081

Docker部署

构建镜像并启动

bash
# 构建镜像
docker build --rm=true --tag=kosync:latest .

# 使用docker-compose启动
docker-compose up -d

Docker Hub镜像

若无法自行构建镜像，可使用Docker Hub上的现成镜像：

• Linux/amd64架构: docker pull b1n4ryj4n/koreader-sync
• Linux/arm架构: docker pull b1n4ryj4n/koreader-sync:arm

环境变量配置

RECEIVE_RANDOM_DEVICE_ID

• 取值: "True" | "False"
• 作用: 设置为"True"时，始终生成随机设备ID以强制进度同步。适用于仅从一个设备同步进度，且经常使用清理工具删除*.sdr文件的场景。

OPEN_REGISTRATIONS

• 取值: "True" | "False"
• 作用: 启用/禁用新用户注册。适用于运行仅供少数用户使用的私有服务器场景（但本身并不一定提升安全性）。默认值为"True"（启用）。

连接配置

1. 在KOReader中设置自定义同步服务器地址为 [***]
2. 推荐配置反向代理（如使用Nginx Proxy Manager: [***]

更新日志

[0.0.5] - 2024-05-24

新增

• 合并特性："通过环境变量禁用新用户注册的选项"（[***]

[0.0.4] - 2023-10-29

新增

• 添加HEALTHCHECK命令（可通过[***]

[0.0.3] - 2022-03-20

新增

• 添加环境变量选项，支持始终接收随机设备ID

[0.0.2] - 2022-02-21

新增

• 合并特性："Dockerfile：使用多阶段构建优化镜像大小"（[***]

[0.0.1] - 2021-09-15

新增

• 初始版本发布