Glean 拾灵

English | 中文

[!IMPORTANT] Join our Discord to stay updated on the latest developments and get support.

This project is still in development and is not ready for production use.

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

Glean (拾灵) helps information-heavy consumers efficiently manage their reading through intelligent RSS aggregation.

Features

Core Features

• 📰 RSS Subscription - Subscribe and organize RSS/Atom feeds with OPML import/export
• 📚 Smart Reading - Clean reading experience with content filtering
• 🔖 Read Later - Save articles for later reading with auto-cleanup
• 📁 Folders & Tags - Multi-level folders and tags for organization
• ⭐ Bookmarks - Save articles from feeds or external URLs
• 🔧 Background Sync - Automatic feed updates every 15 minutes
• 🔒 Self-hosted - Full data ownership with Docker deployment
• 🎨 Modern UI - Beautiful, responsive warm dark theme interface
• 👨‍💼 Admin Dashboard - User management and system monitoring

Planned Features (WIP)

• 🧠 Smart Recommendations - AI-powered preference learning and article scoring
• ⚙️ Rule Engine - Automated processing with Jinja2-style conditions
• 🤖 AI Features - Summary generation, auto-tagging, keyword extraction (BYOK)
• 📄 Full Content Fetch - Fetch complete article content for RSS summaries
• 🔌 Chrome Extension - One-click bookmarking from browser
• 📱 Mobile PWA - Progressive Web App for mobile devices

Quick Start

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

Configuration

For production, customize your deployment with environment variables. Download the example file:

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

Important settings to change: