Skip to content

Commit 0656714

Browse files
committed
sync: update from internal GitLab repository
Content updated: Files: - README.md - module.xml Directories: - docs/ Synced at: 2025-08-02 14:08:12
1 parent dffa058 commit 0656714

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ make quick-start # Guided setup wizard
5252

5353
## 🚀 Quick Start
5454

55+
### 🆓 Free Community Edition
56+
**This project uses InterSystems IRIS Community Edition by default - completely free, no license required!**
57+
58+
All Docker configurations (`docker-compose.yml`, `docker-compose.iris-only.yml`) use `intersystemsdc/iris-community:latest` for immediate, license-free usage. For Enterprise Edition features, see `docker-compose.licensed.yml`.
59+
5560
### One-Command Setup
5661
Get started with a complete RAG system in minutes using our intelligent setup wizard:
5762

@@ -285,6 +290,7 @@ make quick-start-status # Check system health and configuration
285290

286291
## 🌟 Key Features
287292

293+
- **🆓 Free to Use**: Default IRIS Community Edition setup - no license required
288294
- **🚀 One-Command Setup**: Complete RAG systems in minutes with intelligent profiles
289295
- **🎯 Profile-Based Configuration**: Minimal, Standard, Extended - optimized for every use case
290296
- **🔧 Interactive CLI Wizard**: Guided setup with validation and intelligent defaults

docs/guides/DEPLOYMENT_GUIDE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,23 @@ uv pip install -r requirements.txt
7676

7777
#### Option A: Docker Deployment (Recommended for Development)
7878
```bash
79-
# Start IRIS container using docker-compose
79+
# Start IRIS Community Edition container using docker-compose (default)
80+
docker-compose up -d
81+
82+
# Alternative: Use the standalone community configuration
8083
docker-compose -f docker-compose.iris-only.yml up -d
8184

8285
# Wait for container to be ready (check health)
83-
docker-compose -f docker-compose.iris-only.yml ps
86+
docker-compose ps
8487

8588
# Verify container is running
8689
docker ps | grep iris
8790
```
8891

92+
**🆓 Community Edition vs Enterprise Edition**:
93+
- The default `docker-compose.yml` uses **IRIS Community Edition** (free, no license required)
94+
- For Enterprise Edition features, use `docker-compose.licensed.yml` (requires valid IRIS license)
95+
8996
#### Option B: Native IRIS Installation (Production)
9097
```bash
9198
# Install IRIS on your system

module.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<Version>0.2.0</Version>
77
<Description>A comprehensive, production-ready framework for implementing Retrieval Augmented Generation (RAG) pipelines using InterSystems IRIS as the vector database backend. Features unified Query() API, requirements-driven orchestrator, and 7 RAG techniques.</Description>
88
<Keywords>RAG,Vector Search,Machine Learning,AI,IRIS,Python,Embeddings,ColBERT,CRAG,GraphRAG,HyDE</Keywords>
9-
<Author>InterSystems</Author>
9+
<Author>Thomas Dyar</Author>
1010
<License>MIT</License>
1111
<Repository>https://github.com/intersystems/iris-rag-templates</Repository>
1212
<Homepage>https://github.com/intersystems/iris-rag-templates</Homepage>

0 commit comments

Comments
 (0)