
vanadium23/kompanionKOmpanion 是一款简约的图书馆 Web 应用,与 KOReader 功能紧密集成。它旨在作为 KOReader 的配套工具,提供书架管理、书籍下载、阅读进度同步和阅读统计等核心功能,而非用于网页阅读或格式转换。
KOmpanion 不包含以下功能:
适用于 KOReader 用户,需要跨设备同步阅读进度、集中管理电子书库、获取详细阅读统计(如总阅读时间、每页阅读时间、阅读预估等)的场景。尤其适合拥有多设备(平板、手机、电子书阅读器)并希望保持阅读数据同步的用户。
其中需提供 PostgreSQL 连接 URL 以及用于初始化的管理员用户名和密码。bashdocker run -e KOMPANION_PG_URL=postgres://用户名:密码@主机:端口/数据库名 -e KOMPANION_AUTH_USERNAME=管理员用户名 -e KOMPANION_AUTH_PASSWORD=管理员密码 kompanion
| 环境变量 | 说明 | 是否必填 | 默认值 |
|---|---|---|---|
KOMPANION_AUTH_USERNAME | 管理员用户名 | 是 | - |
KOMPANION_AUTH_PASSWORD | 管理员密码 | 是 | - |
KOMPANION_AUTH_STORAGE | 认证存储类型(postgres/memory) | 否 | postgres |
KOMPANION_HTTP_PORT | 服务端口 | 否 | 8080 |
KOMPANION_LOG_LEVEL | 日志级别(debug/info/error) | 否 | info |
KOMPANION_PG_POOL_MAX | PostgreSQL 连接池最大连接数 | 否 | 2 |
KOMPANION_PG_URL | PostgreSQL 连接 URL | 是 | - |
KOMPANION_BSTORAGE_TYPE | 书籍存储类型(postgres/memory/filesystem) | 否 | postgres |
KOMPANION_BSTORAGE_PATH | 文件系统存储书籍的路径(仅 filesystem 类型时需配置) | 否 | - |
KOMPANION_STATS_TYPE | 统计文件临时存储类型(postgres/memory/filesystem) | 否 | memory |
KOMPANION_STATS_PATH | 文件系统存储统计文件的路径(仅 filesystem 类型时需配置) | 否 | - |
首先需添加设备:
警告:设备密码以 MD5 哈希(无盐值)存储,以兼容 kosync 插件。
在 KOReader 中配置以下插件:
云存储
https://你的-kompanion地址/webdav/,用户名为设备名称,密码为设备密码统计 - 设置 - 云同步
打开书籍 - 工具 - 进度同步
https://你的-kompanion地址/项目基于 go-clean-template 启动,后经大量修改。
sh# 启动 PostgreSQL $ make compose-up # 运行应用(含数据库迁移) $ make run
sh# 启动数据库、应用(含迁移)并运行集成测试 $ make compose-up-integration-test





探索更多轩辕镜像的使用方法,找到最适合您系统的配置方式
通过 Docker 登录认证访问私有仓库
无需登录使用专属域名
Kubernetes 集群配置 Containerd
K3s 轻量级 Kubernetes 镜像加速
VS Code Dev Containers 配置
Podman 容器引擎配置
HPC 科学计算容器配置
ghcr、Quay、nvcr 等镜像仓库
Harbor Proxy Repository 对接专属域名
Portainer Registries 加速拉取
Nexus3 Docker Proxy 内网缓存
需要其他帮助?请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
manifest unknown
no matching manifest(架构)
invalid tar header(解压)
TLS 证书失败
DNS 超时
410 Gone 排查
402 与流量用尽
401 认证失败
429 限流
D-Bus 凭证提示
413 与超大单层
来自真实用户的反馈,见证轩辕镜像的优质服务