fa7ae075ee
* feat(compose): align env vars in docker-compose and .env.example with code docker-compose.yml / docker-compose.dev.yml - app.environment: remove deprecated vars Go app no longer reads (CRYPTO_MASTER_KEY, CRYPTO_SALT, TENANT_AES_KEY, ENABLE_GRAPH_RAG); add missing vars the code actually consumes (OSS/S3/TOS/COS completion, OpenSearch, Tencent VectorDB, Milvus credentials, Redis TLS/namespace, OIDC, audit/invitation/quota, LLM tuning, doc timeouts, etc.) - docreader.environment: complete PDF tuning knobs, SSRF/LOG_LEVEL/gRPC params, GRPC_MTLS_REQUIRE_CLIENT_CERT; fix DOCREADER_PDF_JPEG_QUALITY default 90 -> 85 to match code (config.py) - mcp.environment: add MCP_SERVER_AUTH_TOKEN (required by HTTP transport), WEKNORA_CHAT_TIMEOUT, WEKNORA_VERIFY_SSL, MCP_ALLOWED_UPLOAD_DIRS - dev compose docreader.environment kept symmetric with prod .env.example - reorganize into A-J sections (deploy / data / retrieval / models / parsing / auth / agent / integrations / observability / security) - remove the four deprecated vars, document why - add missing vars, fix NEO4J_URI to bolt:// (matches compose + single-node), fix DORIS_COMPAT_MODE typo, complete docreader PDF tuning defaults Co-Authored-By: Claude <noreply@anthropic.com> * fix(helm): inject NEO4J_ENABLE and drop deprecated TENANT_AES_KEY helm graph bug fix - NEO4J_ENABLE is the sole graph switch the Go app reads (since v0.1.6, ENABLE_GRAPH_RAG is no longer read). helm never injected NEO4J_ENABLE, so GraphRAG was silently broken: setting neo4j.enabled=true gave the app NEO4J_URI/USERNAME/PASSWORD but not the switch, and the UI rejected Node Extractor config with "请正确配置环境变量NEO4J_ENABLE". - app.yaml: inject NEO4J_ENABLE=true inside the neo4j.enabled block; remove the dead ENABLE_GRAPH_RAG injection - NOTES.txt: update GraphRAG instructions (just enable neo4j, no need to set the deprecated ENABLE_GRAPH_RAG) - values.yaml: drop ENABLE_GRAPH_RAG, fix neo4j section comment TENANT_AES_KEY cleanup (deprecated since v0.4.0, encryption now uses SYSTEM_AES_KEY exclusively; Go app no longer reads it) - secrets.yaml: stop generating/looking-up/writing TENANT_AES_KEY, fix stale comment about tenants.api_key rotation - app.yaml: remove TENANT_AES_KEY secretKeyRef - values.yaml: drop tenantAesKey, fix existingSecret key list + comments - cloud-image/firstboot.sh: stop generating/writing/printing TENANT_AES - cloud-image/README.md: drop TENANT_AES_KEY from credential list Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
141 lines
4.5 KiB
Plaintext
141 lines
4.5 KiB
Plaintext
{{/*
|
|
Copyright 2025 Tencent
|
|
SPDX-License-Identifier: MIT
|
|
|
|
Post-installation notes for WeKnora Helm chart.
|
|
Ref: https://github.com/argoproj/argo-helm/blob/main/charts/argo-cd/templates/NOTES.txt
|
|
*/}}
|
|
|
|
================================================================================
|
|
WeKnora has been installed successfully!
|
|
================================================================================
|
|
|
|
Release: {{ .Release.Name }}
|
|
Namespace: {{ .Release.Namespace }}
|
|
Version: {{ .Chart.AppVersion }}
|
|
|
|
--------------------------------------------------------------------------------
|
|
ACCESSING WEKNORA
|
|
--------------------------------------------------------------------------------
|
|
|
|
{{- if .Values.ingress.enabled }}
|
|
WeKnora is accessible via Ingress:
|
|
|
|
URL: {{ if .Values.ingress.tls.enabled }}https{{ else }}http{{ end }}://{{ .Values.ingress.host }}
|
|
|
|
{{- else }}
|
|
|
|
To access WeKnora, use port-forwarding:
|
|
|
|
# Frontend (Web UI)
|
|
kubectl port-forward svc/frontend -n {{ .Release.Namespace }} 8080:80
|
|
|
|
# Then open: http://localhost:8080
|
|
|
|
{{- end }}
|
|
|
|
{{- if not .Values.ingress.enabled }}
|
|
|
|
To expose WeKnora externally, enable Ingress:
|
|
|
|
helm upgrade {{ .Release.Name }} ./helm \
|
|
--set ingress.enabled=true \
|
|
--set ingress.host=weknora.example.com
|
|
|
|
{{- end }}
|
|
|
|
--------------------------------------------------------------------------------
|
|
CONFIGURATION
|
|
--------------------------------------------------------------------------------
|
|
|
|
Components deployed:
|
|
{{- if .Values.app.enabled }}
|
|
- Backend API ({{ include "weknora.app.image" . }})
|
|
{{- end }}
|
|
{{- if .Values.frontend.enabled }}
|
|
- Frontend UI ({{ include "weknora.frontend.image" . }})
|
|
{{- end }}
|
|
{{- if .Values.docreader.enabled }}
|
|
- Document Reader ({{ include "weknora.docreader.image" . }})
|
|
{{- end }}
|
|
{{- if .Values.postgresql.enabled }}
|
|
- PostgreSQL/ParadeDB ({{ include "weknora.postgresql.image" . }})
|
|
{{- end }}
|
|
{{- if .Values.redis.enabled }}
|
|
- Redis ({{ include "weknora.redis.image" . }})
|
|
{{- end }}
|
|
|
|
{{- if or .Values.minio.enabled .Values.neo4j.enabled .Values.qdrant.enabled }}
|
|
|
|
Optional components enabled:
|
|
{{- if .Values.minio.enabled }}
|
|
- MinIO (S3-compatible storage)
|
|
{{- end }}
|
|
{{- if .Values.neo4j.enabled }}
|
|
- Neo4j (Knowledge Graph)
|
|
{{- end }}
|
|
{{- if .Values.qdrant.enabled }}
|
|
- Qdrant (Vector Database)
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
--------------------------------------------------------------------------------
|
|
CONNECTING TO LLM
|
|
--------------------------------------------------------------------------------
|
|
|
|
WeKnora requires an LLM backend. Configure via environment variables:
|
|
|
|
helm upgrade {{ .Release.Name }} ./helm \
|
|
--set app.extraEnv[0].name=OLLAMA_BASE_URL \
|
|
--set app.extraEnv[0].value=http://ollama:11434 \
|
|
--set app.extraEnv[1].name=INIT_LLM_MODEL_NAME \
|
|
--set app.extraEnv[1].value=qwen2.5:7b
|
|
|
|
Supported LLM backends:
|
|
- Ollama (local)
|
|
- OpenAI API compatible endpoints
|
|
- Qwen, DeepSeek, and other Chinese LLMs
|
|
|
|
{{- if .Values.neo4j.enabled }}
|
|
|
|
--------------------------------------------------------------------------------
|
|
GRAPHRAG (KNOWLEDGE GRAPH)
|
|
--------------------------------------------------------------------------------
|
|
|
|
Neo4j is enabled for GraphRAG feature.
|
|
|
|
To use GraphRAG, enable Neo4j. NEO4J_ENABLE is the sole graph switch and is
|
|
injected automatically when neo4j.enabled=true (no need to set ENABLE_GRAPH_RAG,
|
|
which is deprecated and no longer read by the app):
|
|
|
|
helm upgrade {{ .Release.Name }} ./helm \
|
|
--set neo4j.enabled=true \
|
|
--set neo4j.password=<your-secure-password>
|
|
|
|
Access Neo4j Browser:
|
|
kubectl port-forward svc/neo4j -n {{ .Release.Namespace }} 7474:7474 7687:7687
|
|
# Open: http://localhost:7474
|
|
|
|
{{- end }}
|
|
|
|
--------------------------------------------------------------------------------
|
|
DOCUMENTATION
|
|
--------------------------------------------------------------------------------
|
|
|
|
GitHub: https://github.com/Tencent/WeKnora
|
|
API Docs: https://github.com/Tencent/WeKnora/blob/main/docs/api/README.md
|
|
FAQ: https://github.com/Tencent/WeKnora/blob/main/docs/QA.md
|
|
|
|
--------------------------------------------------------------------------------
|
|
TROUBLESHOOTING
|
|
--------------------------------------------------------------------------------
|
|
|
|
Check pod status:
|
|
kubectl get pods -n {{ .Release.Namespace }} -l app.kubernetes.io/instance={{ .Release.Name }}
|
|
|
|
View logs:
|
|
kubectl logs -n {{ .Release.Namespace }} -l app.kubernetes.io/component=app -f
|
|
kubectl logs -n {{ .Release.Namespace }} -l app.kubernetes.io/component=frontend -f
|
|
|
|
================================================================================
|