TranRSS

TranRSS 是一款基于 AI 驱动的现代 RSS 阅读器。它不仅具备传统的订阅同步功能，更深度集成了 AI 翻译与摘要能力，旨在帮助用户跨越语言障碍，高效获取全球信息。

---

🌐 在线演示 / Demo

账号: admin
密码: admin

---

🌟 核心特性

• AI 智能翻译：支持 OpenAI 及其兼容 API（如 DeepSeek, Groq 等），可对文章进行高保真全文翻译。
• AI 核心摘要：一键生成文章要点，快速筛选有价值内容。
• GReader API 兼容：完美支持 Google Reader 协议，可作为各类移动端（如 NetNewsWire, Reeder 等）的后端服务。
• Token 使用量统计：透明化展示 AI 接口的使用量（Prompt/Completion），帮助掌控成本。
• 极致自定义样式：支持用户自定义 CSS，随心所欲定制翻译文本的展示外观。
• 多架构支持：原生支持 Docker 部署，适配 amd64 与 arm64 架构（支持树莓派等设备）。

使用 Docker Compose (推荐)

在项目目录下创建 docker-compose.yml 并填入以下内容：

services:
  tranrss:
    image: ghcr.io/nonamecanuse9/tranrss:latest
    container_name: tranrss
    restart: always
    ports:
      - "8000:8000"
    volumes:
      - "./data:/app/data"
    environment:
      - API_ENCRYPTION_KEY=YourSecretKey # 自定义加密密钥
      - TZ=Asia/Shanghai                 # 访问时区

随后运行：

docker compose up -d

极简运行 (Docker Run)

docker run -d \
  --name tranrss \
  -p 8000:8000 \
  -v ./data:/app/data \
  ghcr.io/nonamecanuse9/tranrss:latest

Important

• 持久化映射：推荐映射 ./data 目录，以确保 SQLite 数据库及任务队列在容器重启后不丢失。
• 访问说明：访问 http://localhost:8000 即可。默认账号密码为 admin / admin。

环境变量说明

变量名	说明	默认值
API_ENCRYPTION_KEY	数据库 API 密钥的加密 Key	(内置默认)
DATABASE_URL	SQLite 数据库路径 (可选覆盖)	sqlite:/app/data/data.database
TZ	系统时区	UTC
JWT_SECRET	JWT 鉴权私钥	(数据库初始化生成)

🛡️ 安全提示 (Security)

Caution

如果您计划将 TranRSS 暴露在公网，请务必阅读以下加固建议：

1. 修改默认密码：系统首次启动会自动创建账号 admin / admin。请在登录后立即前往设置修改密码。
2. 强制 HTTPS：TranRSS 本身不提供 TLS/HTTPS。在公网环境下，请务必使用 Nginx, Caddy 或 Traefik 等反向代理工具，并配置 SSL 证书。
3. 关闭公共注册：在完成初始设置后，建议前往设置面板**关闭“允许注册”**功能。
4. 接口保护：
   • 即便启用了 GReader API，也建议使用强密码。
   • 不要泄露您的 API_ENCRYPTION_KEY。

🛠️ 技术栈

后端 (Rust)

• Web 框架: Axum (高性能异步框架)
• 异步运行时: Tokio
• 数据库: SQLx + SQLite
• 任务队列: Apalis (通过 SQLite 实现的持久化作业队列)
• 安全: Bcrypt (密码哈希), Magic-crypt (密钥加密)

前端 (Vue 3)

• 框架: Vue 3.5 (Composition API)
• UI 组件库: Vuetify 4.0-beta
• 构建工具: Vite 8.0
• 数据可视化: ECharts
• 国际化: vue-i18n

🔧 开发调试

# 进入后端目录
cd backend
pnpm dev

# 进入前端目录
cd frontend
pnpm dev

📄 开源协议

本项目采用 MIT 协议。