Glean 拾灵

English | 中文

[!IMPORTANT] 加入我们的 Discord 以获取最新动态并获得支持。

本项目仍在开发中，尚未准备好用于生产环境。

一个自托管的 RSS 阅读器和个人知识管理工具。

Glean（拾灵）通过智能 RSS 聚合，帮助信息密集型用户高效管理阅读内容。

功能特性

核心功能

• 📰 RSS 订阅 - 订阅并整理 RSS/Atom 源，支持 OPML 导入/导出
• 📚 智能阅读 - 提供干净的阅读体验，支持内容过滤
• 🔖 稍后阅读 - 保存文章以供后续阅读，并自动清理
• 📁 文件夹与标签 - 支持多级文件夹和标签进行内容组织
• ⭐ 书签 - 从订阅源或外部 URL 保存文章
• 🔧 后台同步 - 每 15 分钟自动更新订阅源
• 🔒 自托管 - 通过 Docker 部署，完全掌控数据所有权
• 🎨 现代化 UI - 美观、响应式的暖色暗黑主题界面
• 👨‍💼 管理员仪表盘 - 用户管理与系统监控

计划中的功能（开发中）

• 🧠 智能推荐 - 基于 AI 的偏好学习与文章评分
• ⚙️ 规则引擎 - 使用类 Jinja2 条件实现自动化处理
• 🤖 AI 功能 - 自动生成摘要、自动打标签、关键词提取（自带密钥 BYOK）
• 📄 全文抓取 - 为 RSS 摘要抓取完整文章内容
• 🔌 Chrome 扩展 - 浏览器一键添加书签
• 📱 移动 PWA - 面向移动设备的渐进式 Web 应用（Progressive Web App）

快速开始

一键部署

# 下载 docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.yml -o docker-compose.yml

# 启动 Glean（完整部署，包含 Milvus）
docker compose up -d

# 访问地址：
# - Web 应用：http://localhost
# - 管理员仪表盘：http://localhost:3001（默认账号：admin/Admin123!）

默认管理员账号：系统会自动创建一个管理员账号：

• 用户名：admin
• 密码：Admin123!
• ⚠️ 在生产环境中务必修改此密码！

轻量部署（不含 Milvus，如果你不需要第三阶段的功能）：

# 下载轻量版配置
curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.lite.yml -o docker-compose.yml

# 启动 Glean
docker compose up -d

# 管理员仪表盘：http://localhost:3001（默认账号：admin/Admin123!）

自定义管理员账号（可选）

若要使用自定义管理员凭据而非默认值，请在启动前创建 .env 文件：

# 在 .env 中设置自定义管理员凭据
cat > .env << EOF
ADMIN_USERNAME=admin
ADMIN_PASSWORD=YourSecurePassword123!
SECRET_KEY=$(openssl rand -base64 32)
EOF

# 启动服务
docker compose up -d

若要禁用自动创建并手动创建管理员账号：

# 在 .env 中禁用自动创建
echo "CREATE_ADMIN=false" >> .env

# 启动服务
docker compose up -d

# 手动创建管理员账号
docker exec -it glean-backend /app/scripts/create-admin-docker.sh

配置

在生产环境中，请通过环境变量自定义部署。下载示例配置文件：

curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/.env.example -o .env

需要修改的重要配置项：

变量	说明	默认值
SECRET_KEY	JWT 签名密钥	生产环境必须修改！
POSTGRES_PASSWORD	数据库密码	glean（生产环境请修改！）
ADMIN_PASSWORD	管理员密码	Admin123!（请修改！）
WEB_PORT	Web 界面端口	80
ADMIN_PORT	管理员仪表盘端口	3001
CREATE_ADMIN	是否自动创建管理员	true（设为 false 可禁用）

所有配置选项详见 .env.example。

Docker 镜像

预构建镜像已发布至 GitHub Container Registry：

• ghcr.io/leslieleung/glean-backend:latest - API 服务器与工作进程
• ghcr.io/leslieleung/glean-web:latest - Web 前端
• ghcr.io/leslieleung/glean-admin:latest - 管理员仪表盘

支持架构：linux/amd64、linux/arm64

测试预发布版本

想提前体验新功能？可以使用预发布版本（alpha/beta/rc）：

方法 1：使用环境变量（推荐）

# 在 .env 文件中设置 IMAGE_TAG
echo "IMAGE_TAG=v0.3.0-alpha.1" >> .env

# 或直接导出环境变量
export IMAGE_TAG=v0.3.0-alpha.1

# 使用预发布镜像启动
docker compose up -d

方法 2：内联环境变量

IMAGE_TAG=v0.3.0-alpha.1 docker compose up -d

注意：预发布版本仅用于测试。它们不会触发 Electron 应用的自动更新，不建议用于生产环境。

可用的预发布版本请参见 Releases 页面。

部署

默认部署包含所有服务（完整版）：

• Web 应用（端口 80）- 主用户界面
• 管理员仪表盘（端口 3001）- 用户管理与系统监控
• 后端 API - FastAPI 服务器
• Worker - 后台任务处理器（抓取订阅源、清理等）
• PostgreSQL - 数据库
• Redis - 任务队列
• Milvus - 向量数据库，用于智能推荐与偏好学习（第三阶段）

也可使用 docker-compose.lite.yml 进行轻量部署（不含 Milvus）。

详细部署说明与配置请参见 DEPLOY.md。

技术栈

后端：

• Python 3.11+ / FastAPI / SQLAlchemy 2.0
• PostgreSQL / Redis / arq（任务队列）

前端：

• React 18 / TypeScript / Vite
• Tailwind CSS / Zustand / TanStack Query

开发

完整开发环境搭建说明请参见 DEVELOPMENT.md。

快速开始：

# 克隆并初始化
git clone https://github.com/LeslieLeung/glean.git
cd glean
npm install

# 启动基础设施
make up

# 初始化数据库（仅首次需要）
make db-upgrade

# 安装 pre-commit 钩子（可选但推荐）
make pre-commit-install

# 启动所有服务
make dev-all

# 访问地址：
# - Web：http://localhost:3000
# - 管理员：http://localhost:3001
# - API 文档：http://localhost:8000/api/docs

Pre-commit 钩子

本项目使用 pre-commit 钩子确保代码质量：

# 安装钩子（一次性设置）
make pre-commit-install

# 手动对所有文件运行钩子
make pre-commit-run

# 卸载钩子（如需要）
make pre-commit-uninstall

钩子会在每次提交时自动运行，检查以下内容：

• 后端：ruff 格式化、ruff 代码检查、pyright 类型检查
• 前端：ESLint、Prettier 格式化
• 通用：尾部空白字符、文件结尾符、YAML/JSON/TOML 验证

路线图

阶段（Phase）	状态	功能（Features）
第一阶段：MVP	✅ 已完成	用户系统、RSS 订阅、阅读器、管理仪表盘（admin dashboard）
第二阶段：组织管理	✅ 已完成	书签（Bookmarks）、文件夹（folders）、标签（tags）、稍后阅读（read later）
第三阶段：偏好设置	🚧 进行中	嵌入（Embedding）流水线、偏好学习（preference learning）、智能推荐（smart recommendations）
第四阶段：规则引擎	📋 计划中	规则引擎（Rule engine）、Jinja2 条件、自动化操作（automated actions）
第五阶段：AI 功能	📋 计划中	AI 摘要（AI summaries）、自动打标（auto-tagging）、关键词提取（keyword extraction）、自带密钥（BYOK, Bring Your Own Key）支持
第六阶段：扩展功能	📋 计划中	Chrome 扩展、PWA（渐进式 Web 应用）、网页快照（web snapshots）

详细的功能规格说明请参见 产品需求文档。

文档

• 开发指南 - 设置你的开发环境
• 部署指南 - 生产环境部署详情

贡献

欢迎贡献！请先阅读我们的 开发指南。

1. Fork 本仓库
2. 创建特性分支（feature branch）
3. 进行修改
4. 运行测试和代码检查（linting）
5. 提交 Pull Request

许可证

本项目采用 AGPL-3.0 许可证，详情请参见 LICENSE 文件。

Glean（拾灵）快速上手指南

Glean 是一个自托管的 RSS 阅读器与个人知识管理工具，帮助信息密集型用户通过智能 RSS 聚合高效管理阅读内容。

⚠️ 项目仍在开发中，不建议用于生产环境。
💬 加入 Discord 获取最新动态与支持。

---

环境准备

系统要求

• 支持 Docker 的 Linux / macOS / Windows 系统
• 推荐配置：2 核 CPU、4GB 内存（完整版含 Milvus）
• 若仅需基础功能（不含 AI 推荐），可使用 Lite 版本，资源占用更低

前置依赖

• Docker（版本 ≥ 20.10）
• Docker Compose（已集成在新版 Docker 中）

🇨🇳 国内用户建议：配置 Docker 镜像加速器（如阿里云、中科大镜像源），以提升拉取 ghcr.io 镜像的速度。

---

安装步骤

方法一：完整部署（含 Milvus，支持未来 AI 功能）

curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.yml -o docker-compose.yml
docker compose up -d

方法二：轻量部署（推荐新手或低配设备）

curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.lite.yml -o docker-compose.yml
docker compose up -d

自定义管理员账号（可选）

在启动前创建 .env 文件以设置安全凭据：

cat > .env << EOF
ADMIN_USERNAME=admin
ADMIN_PASSWORD=YourSecurePassword123!
SECRET_KEY=$(openssl rand -base64 32)
POSTGRES_PASSWORD=YourDBPassword123!
EOF

docker compose up -d

🔒 重要：默认账号为 admin / Admin123!，务必在生产环境中修改密码和密钥！

---

基本使用

1. 访问 Web 应用
   浏览器打开：http://localhost

2. 登录管理员后台（可选）
   地址：http://localhost:3001
   使用 .env 中设置的账号或默认账号登录

3. 添加 RSS 订阅

   • 点击左上角「+」号 → 「添加订阅」
   • 输入 RSS/Atom 链接（如 https://example.com/feed.xml）
   • 支持 OPML 导入导出（设置 → 导入/导出）

4. 阅读与管理

   • 文章自动每 15 分钟同步一次
   • 可标记「稍后读」、打标签、归类到文件夹
   • 支持从任意网页手动添加书签（需复制链接）

✅ 至此，你已成功运行 Glean 并开始管理信息流！更多高级功能（如规则引擎、AI 摘要）将在后续版本逐步开放。