Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Configure RAGSuite secrets, SMTP, and URLs in .env for CLI or clone installs.
.env.
.env as production secrets. Rotate JWT_SECRET_KEY after any shared or compromised install. Smoke SMTP created by init may let the API start but does not deliver real invite, password-reset, or 2FA email until you configure real SMTP.| Install type | Path |
|---|---|
| CLI (default) | ~/ragsuite/.env |
| Git clone | repo root .env (from .env.example) |
# clone installs
cp .env.example .env
ragsuite init creates and manages env for CLI installs. It regenerates JWT_SECRET_KEY.
| Variable | Purpose |
|---|---|
JWT_SECRET_KEY | Session/JWT signing — use a long random secret in production |
CUSTOM_LLM_INTERNAL_API_KEY | First-run default internal key (not a cloud vendor key). Override anytime |
init may let the API start but does not deliver real mail.
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=you@gmail.com
SMTP_PASSWORD=your-16-char-app-password
SMTP_USE_TLS=true
EMAIL_FROM=you@gmail.com
ragsuite restart
# or from a clone: npm run stop && npm start
| Variable | Typical local value |
|---|---|
FRONTEND_API_URL | http://localhost:9090 (baked into Docker frontend build) |
FRONTEND_BASE_URL | http://localhost:9191 |
PUBLIC_API_BASE_URL | http://localhost:9090/api/v1 |
CORS_ORIGINS | Your console origin(s) |
| Variable | Notes |
|---|---|
DEBUG | Development verbosity |
HF_HUB_OFFLINE | Prefer offline Hugging Face hub behavior when set |
SSO_ENABLED | SSO is Enterprise; keep false on Community unless EE is attached |
ENABLE_ASYNC_DOCUMENT_INGEST | Async document ingest |
RAGSUITE_EE_ROOT | Absolute path to EE tree when attaching Enterprise for Docker DX |
OLLAMA_BASE_URL) live in the backend env template in the Community repository.