Skip to content
Glean

Quick Start

One-Command Deployment

Section titled “One-Command Deployment”

Glean uses Docker Compose for deployment, supporting both full (with Milvus vector database) and lite deployment modes.

Section titled “Full Deployment (Recommended)”

Full deployment includes the Milvus vector database for smart recommendations and preference learning.

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


# Start all services
docker compose up -d

Lite Deployment

Section titled “Lite Deployment”

If you don’t need smart recommendation features, use the lite version:

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


# Start services
docker compose up -d

Create Admin Account

Section titled “Create Admin Account”

After the first startup, create an admin account to access the dashboard:

Terminal window
# Generate random password (recommended)
docker exec -it glean-backend /app/scripts/create-admin-docker.sh


# Or specify username and password
docker exec -it glean-backend /app/scripts/create-admin-docker.sh myusername MySecurePass123!

You can also auto-create admin on first startup via environment variables:

Terminal window
# Create .env file
cat > .env << EOF
CREATE_ADMIN=true
ADMIN_USERNAME=admin
ADMIN_PASSWORD=YourSecurePassword123!
EOF


# Start services
docker compose up -d

Access Glean

Section titled “Access Glean”

After successful startup, access the following:

ServiceURLDescription
Web Apphttp://localhostMain interface
Admin Dashboardhttp://localhost:3001System management
API Docshttp://localhost/api/docsDEBUG mode only

Register User Account

Section titled “Register User Account”
  1. Visit the Web App at http://localhost
  2. Click the “Register” button
  3. Fill in email and password
  4. Login to start using

Add Your First Feed

Section titled “Add Your First Feed”

Option 1: Manual Addition

Section titled “Option 1: Manual Addition”
  1. After login, click “Add Subscription” in the sidebar
  2. Enter the RSS/Atom feed URL
  3. The system will auto-discover and subscribe

Option 2: Import OPML

Section titled “Option 2: Import OPML”

Migrate from other RSS readers:

  1. Export OPML file from your old reader
  2. In Glean settings, select “Import OPML”
  3. Upload the file, subscriptions and folders will be created automatically

Service Architecture

Section titled “Service Architecture”

Full deployment includes these services:

ServiceDescription
glean-backendFastAPI REST API server
glean-workerBackground task processor (RSS fetching, cleanup)
glean-webReact frontend interface
glean-adminAdmin dashboard interface
glean-postgresPostgreSQL database
glean-redisRedis task queue
glean-milvusMilvus vector database (full version)

Next Steps

Section titled “Next Steps”