glean
starsforks
How to install glean?
leslieleung/glean
$git clone https://github.com/LeslieLeung/glean[English](./README.md) | [中文](./README.zh-CN.md)
README.md
| 1 | # Glean 拾灵 |
| 2 | |
| 3 | **[English](./README.md)** | **[中文](./README.zh-CN.md)** |
| 4 | |
| 5 | > [!IMPORTANT] |
| 6 | > Join our [Discord](https://discord.gg/KMKC4sRVSJ) to stay updated on the latest developments and get support. |
| 7 | > |
| 8 | > This project is still in development and is not ready for production use. |
| 9 | |
| 10 | A self-hosted RSS reader and personal knowledge management tool. |
| 11 | |
| 12 | > **Glean** (拾灵) helps information-heavy consumers efficiently manage their reading through intelligent RSS aggregation. |
| 13 | |
| 14 |  |
| 15 | |
| 16 | ## Features |
| 17 | |
| 18 | ### Core Features |
| 19 | - 📰 **RSS Subscription** - Subscribe and organize RSS/Atom feeds with OPML import/export |
| 20 | - 📚 **Smart Reading** - Clean reading experience with content filtering |
| 21 | - 🔖 **Read Later** - Save articles for later reading with auto-cleanup |
| 22 | - 📁 **Folders & Tags** - Multi-level folders and tags for organization |
| 23 | - ⭐ **Bookmarks** - Save articles from feeds or external URLs |
| 24 | - 🔧 **Background Sync** - Automatic feed updates every 15 minutes |
| 25 | - 🔒 **Self-hosted** - Full data ownership with Docker deployment |
| 26 | - 🎨 **Modern UI** - Beautiful, responsive warm dark theme interface |
| 27 | - 👨💼 **Admin Dashboard** - User management and system monitoring |
| 28 | |
| 29 | ### Planned Features (WIP) |
| 30 | - 🧠 **Smart Recommendations** - AI-powered preference learning and article scoring |
| 31 | - ⚙️ **Rule Engine** - Automated processing with Jinja2-style conditions |
| 32 | - 🤖 **AI Features** - Summary generation, auto-tagging, keyword extraction (BYOK) |
| 33 | - 📄 **Full Content Fetch** - Fetch complete article content for RSS summaries |
| 34 | - 🔌 **Chrome Extension** - One-click bookmarking from browser |
| 35 | - 📱 **Mobile PWA** - Progressive Web App for mobile devices |
| 36 | |
| 37 | ## Quick Start |
| 38 | |
| 39 | ### One-Command Deployment |
| 40 | |
| 41 | ```bash |
| 42 | # Download docker-compose.yml |
| 43 | curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.yml -o docker-compose.yml |
| 44 | |
| 45 | # Start Glean (full deployment with Milvus) |
| 46 | docker compose up -d |
| 47 | |
| 48 | # Access: |
| 49 | # - Web App: http://localhost |
| 50 | # - Admin Dashboard: http://localhost:3001 (default: admin/Admin123!) |
| 51 | ``` |
| 52 | |
| 53 | **Default Admin Account**: An admin account is automatically created with: |
| 54 | - Username: `admin` |
| 55 | - Password: `Admin123!` |
| 56 | - ⚠️ **Change this password in production!** |
| 57 | |
| 58 | **Lite Deployment** (without Milvus, if you don't need Phase 3 features): |
| 59 | |
| 60 | ```bash |
| 61 | # Download lite version |
| 62 | curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/docker-compose.lite.yml -o docker-compose.yml |
| 63 | |
| 64 | # Start Glean |
| 65 | docker compose up -d |
| 66 | |
| 67 | # Admin Dashboard: http://localhost:3001 (default: admin/Admin123!) |
| 68 | ``` |
| 69 | |
| 70 | ### Customize Admin Account (Optional) |
| 71 | |
| 72 | To use custom admin credentials instead of the defaults, create a `.env` file **before** starting: |
| 73 | |
| 74 | ```bash |
| 75 | # Set custom admin credentials in .env |
| 76 | cat > .env << EOF |
| 77 | ADMIN_USERNAME=admin |
| 78 | ADMIN_PASSWORD=YourSecurePassword123! |
| 79 | SECRET_KEY=$(openssl rand -base64 32) |
| 80 | EOF |
| 81 | |
| 82 | # Start services |
| 83 | docker compose up -d |
| 84 | ``` |
| 85 | |
| 86 | To disable auto-creation and create admin manually: |
| 87 | |
| 88 | ```bash |
| 89 | # Disable auto-creation in .env |
| 90 | echo "CREATE_ADMIN=false" >> .env |
| 91 | |
| 92 | # Start services |
| 93 | docker compose up -d |
| 94 | |
| 95 | # Create admin manually |
| 96 | docker exec -it glean-backend /app/scripts/create-admin-docker.sh |
| 97 | ``` |
| 98 | |
| 99 | ## Configuration |
| 100 | |
| 101 | For production, customize your deployment with environment variables. Download the example file: |
| 102 | |
| 103 | ```bash |
| 104 | curl -fsSL https://raw.githubusercontent.com/LeslieLeung/glean/main/.env.example -o .env |
| 105 | ``` |
| 106 | |
| 107 | **Important settings to change:** |
| 108 | |
| 109 | | Variable | Description | Default | |
| 110 | | ------------------- | -------------------- | ----------------------------------- | |
| 111 | | `SECRET_KEY` | JWT signing key | **Must change in production!** | |
| 112 | | `POSTGRES_PASSWORD` | Database password | `glean` (**Change in production!**) | |
| 113 | | `ADMIN_PASSWORD` | Admin password | `Admin123!` (**Change!**) | |
| 114 | | `WEB_PORT` | Web interface port | `80` | |
| 115 | | `ADMIN_PORT` | Admin dashboard port | `3001` | |
| 116 | | `CREATE_ADMIN` | Auto-crea |
People who liked this also viewed
6 picksType
- redis-vl-pythonRedis Vector Library (RedisVL) -- the AI-native Python client for Redis.MCP ServersJul 2026
- pipeworx gatewayLive data for AI agents. 250+ data sources, 900+ tools. Ask questions in plain English with ask_pipeworx — trade flows, SEC filings, drug safety, housing data, and more. No API keys needed.MCP Serversrecently
- dbt-mcpA MCP (Model Context Protocol) server for interacting with dbt.MCP ServersJul 2026
- mcp-server-chart🤖 A visualization mcp & skills contains 25+ visual charts using @antvis. Using for chart generation and data analysis.MCP ServersMay 2026
- mempalaceThe best-benchmarked open-source AI memory system. And it's free.MCP ServersJul 2026
- jupyter-mcp-server🪐 🔧 Model Context Protocol (MCP) Server for Jupyter.MCP ServersJul 2026
