Documentation
Get Started
hRAG is self-hosted and open source. You own the data, the infrastructure, and the intelligence pipeline.
Quick Start (Local)
01
Clone the repository
git clone https://github.com/smicapplab/hRAG.git cd hRAG/
02
Install dependencies
npm install
03
Configure environment
cp .env.example .env # Set HRAG_MASTER_PASSPHRASE and DATABASE_URL
04
Run migrations
npm run hrag:update
05
Start the Control Room
npm run dev # Open http://localhost:5173
Key References
GitHub Repository
Open SourceFull source code, issues, and contributions.
Open →UPGRADE.md
OperationsAll migration and upgrade procedures. Required reading before any infrastructure change.
Open →System Health API
APILive node health and readiness endpoints.
Go →Control Room
AppLog in to the full document intelligence UI.
Go →Environment Variables
| Variable | Required | Description |
|---|---|---|
| HRAG_MASTER_PASSPHRASE | Always | AES-GCM key derivation passphrase. Node enters LOCKED mode without it. |
| DATABASE_URL | Always | sqlite://./data.db or postgresql://user:pass@host/db |
| S3_ENDPOINT | Self-hosted | Garage or MinIO endpoint, e.g. http://localhost:3900 |
| S3_ACCESS_KEY | Self-hosted | S3 access key ID |
| S3_SECRET_KEY | Self-hosted | S3 secret access key |
| HRAG_PRIMARY | Enterprise | Set to true on the designated primary node for vector writes |
| REDIS_URL | Enterprise | Redis connection string for BullMQ ingestion queue |
| NODE_ENV | Production | Set to production to enable strict security mode |