wangqiru/ttrss

Awesome TTRSS Docker镜像文档

1. 镜像概述和主要用途

Awesome TTRSS 是一个基于 Docker 的一站式解决方案，专为 https://tt-rss.org/%EF%BC%88%E4%B8%80%E6%AC%BE%E5%BC%80%E6%BA%90%E7%9A%84 PHP RSS 聚合阅读器）设计。该镜像通过容器化部署简化了传统 TTRSS 的部署流程，并集成精选插件以增强用户体验，提供「开箱即用」的 RSS 阅读服务。

2. 核心功能和特性

• 容器化一站式部署：整合 TTRSS 运行所需的 PHP 环境及依赖组件，无需手动配置基础环境，降低部署门槛。
• 精选插件集成：内置优化插件，扩展 TTRSS 功能，提升界面交互与使用体验。
• 简化运维：通过 Docker 容器化管理，支持数据持久化、版本更新与服务启停的便捷操作。
• 开源支持：基于开源项目 TTRSS 构建，支持社区贡献与功能扩展。

3. 使用场景和适用范围

• 个人用户：需自建 RSS 阅读器，实现订阅数据本地存储与隐私保护。
• 小型团队：共享 RSS 订阅源，协作聚合行业资讯或技术动态。
• 技术爱好者：偏好 Docker 轻量化部署，追求低维护成本的自建服务方案。

4. 使用方法和配置说明

4.1 前提条件

• 已安装 Docker Engine（20.10+ 版本）及 Docker Compose（推荐）。
• 服务器需开放 HTTP/HTTPS 端口（默认 80/443，可自定义），并确保网络可访问外部 RSS 源。

4.2 Docker 快速启动

通过 docker run 命令直接启动服务（示例）：

bash
docker run -d \
  --name awesome-ttrss \
  -p 8080:80 \  # 端口映射（主机端口:容器端口）
  -v ttrss-data:/var/www/html \  # 数据持久化卷
  -e TTRSS_DB_HOST=db \  # 数据库主机（若使用外部数据库需替换）
  -e TTRSS_DB_USER=ttuser \  # 数据库用户名
  -e TTRSS_DB_PASS=ttpass \  # 数据库密码
  -e TTRSS_DB_NAME=ttrss \  # 数据库名称
  -e TTRSS_ADMIN_USER=admin \  # 管理员账户名
  -e TTRSS_ADMIN_PASS=yourpassword \  # 管理员密码（建议修改）
  -e TZ=Asia/Shanghai \  # 时区设置
  --restart unless-stopped \  # 服务重启策略
  wangqiru/ttrss

4.3 Docker Compose 配置（推荐）

使用 Docker Compose 管理服务（含数据库，示例 docker-compose.yml）：

yaml
version: '3'

services:
  ttrss:
    image: docker.xuanyuan.run/wangqiru/ttrss
    container_name: ttrss-app
    ports:
      - "8080:80"  # 自定义主机端口（如 80 或 443）
    volumes:
      - ttrss-data:/var/www/html  # TTRSS 应用数据卷
    environment:
      - TTRSS_DB_HOST=db  # 关联数据库服务名
      - TTRSS_DB_USER=ttuser  # 数据库用户名（需与 db 服务一致）
      - TTRSS_DB_PASS=ttpass  # 数据库密码（需与 db 服务一致）
      - TTRSS_DB_NAME=ttrss  # 数据库名称（需与 db 服务一致）
      - TTRSS_ADMIN_USER=admin  # 管理员账户
      - TTRSS_ADMIN_PASS=yourpassword  # 管理员密码（务必修改）
      - TZ=Asia/Shanghai  # 时区（如 Asia/Shanghai、UTC 等）
    depends_on:
      - db  # 依赖数据库服务启动
    restart: unless-stopped

  db:  # 内置 PostgreSQL 数据库（可选，也可使用外部数据库）
    image: docker.xuanyuan.run/postgres:13  # 数据库镜像版本
    container_name: ttrss-db
    volumes:
      - ttrss-db-data:/var/lib/postgresql/data  # 数据库数据卷
    environment:
      - POSTGRES_USER=ttuser  # 与 TTRSS 配置中的用户名一致
      - POSTGRES_PASSWORD=ttpass  # 与 TTRSS 配置中的密码一致
      - POSTGRES_DB=ttrss  # 与 TTRSS 配置中的数据库名一致
    restart: unless-stopped

volumes:
  ttrss-data:  # 应用数据卷（自动创建）
  ttrss-db-data:  # 数据库数据卷（自动创建）

启动命令：
在 docker-compose.yml 所在目录执行 docker compose up -d，服务将后台运行。

4.4 核心环境变量说明

4.5 服务访问与初始化

1. 访问服务：启动后，通过 http://<主机IP>:<映射端口>（如 http://localhost:8080）访问。
2. 登录：使用配置的 TTRSS_ADMIN_USER 和 TTRSS_ADMIN_PASS 登录管理界面。
3. 初始化配置：登录后可添加 RSS 订阅源、启用插件（如主题扩展）、配置通知等。

5. ***

若该项目对您有帮助，可通过以下方式支持开发（包括直接支持 TTRSS 官方项目）：

• OpenCollective：https://opencollective.com/Awesome-TTRSS/
• *******：通过 *** ***
• 微信赞赏：扫描***（图片链接）

6. 参考链接

• 官方文档（中文）：[***]
• TTRSS 官方网站：https://tt-rss.org/
• Docker 镜像仓库：https://hub.docker.com/r/wangqiru/ttrss