Upload folder using huggingface_hub
Browse files- .env.example +1 -1
- DOCKER.md +3 -3
- Dockerfile +2 -2
- OPEN_WEBUI.md +3 -3
- README.md +2 -2
- SETUP.md +1 -1
.env.example
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
-
# QModel
|
| 2 |
# ==================================
|
| 3 |
# Copy this to .env and update values for your environment
|
| 4 |
|
|
|
|
| 1 |
+
# QModel 6 Configuration Template
|
| 2 |
# ==================================
|
| 3 |
# Copy this to .env and update values for your environment
|
| 4 |
|
DOCKER.md
CHANGED
|
@@ -271,15 +271,15 @@ docker build -t qmodel:custom .
|
|
| 271 |
|
| 272 |
```bash
|
| 273 |
# Tag for registry
|
| 274 |
-
docker tag qmodel myregistry/qmodel:
|
| 275 |
|
| 276 |
# Push
|
| 277 |
-
docker push myregistry/qmodel:
|
| 278 |
|
| 279 |
# Run from registry
|
| 280 |
docker run -p 8000:8000 \
|
| 281 |
--env-file .env \
|
| 282 |
-
myregistry/qmodel:
|
| 283 |
```
|
| 284 |
|
| 285 |
---
|
|
|
|
| 271 |
|
| 272 |
```bash
|
| 273 |
# Tag for registry
|
| 274 |
+
docker tag qmodel myregistry/qmodel:v6.1
|
| 275 |
|
| 276 |
# Push
|
| 277 |
+
docker push myregistry/qmodel:v6.1
|
| 278 |
|
| 279 |
# Run from registry
|
| 280 |
docker run -p 8000:8000 \
|
| 281 |
--env-file .env \
|
| 282 |
+
myregistry/qmodel:v6.1
|
| 283 |
```
|
| 284 |
|
| 285 |
---
|
Dockerfile
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
-
# QModel
|
| 2 |
# =============================
|
| 3 |
# Dockerfile for QModel API
|
| 4 |
# Supports both Ollama and HuggingFace backends via .env configuration
|
|
@@ -10,7 +10,7 @@ FROM python:3.11-slim
|
|
| 10 |
|
| 11 |
# Metadata
|
| 12 |
LABEL maintainer="QModel Team"
|
| 13 |
-
LABEL description="QModel
|
| 14 |
LABEL version="4.1"
|
| 15 |
|
| 16 |
# Environment variables
|
|
|
|
| 1 |
+
# QModel 6 - Islamic RAG API
|
| 2 |
# =============================
|
| 3 |
# Dockerfile for QModel API
|
| 4 |
# Supports both Ollama and HuggingFace backends via .env configuration
|
|
|
|
| 10 |
|
| 11 |
# Metadata
|
| 12 |
LABEL maintainer="QModel Team"
|
| 13 |
+
LABEL description="QModel v6 - Quran & Hadith RAG API"
|
| 14 |
LABEL version="4.1"
|
| 15 |
|
| 16 |
# Environment variables
|
OPEN_WEBUI.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
| 1 |
-
# Using QModel
|
| 2 |
|
| 3 |
-
QModel
|
| 4 |
|
| 5 |
## Prerequisites
|
| 6 |
|
|
@@ -367,7 +367,7 @@ curl -X POST http://localhost:8000/v1/chat/completions \
|
|
| 367 |
|
| 368 |
1. **Restrict CORS**: Set `ALLOWED_ORIGINS=your-domain.com` in `.env`
|
| 369 |
2. **Use HTTPS**: Proxy through nginx with TLS
|
| 370 |
-
3. **Rate limit**: Add rate limiting middleware (not in
|
| 371 |
4. **Authentication**: Consider adding API key validation layer
|
| 372 |
5. **Network**: Don't expose QModel directly to the internet without auth
|
| 373 |
|
|
|
|
| 1 |
+
# Using QModel v6 with Open-WebUI
|
| 2 |
|
| 3 |
+
QModel v6 is fully compatible with **Open-WebUI** thanks to its OpenAI-compatible API endpoints. This guide shows you how to integrate them.
|
| 4 |
|
| 5 |
## Prerequisites
|
| 6 |
|
|
|
|
| 367 |
|
| 368 |
1. **Restrict CORS**: Set `ALLOWED_ORIGINS=your-domain.com` in `.env`
|
| 369 |
2. **Use HTTPS**: Proxy through nginx with TLS
|
| 370 |
+
3. **Rate limit**: Add rate limiting middleware (not in v6, but recommended)
|
| 371 |
4. **Authentication**: Consider adding API key validation layer
|
| 372 |
5. **Network**: Don't expose QModel directly to the internet without auth
|
| 373 |
|
README.md
CHANGED
|
@@ -19,7 +19,7 @@ language:
|
|
| 19 |
- en
|
| 20 |
---
|
| 21 |
|
| 22 |
-
# QModel
|
| 23 |
**Specialized Qur'an & Hadith Knowledge System with Dual LLM Support**
|
| 24 |
|
| 25 |
> A production-ready Retrieval-Augmented Generation system specialized exclusively in authenticated Islamic knowledge. No hallucinations, no outside knowledge—only content from verified sources.
|
|
@@ -279,7 +279,7 @@ See [SETUP.md](SETUP.md) and [DOCKER.md](DOCKER.md) for more detailed troublesho
|
|
| 279 |
|
| 280 |
---
|
| 281 |
|
| 282 |
-
## What's New in
|
| 283 |
|
| 284 |
✨ **Dual LLM Backend** — Ollama (dev) + HuggingFace (prod)
|
| 285 |
✨ **Grade Filtering** — Return only Sahih/Hasan authenticated Hadiths
|
|
|
|
| 19 |
- en
|
| 20 |
---
|
| 21 |
|
| 22 |
+
# QModel 6 — Islamic RAG System
|
| 23 |
**Specialized Qur'an & Hadith Knowledge System with Dual LLM Support**
|
| 24 |
|
| 25 |
> A production-ready Retrieval-Augmented Generation system specialized exclusively in authenticated Islamic knowledge. No hallucinations, no outside knowledge—only content from verified sources.
|
|
|
|
| 279 |
|
| 280 |
---
|
| 281 |
|
| 282 |
+
## What's New in v6
|
| 283 |
|
| 284 |
✨ **Dual LLM Backend** — Ollama (dev) + HuggingFace (prod)
|
| 285 |
✨ **Grade Filtering** — Return only Sahih/Hasan authenticated Hadiths
|
SETUP.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
| 1 |
-
# QModel
|
| 2 |
|
| 3 |
## Quick Start
|
| 4 |
|
|
|
|
| 1 |
+
# QModel v6 Setup & Deployment Guide
|
| 2 |
|
| 3 |
## Quick Start
|
| 4 |
|