System Requirements
System Requirements
Section titled “System Requirements”Hardware Requirements
Section titled “Hardware Requirements”Minimum Configuration (Lite deployment):
- CPU: 2 cores
- RAM: 2GB
- Storage: 10GB available space
Recommended Configuration (Full deployment with Milvus):
- CPU: 4 cores or more
- RAM: 8GB or more
- Storage: 40GB available space
Software Requirements
Section titled “Software Requirements”- Operating System: Linux / macOS / Windows (with Docker support)
- Docker Engine: 24.0+ and Docker Compose V2
- Domain Name (recommended): For HTTPS configuration
Supported Architectures
Section titled “Supported Architectures”Pre-built Docker images support:
linux/amd64linux/arm64
Deployment Modes
Section titled “Deployment Modes”Full Deployment
Section titled “Full Deployment”Includes all services with smart recommendations and preference learning:
| Service | Container Name | Description |
|---|---|---|
| PostgreSQL | glean-postgres | Main database |
| Redis | glean-redis | Task queue |
| Backend | glean-backend | FastAPI API server |
| Worker | glean-worker | Background task processor |
| Web | glean-web | Frontend interface |
| Admin | glean-admin | Admin dashboard |
| Milvus | glean-milvus | Vector database |
| Milvus etcd | glean-milvus-etcd | Milvus coordination service |
| Milvus MinIO | glean-milvus-minio | Milvus object storage |
Lite Deployment
Section titled “Lite Deployment”Excludes Milvus services, 6 services total:
| Service | Container Name | Description |
|---|---|---|
| PostgreSQL | glean-postgres | Main database |
| Redis | glean-redis | Task queue |
| Backend | glean-backend | FastAPI API server |
| Worker | glean-worker | Background task processor |
| Web | glean-web | Frontend interface |
| Admin | glean-admin | Admin dashboard |
Network Requirements
Section titled “Network Requirements”Outbound Connections
Section titled “Outbound Connections”- RSS/Atom feed URLs
- AI API endpoints (if using OpenAI, etc.)
Inbound Ports
Section titled “Inbound Ports”| Port | Service | Default | Configurable |
|---|---|---|---|
| Web App | glean-web | 80 | WEB_PORT |
| Admin Dashboard | glean-admin | 3001 | ADMIN_PORT |
| Milvus | glean-milvus | 19530 | MILVUS_PORT |
Data Persistence
Section titled “Data Persistence”Docker Volumes used for data persistence:
| Volume | Description |
|---|---|
| postgres_data | PostgreSQL database files |
| redis_data | Redis persistence data |
| glean_logs | Application logs |
| milvus_etcd_data | Milvus etcd data (full version) |
| milvus_minio_data | Milvus object storage (full version) |
| milvus_data | Milvus vector data (full version) |
Docker Images
Section titled “Docker Images”Pre-built images are hosted on GitHub Container Registry:
ghcr.io/leslieleung/glean-backend:latestghcr.io/leslieleung/glean-web:latestghcr.io/leslieleung/glean-admin:latestUsing Specific Versions
Section titled “Using Specific Versions”# Set version tagexport IMAGE_TAG=v1.0.0
# Or set in .env fileecho "IMAGE_TAG=v1.0.0" >> .env
# Start servicesdocker compose up -dTesting Pre-release Versions
Section titled “Testing Pre-release Versions”# Use alpha/beta/rc versionsIMAGE_TAG=v1.1.0-alpha.1 docker compose up -dNext Steps
Section titled “Next Steps”- Configuration - Customize environment variables
- HTTPS Setup - Configure SSL certificates
- Backup & Restore - Data backup strategies