项目介绍
WeKnora 是用于文档理解和语义检索的开源项目,可组织导入、切分、索引和问答流程。它与 IMA 是不同产品,不能由此认定 IMA 客户端已经开源。
导入文件后,系统先解析内容并分块,再生成索引,回答时检索相关片段供模型使用。模型、嵌入、解析与存储组件可以分别配置,适合按资料类型调整知识库。
原资料还介绍了文档与 FAQ 知识库、标签、跨库检索以及 Agent 工具接入。日常使用应关注回答所依据的原文,而不是只看生成文字是否流畅。
核心功能
| 功能 | 作用与使用方式 |
|---|---|
| 文档解析 | 处理支持的 PDF、Word、图片等资料。 |
| 知识库管理 | 按主题组织文件、FAQ 与标签。 |
| 多种检索 | 结合版本支持的关键词、向量等检索策略。 |
| 引用问答 | 根据召回片段回答并核对来源。 |
| 工具扩展 | 按需接入网络搜索或 MCP 能力。 |
界面展示

图 1:官方仓库提供的项目示意图,用于说明功能与布局。

项目信息
| 项目 | 说明 |
|---|---|
| 类型 | 项目指南 |
| 分类 | 知识与效率 |
| 项目仓库 | Tencent/WeKnora |
| 整理日期 | 2026-11-14 |
群晖 Compose 安装
这是当前官方默认架构的五服务起步方案:前端、API、文档解析、PostgreSQL/ParadeDB 与 Redis。使用外部模型 API,无需在群晖运行本地大模型。保留上游 config/config.yaml,使用本地文件存储,不启动可选的 MinIO、图数据库和沙箱。数据库镜像与文档解析服务对硬件有要求,先确认 CPU 架构、内存和磁盘余量。
1. 创建项目目录
群晖先安装并启动 Container Manager。通过 SSH 登录后执行下列命令,只为本项目准备目录:
sudo -i
mkdir -p /volume1/docker/weknora /volume1/docker/weknora/docreader-tmp /volume1/docker/weknora/files /volume1/docker/weknora/postgres /volume1/docker/weknora/redis
cd /volume1/docker/weknora
if [ ! -d source/.git ]; then git clone https://github.com/Tencent/WeKnora.git source; fi
test -f source/config/config.yaml
if [ ! -s .env ]; then
umask 077
{
printf 'DB_PASSWORD=%s\n' "$(openssl rand -hex 24)"
printf 'REDIS_PASSWORD=%s\n' "$(openssl rand -hex 24)"
printf 'JWT_SECRET=%s\n' "$(openssl rand -hex 32)"
} > .env.initializing
mv .env.initializing .env
fi
chmod 600 .env
cat .env
.env 中的密码和密钥由命令随机生成,已有文件不会覆盖。可以在自己的终端用 cat .env 查看初始密码,但不要将输出公开。将其保存在自己的密码管理器中;更新时继续使用原值,不要重新生成导致旧数据无法解密。
2. 保存完整 Compose
在 /volume1/docker/weknora/compose.yaml 保存下面的配置。在 Container Manager 中新建项目时,项目路径选择 /volume1/docker/weknora 并导入该文件;有 .env 的项目要保留它与 Compose 在同一目录。
services:
weknora:
image: wechatopenai/weknora-ui:latest
container_name: weknora
restart: unless-stopped
ports:
- 8188:80
environment:
APP_HOST: app
APP_PORT: '8080'
APP_SCHEME: http
MAX_FILE_SIZE_MB: '50'
depends_on:
app:
condition: service_healthy
app:
image: wechatopenai/weknora-app:latest
restart: unless-stopped
environment:
TZ: Asia/Shanghai
GIN_MODE: release
DB_DRIVER: postgres
DB_HOST: postgres
DB_PORT: '5432'
DB_USER: postgres
DB_PASSWORD: ${DB_PASSWORD}
DB_NAME: WeKnora
RETRIEVE_DRIVER: postgres
REDIS_ADDR: redis:6379
REDIS_PASSWORD: ${REDIS_PASSWORD}
REDIS_DB: '0'
REDIS_PREFIX: 'stream:'
DOCREADER_ADDR: docreader:50051
DOCREADER_TRANSPORT: grpc
STORAGE_TYPE: local
LOCAL_STORAGE_BASE_DIR: /data/files
JWT_SECRET: ${JWT_SECRET}
OLLAMA_OPTIONAL: 'true'
AUTO_MIGRATE: 'true'
volumes:
- /volume1/docker/weknora/files:/data/files
- /volume1/docker/weknora/docreader-tmp:/tmp/docreader:ro
- /volume1/docker/weknora/source/config/config.yaml:/app/config/config.yaml:ro
depends_on:
postgres:
condition: service_healthy
redis:
condition: service_started
docreader:
condition: service_healthy
healthcheck:
test:
- CMD
- curl
- -f
- http://localhost:8080/health
interval: 30s
timeout: 10s
retries: 3
start_period: 60s
postgres:
image: paradedb/paradedb:v0.25.11-pg17
environment:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: ${DB_PASSWORD}
POSTGRES_DB: WeKnora
volumes:
- /volume1/docker/weknora/postgres:/var/lib/postgresql/data
healthcheck:
test:
- CMD-SHELL
- pg_isready -U postgres -d WeKnora
interval: 10s
timeout: 10s
retries: 3
start_period: 30s
restart: unless-stopped
stop_grace_period: 1m
redis:
image: redis:7.0-alpine
command: redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}
restart: always
volumes:
- /volume1/docker/weknora/redis:/data
docreader:
image: wechatopenai/weknora-docreader:latest
expose:
- '50051'
volumes:
- /volume1/docker/weknora/docreader-tmp:/tmp/docreader
environment:
TZ: Asia/Shanghai
DOCREADER_IMAGE_OUTPUT_DIR: /tmp/docreader
MAX_FILE_SIZE_MB: '50'
DOCREADER_GRPC_PORT: '50051'
DOCREADER_GRPC_MAX_WORKERS: '4'
DOCREADER_GRPC_MAX_FILE_SIZE_MB: '50'
DOCREADER_PREPROCESS_MAX_WORKERS: '1'
healthcheck:
test:
- CMD
- grpc_health_probe
- -addr=localhost:50051
interval: 30s
timeout: 10s
retries: 3
start_period: 60s
restart: unless-stopped
extra_hosts:
- host.docker.internal:host-gateway
挂载参数冒号左侧是群晖的实际目录,右侧是应用内目录。以上只挂载本项目所需的数据;若已有同类数据,请先备份再调整路径。端口冲突时只改宿主机一侧,应用内端口保持不变。
3. 检查、拉取与启动
cd /volume1/docker/weknora
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps
docker compose logs --tail=100
浏览器访问 http://群晖IP:8188。群晖IP 替换为自己的 NAS 局域网地址;首次启动时先等待初始化,再检查日志。若群晖仍使用旧 Docker 套件且只有 docker-compose,将命令中的 docker compose 替换为对应命令。
首次使用与验证
打开 8188 注册第一个账号,新增对话模型与 Embedding 模型,填写自己的 API 地址、模型名和密钥。先建一个测试知识库,上传两页无敏感信息的文档,等待解析与向量化完成,再问一个答案明确在文档中的问题并检查引用。接口连通不等于 Embedding 维度兼容;换 Embedding 模型时使用新知识库重建索引。
先保存一条测试数据或完成一次最小任务,再执行 docker compose restart,确认设置及应该持久化的数据仍在。无服务端持久化目录的纯前端工具,应通过自身导出功能保存工作结果。
常见问题
- 页面打不开:运行
docker compose ps检查状态;查看日志里的初始化错误,核对端口冲突和 DSM 防火墙。不要把容器的 IP 当作固定访问地址。 - 数据目录为空:应用内应填写 Compose 冒号右侧的目录;核对宿主机文件是否已放到对应左侧目录。
- 目录无法写入:先查看日志和目录权限,仅为对应数据目录授予镜像实际运行用户需要的权限,不对整个
/volume1设置 777。 - 拉取镜像失败:先排查 Container Manager 的仓库网络;应用自己的 HTTP 代理设置与 Docker 守护进程拉取镜像的代理设置是两件事。
更新、备份与停止
更新前保存 compose.yaml、.env,并备份上面映射的项目数据。数据库服务应先使用自身的数据库备份,或停止整个项目后复制完整数据目录,不能只复制运行中的单个数据库文件。
cd /volume1/docker/weknora
docker compose pull
docker compose up -d
docker compose logs --tail=100
临时停止使用 docker compose stop,重新启动使用 docker compose start。卸载容器用 docker compose down,不要附加 -v,也不要直接删除宿主机数据目录。涉及数据库迁移的升级,先保留原镜像版本和完整备份,再安排维护窗口。
数据与版本管理
files 保存上传文件,postgres 保存元数据与向量索引,redis 保存队列,docreader-tmp 是解析临时目录,source/config 保存服务配置。更新前记录正在运行的镜像摘要,三个 WeKnora 组件使用同一发布版本;不要只升级 API。先备份数据库和 files,再更新配置和镜像。上游升级涉及配置变化时,在 source 中比较新旧 config/config.yaml 后再应用。