zveronline/sopds

SOPDS Docker镜像文档

镜像概述和主要用途

SOPDS Docker镜像是基于Simple OPDS server（[***]

核心功能和特性

• 电子书库管理：支持挂载本地电子书目录，以只读方式访问和管理图书资源
• 数据库灵活性：内置PostgreSQL数据库，同时支持外部数据库存储或连接现有数据库
• 用户自定义：可通过环境变量配置超级用户的用户名、***和密码
• 自动化扫描：支持图书库自动扫描，更新内容索引
• 机器人集成：可配置自动启动机器人，扩展访问方式

使用场景和适用范围

• 个人电子书库的集中管理与远程访问
• 家庭或小型团队内部共享电子书资源
• 为电子书阅读器提供标准化OPDS内容源
• 需要轻量化、容器化部署OPDS服务的场景

详细使用方法和配置说明

安装

拉取官方镜像

bash
docker pull zveronline/sopds

手动构建镜像

bash
docker build -t zveronline/sopds https://github.com/zveronline/docker-sopds.git

快速启动

基本运行配置

bash
docker run --name sopds -d \
   --volume /path/to/library:/library:ro \
   --publish 8001:8001 \
   zveronline/sopds

启动后，通过 http://localhost:8001 访问SOPDS服务器。

外部数据库存储配置

将PostgreSQL数据库文件存储到宿主机路径：

bash
docker run --name sopds -d \
   --volume /path/to/library:/library:ro \
   --volume /path/to/database:/var/lib/pgsql \
   --publish 8001:8001 \
   zveronline/sopds

外部数据库连接配置

连接外部PostgreSQL数据库：

bash
docker run --name sopds -d \
   --volume /path/to/library:/library:ro \
   --env 'DB_USER=sopds' \
   --env 'DB_NAME=sopds' \
   --env 'DB_PASS=sopds' \
   --env 'DB_HOST=external-db-host' \
   --env 'DB_PORT=5432' \
   --env 'EXT_DB=True' \
   --publish 8001:8001 \
   zveronline/sopds

创建超级用户

默认超级用户为 admin，密码 admin。可通过环境变量自定义：

bash
docker run --name sopds -d \
   --volume /path/to/library:/library:ro \
   --volume /path/to/database:/var/lib/pgsql \
   --env 'SOPDS_SU_NAME="your_superuser_name"' \
   --env 'SOPDS_SU_EMAIL="your_email@example.com"' \
   --env 'SOPDS_SU_PASS="your_secure_password"' \
   --publish 8001:8001 \
   zveronline/sopds

扫描图书馆

启动容器后执行以下命令扫描电子书库：

bash
docker exec -ti sopds bash
python3 manage.py sopds_util setconf SOPDS_SCAN_START_DIRECTLY True

自动启动***机器人

默认***机器人未启用，通过环境变量启用：

bash
docker run --name sopds -d \
   --volume /path/to/library:/library:ro \
   --volume /path/to/database:/var/lib/pgsql \
   --env 'SOPDS_TMBOT_ENABLE="True"' \
   --publish 8001:8001 \
   zveronline/sopds

启用后需通过SOPDS管理界面完成机器人的具体配置。

环境变量说明