Installation
Quick Start
curl -fsSL <download-url> -o install.sh
chmod +x install.sh
./install.sh
docker compose up -d
Replace <download-url> with the URL provided by your vendor.
What the Installer Creates
Running install.sh scaffolds all the files and directories RAG-DocBot needs:
| Path / Name | Type | Purpose |
|---|---|---|
.env | File | All runtime configuration (tokens, secrets, settings) |
docker-compose.yml | File | Service definitions |
license.key | File | License validation |
docs/ | Directory | Drop documents here for indexing |
branding/ | Directory | Custom logos and branding assets |
models/ | Directory | Place your GGUF model file here |
postgres_data | Docker volume | All application data |
redis_data | Docker volume | Live job state |
qdrant_storage | Docker volume | Vector index data |
All application data lives in Docker named volumes — data survives container recreation and updates. Database migrations run automatically on every startup, so no manual schema management is needed.
Services
docker compose up -d starts the following services:
| Service | Description |
|---|---|
backend | FastAPI application — the main API server |
ui | RAG-DocBot frontend |
inference | llama-cpp-python inference server (serves the GGUF model) |
qdrant | Vector database for the document index |
postgres | Relational database for application state |
redis | Live job state |
pgadmin | PostgreSQL admin UI (port 5050 — for dev/admin use) |
After Installation
- Place your GGUF model file in the
models/directory. See Placing a Model. - Open the app in your browser. See Accessing the App.
- Log in with the default admin credentials and change the password immediately. See Changing Password.