Skip to content
Back to search

glean

A self-hosted RSS reader and personal knowledge management tool.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/LeslieLeung/glean with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/LeslieLeung/glean'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/leslieleung--glean/badge.svg)](/listings/leslieleung--glean)

HTML

<a href="/listings/leslieleung--glean"><img src="/api/listings/leslieleung--glean/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

One-Command Deployment

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

# Start Glean (full deployment with Milvus)
docker compose up -d

# Access:
# - Web App: http://localhost
# - Admin Dashboard: http://localhost:3001 (default: admin/Admin123!)

**Default Admin Account**: An admin account is automatically created with: - Username: `admin` - Password: `Admin123!` - ⚠️ **Change this password in production!**

**Lite Deployment** (without Milvus, if you don't need Phase 3 features):

# Download lite version
curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.lite.yml -o docker-compose.yml

# Start Glean
docker compose up -d

# Admin Dashboard: http://localhost:3001 (default: admin/Admin123!)

Customize Admin Account (Optional)

To use custom admin credentials instead of the defaults, create a `.env` file **before** starting:

# Set custom admin credentials in .env
cat > .env << EOF
ADMIN_USERNAME=admin
ADMIN_PASSWORD=YourSecurePassword123!
SECRET_KEY=$(openssl rand -base64 32)
EOF

# Start services
docker compose up -d

To disable auto-creation and create admin manually:

# Disable auto-creation in .env
echo "CREATE_ADMIN=false" >> .env

# Start services
docker compose up -d

# Create admin manually
docker exec -it glean-backend /app/scripts/create-admin-docker.sh

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 267 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Glean 拾灵
  2. **[English](./README.md)** | **[中文](./README.zh-CN.md)**
  3. > [!IMPORTANT]
  4. > Join our [Discord](https://discord.gg/KMKC4sRVSJ) to stay updated on the latest developments and get support.
  5. >
  6. > This project is still in development and is not ready for production use.
  7. A self-hosted RSS reader and personal knowledge management tool.
  8. > **Glean** (拾灵) helps information-heavy consumers efficiently manage their reading through intelligent RSS aggregation.
  9. ![Glean](asset/Screenshot.png)
  10. ## Features
  11. ### Core Features
  12. - 📰 **RSS Subscription** - Subscribe and organize RSS/Atom feeds with OPML import/export
  13. - 📚 **Smart Reading** - Clean reading experience with content filtering
  14. - 🔖 **Read Later** - Save articles for later reading with auto-cleanup
  15. - 📁 **Folders & Tags** - Multi-level folders and tags for organization
  16. - ⭐ **Bookmarks** - Save articles from feeds or external URLs
  17. - 🔧 **Background Sync** - Automatic feed updates every 15 minutes
  18. - 🔒 **Self-hosted** - Full data ownership with Docker deployment
  19. - 🎨 **Modern UI** - Beautiful, responsive warm dark theme interface
  20. - 👨‍💼 **Admin Dashboard** - User management and system monitoring
  21. ### Planned Features (WIP)
  22. - 🧠 **Smart Recommendations** - AI-powered preference learning and article scoring
  23. - ⚙️ **Rule Engine** - Automated processing with Jinja2-style conditions
  24. - 🤖 **AI Features** - Summary generation, auto-tagging, keyword extraction (BYOK)
  25. - 📄 **Full Content Fetch** - Fetch complete article content for RSS summaries
  26. - 🔌 **Chrome Extension** - One-click bookmarking from browser
  27. - 📱 **Mobile PWA** - Progressive Web App for mobile devices
  28. ## Quick Start
  29. The default deployment stores vectors in PostgreSQL with the pgvector extension. No separate vector database is required.
  30. ```bash
  31. # Download the default compose file
  32. curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.pgvector.yml -o docker-compose.yml
  33. # Start Glean
  34. docker compose up -d
  35. # Access:
  36. # - Web App: http://localhost
  37. # - Admin Dashboard: http://localhost:3001 (default: admin/Admin123!)
  38. ```
  39. **Default Admin Account**: An admin account is automatically created with:
  40. - Username: `admin`
  41. - Password: `Admin123!`
  42. - ⚠️ **Change this password in production!**
  43. ### Optional: Milvus
  44. Use this when the deployment should run a dedicated Milvus vector database:
  45. ```bash
  46. # Download docker-compose.yml
  47. curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.yml -o docker-compose.yml
  48. # Start Glean
  49. docker compose up -d
  50. # Access:
  51. # - Web App: http://localhost
  52. # - Admin Dashboard: http://localhost:3001 (default: admin/Admin123!)
  53. ```
  54. ### Customize Admin Account (Optional)
  55. To use custom admin credentials instead of the defaults, create a `.env` file **before** starting:
  56. ```bash
  57. # Set custom admin credentials in .env
  58. cat > .env << EOF
  59. ADMIN_USERNAME=admin
  60. ADMIN_PASSWORD=YourSecurePassword123!
  61. SECRET_KEY=$(openssl rand -base64 32)
  62. EOF
  63. # Start services
  64. docker compose up -d
  65. ```
  66. To disable auto-creation and create admin manually:
  67. ```bash
  68. # Disable auto-creation in .env
  69. echo "CREATE_ADMIN=false" >> .env
  70. # Start services
  71. docker compose up -d
  72. # Create admin manually
  73. docker exec -it glean-backend /app/scripts/create-admin-docker.sh
  74. ```
  75. ## Configuration
  76. For production, customize your deployment with environment variables. Download the example file:
  77. ```bash
  78. curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/.env.example -o .env
  79. ```
  80. **Important settings to change:**
  81. | Variable | Description | Default |
  82. | ------------------- | -------------------- | ----------------------------------- |
  83. | `SECRET_KEY` | JWT signing key | **Must change in production!** |
  84. | `POSTGRES_PASSWORD` | Database password | `glean` (**Change in production!**) |
  85. | `ADMIN_PASSWORD` | Admin password | `Admin123!` (**Change!**) |
  86. | `WEB_PORT` | Web interface port | `80` |
  87. | `ADMIN_PORT` | Admin dashboard port | `3001` |
  88. | `CREATE_ADMIN` | Auto-create admin | `true` (set `false` to disable) |
  89. For all configuration options, see [.env.example](.env.example).
  90. ## Docker Images
  91. Pre-built images are available on GitHub Container Registry:
  92. - `ghcr.io/leslieleung/glean-backend:latest` - API server & worker
  93. - `ghcr.io/leslieleung/glean-web:latest` - Web frontend
  94. - `ghcr.io/leslieleung/glean-admin:latest` - Admin dashboard
  95. Supported architectures: `linux/amd64`, `linux/arm64`
  96. ### Testing Pre-release Versions
  97. Want to test upcoming features? Use pre-release versions (alpha/beta/rc):
  98. **Method 1: Using environment variable (recommended)**
  99. ```bash
  100. # Set the IMAGE_TAG in .env file
  101. echo "IMAGE_TAG=v0.3.0-alpha.1" >> .env
  102. # Or export it directly
  103. export IMAGE_TAG=v0.3.0-alpha.1
  104. # Start with pre-release images
  105. docker compose up -d
  106. ```
  107. **Method 2: Inline environment variable**
  108. ```bash
  109. IMAGE_TAG=v0.3.0-alpha.1 docker compose up -d
  110. ```
  111. **Note**: Pre-release versions are for testing only. They won't trigger auto-updates for Electron apps and are not recommended for production use.
  112. See available pre-release versions on the [Releases page](https://github.com/LeslieLeung/glean/releases).
  113. ## Deployment
  114. The default deployment (`docker-compose.pgvector.yml`) includes:
  115. - **Web App** (port 80) - Main user interface
  116. - **Admin Dashboard** (port 3001) - User management and system monitoring
  117. - **Backend API** - FastAPI server
  118. - **Worker** - Background task processor (feed fetching, cleanup)
  119. - **PostgreSQL** - Database and vector store (pgvector)
  120. - **Redis** - Task queue
  121. `docker-compose.yml` is the optional Milvus deployment. It adds etcd, MinIO, and Milvus beside the same core services.
  122. For detailed deployment instructions and configuration, see [DEPLOY.md](DEPLOY.md).
  123. Already running Milvus? Follow the [pgvector migration guide](MIGRATE_PGVECTOR.md)
  124. to migrate with one script, including backup, restore, resumable execution, and rollback.
  125. ## Tech Stack
  126. **Backend:**
  127. - Python 3.11+ / FastAPI / SQLAlchemy 2.0
  128. - PostgreSQL / Redis / arq (task queue)
  129. **Frontend:**
  130. - React 18 / TypeScript / Vite
  131. - Tailwind CSS / Zustand / TanStack Query
  132. ## Development
  133. See **[DEVELOPMENT.md](./DEVELOPMENT.md)** for complete development setup instructions.
  134. Quick start:
  135. ```bash
  136. # Clone and setup
  137. git clone https://github.com/LeslieLeung/glean.git
  138. cd glean
  139. npm install
  140. # Start infrastructure
  141. make up
  142. # Initialize database (first time only)
  143. make db-upgrade
  144. # Install pre-commit hooks (optional but recommended)
  145. make pre-commit-install
  146. # Start all services
  147. make dev-all
  148. # Access:
  149. # - Web: http://localhost:3000
  150. # - Admin: http://localhost:3001
  151. # - API Docs: http://localhost:8000/api/docs
  152. ```
  153. ### Pre-commit Hooks
  154. The project uses pre-commit hooks to ensure code quality:
  155. ```bash
  156. # Install hooks (one-time setup)
  157. make pre-commit-install
  158. # Run hooks manually on all files
  159. make pre-commit-run
  160. # Uninstall hooks (if needed)
  161. make pre-commit-uninstall
  162. ```
  163. Hooks automatically run on commit and check:
  164. - Backend: ruff format, ruff linter, pyright type checking
  165. - Frontend: ESLint, Prettier formatting
  166. - General: trailing whitespace, file endings, YAML/JSON/TOML validation
  167. ## Roadmap
  168. | Phase | Status | Features |
  169. | ------------------------- | --------- | -------------------------------------------------------------- |
  170. | **Phase 1: MVP** | ✅ Done | User system, RSS subscription, reader, admin dashboard |
  171. | **Phase 2: Organization** | ✅ Done | Bookmarks, folders, tags, read later |
  172. | **Phase 3: Preferences** | ✅ Done | Embedding pipeline, preference learning, smart recommendations |
  173. | **Phase 4: Rules** | 📋 Planned | Rule engine, Jinja2 conditions, automated actions |
  174. | **Phase 5: AI** | 📋 Planned | AI summaries, auto-tagging, keyword extraction, BYOK support |
  175. | **Phase 6: Extensions** | 📋 Planned | Chrome extension, PWA, web snapshots |
  176. ## Documentation
  177. - **[Development Guide](./DEVELOPMENT.md)** - Set up your development environment
  178. - **[Deployment Guide](./DEPLOY.md)** - Production deployment details
  179. ## Contributing
  180. Contributions are welcome! Please read our [Development Guide](./DEVELOPMENT.md) first.
  181. 1. Fork the repository
  182. 2. Create a feature branch
  183. 3. Make your changes
  184. 4. Run tests and linting
  185. 5. Submit a Pull Request
  186. ## License
  187. This project is licensed under the **AGPL-3.0 License** - see the [LICENSE](LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.