erikdevries/spotweb

Spotweb Docker镜像文档

镜像概述和主要用途

该项目旨在通过Docker在树莓派（或任何兼容的ARM芯片组）和常规x86芯片组上轻松部署Spotweb。Spotweb是一个Usenet内容索引工具，本镜像提供了跨架构支持和简化的部署流程。

核心功能和特性

• 支持x86和ARM架构系统
• 内置多数据库支持：MySQL、PostgreSQL和SQLite
• 可配置的更新间隔（默认每5分钟）
• 支持外部存储缓存和数据库，避免容器重建时数据丢失
• 时区自定义
• 兼容Newznab索引器协议，可与Sonarr、Radarr等工具集成

使用场景和适用范围

• 家庭服务器或NAS设备上部署Usenet索引服务
• 树莓派等ARM设备上的轻量级Usenet内容管理
• 需要跨架构部署的Spotweb应用场景
• 希望简化Spotweb配置和维护流程的用户

详细使用方法和配置说明

快速开始

最简单的启动方式是使用提供的docker-compose.yml文件，该文件将同时运行Spotweb和MySQL：

bash
docker compose up -d

高级数据库配置

Spotweb需要数据库支持，默认支持MySQL、PostgreSQL和SQLite。可通过以下环境变量配置数据库：

• DB_ENGINE：数据库引擎，可选值：
  • pdo_mysql（MySQL，默认）
  • pdo_pgsql（PostgreSQL）
  • pdo_sqlite（SQLite）
• DB_HOST：数据库主机（默认：mysql）
• DB_PORT：数据库端口（默认：3306）
• DB_NAME：数据库名称（默认：spotweb）
• DB_USER：数据库用户名（默认：spotweb）
• DB_PASS：数据库密码（默认：spotweb）

数据库配置示例

MySQL（默认）

未配置环境变量时将使用MySQL默认设置。示例配置文件见examples/docker-compose-mysql.yml。

PostgreSQL

使用PostgreSQL需配置相应环境变量并包含PostgreSQL容器。示例配置文件见examples/docker-compose-postgres.yml。

SQLite

SQLite是轻量级无服务器数据库，数据存储在单个文件中。注意：这是Spotweb中测试最少的数据库模式。

示例Docker Compose配置见examples/docker-compose-sqlite.yml，关键配置：

• 设置DB_ENGINE=pdo_sqlite
• 在DB_NAME中指定数据库文件路径（如/data/spotweb.db3，文件不存在时会自动创建）
• 必须挂载数据卷以保留数据

bash
docker run -p 8085:80 \
  --name spotweb -d \
  -e DB_ENGINE=pdo_sqlite \
  -e DB_NAME=/data/spotweb.db3 \
  -v /local/path/to/spotweb-data:/data:rw \
  docker.xuanyuan.run/erikdevries/spotweb

外部数据库

连接外部数据库需配置DB_HOST，确保数据库允许外部访问并配置正确的凭据和端口：

bash
docker run -p 8085:80 \
  --name spotweb -d \
  -e DB_HOST=mysql.hostname \
  docker.xuanyuan.run/erikdevries/spotweb

基本配置流程

1. 访问http://localhost:8085
2. 使用默认凭据登录：用户名admin，密码spotweb
3. 配置Usenet服务器、内容保留时间等设置
4. 等待内容索引完成（默认每5分钟更新一次，见下文修改更新间隔方法）

高级配置选项

修改Spotweb更新间隔

• 默认更新间隔为每5分钟
• 通过CRON_INTERVAL环境变量设置自定义cron表达式（可参考cron.help生成表达式）
• 修改后需重启容器（启动时会显示当前配置的更新间隔）

外部存储缓存

• 默认缓存（如图像）存储在容器内的/app/cache目录
• 容器重建时缓存会丢失，建议挂载外部卷保留缓存：

yaml
volumes:
  - /local/path/to/cache:/app/cache:rw

更改时区

• 通过TZ环境变量设置时区（如Europe/Amsterdam或Asia/Shanghai）
• 修改后需重启容器

使用ownsettings.php自定义配置

高级用户可通过挂载自定义ownsettings.php文件覆盖Spotweb设置（仅建议了解用途时使用）：

yaml
volumes:
  - /external/ownsettings.php:/app/ownsettings.php

作为Newznab索引器使用

若要与Sonarr、Radarr等兼容Newznab的工具配合使用：

1. 在Spotweb中创建非管理员用户
2. 获取该用户的API密钥
3. 在Sonarr/Radarr中添加自定义Newznab索引器，使用Spotweb URL和上述API密钥

环境变量参考

注意事项

• 默认配置下Spotweb允许公开注册，若暴露到公网建议修改管理员密码
• SQLite是测试最少的数据库模式，使用中遇到问题可向https://github.com/spotweb/spotweb反馈
• 更多Spotweb使用问题请参考https://github.com/spotweb/spotweb/wiki