-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.env.example
More file actions
102 lines (86 loc) · 9.71 KB
/
Copy path.env.example
File metadata and controls
102 lines (86 loc) · 9.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# ═════════════════════════════════════════════════════════════════════════════
# 知归（KnowWhere）- 环境变量配置模板
#
# 用法：
# Copy-Item .env.example .env
# # 编辑 .env，把 REPLACE_ME 换成你自己的值
# uv sync --all-groups --extra local-asr
# uv run knowwhere migrate-and-health
#
# 配置优先级：进程环境变量 > --env-file 指定文件 > 根目录 .env
# .env 包含真实密钥，已被 Git 和 Docker 构建上下文忽略。
# ═════════════════════════════════════════════════════════════════════════════
# ── 运行时与数据库（必填）───────────────────────────────────────────────────
# PostgreSQL 由用户自行准备，Docker Compose 不会创建数据库。
# 密码包含特殊字符时必须先做 URL 编码。
KW_DATABASE_URL=REPLACE_ME # 作用：连接任务、内容和归档状态数据库；例：postgresql+psycopg://username:password@127.0.0.1:5432/knowwhere
# ── 飞书机器人（必填）───────────────────────────────────────────────────────
# 飞书自建应用的凭据，可在开放平台“凭证与基础信息”中查看。
KW_FEISHU_APP_ID=REPLACE_ME # 作用：标识接收消息和写入归档的飞书自建应用；例：cli_xxxxxxxxxxxxxxxx
KW_FEISHU_APP_SECRET=REPLACE_ME # 作用：供应用换取飞书访问令牌，请勿提交到仓库；例：xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# ── OpenAI 兼容文本模型（必填）──────────────────────────────────────────────
# 正文分析使用的模型；BASE_URL 必须包含 http:// 或 https://。
KW_LLM_API_KEY=REPLACE_ME # 作用：认证正文分类与摘要请求；例：sk-xxxxxxxx
KW_LLM_BASE_URL=REPLACE_ME # 作用：指定 OpenAI 兼容文本接口根地址；例：https://api.deepseek.com/v1
KW_LLM_MODEL=REPLACE_ME # 作用：指定正文分类与摘要使用的模型 ID；例：deepseek-chat
KW_LLM_TIMEOUT_SECONDS=180 # 作用：限制单次文本生成等待时间；单位：秒，范围：0～600（不含 0）
KW_LLM_THINKING_MODE=disabled # 作用：控制兼容供应商的思考模式；可选：disabled | enabled，不支持时可留空
# ── OpenAI 兼容视觉模型（小红书/抖音图文链路可选）──────────────────────────
# 处理小红书或抖音图文时，取消下面三行注释并替换 REPLACE_ME；三项必须同时配置。
# KW_VISION_API_KEY=REPLACE_ME # 作用：认证图片 OCR 与视觉理解请求；例：xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# KW_VISION_BASE_URL=REPLACE_ME # 作用：指定 OpenAI 兼容视觉接口根地址；例：https://open.bigmodel.cn/api/paas/v4
# KW_VISION_MODEL=REPLACE_ME # 作用：指定小红书/抖音图文理解使用的模型 ID；例：glm-4.6v
KW_VISION_TIMEOUT_SECONDS=300 # 作用：限制单次多图视觉请求等待时间；单位：秒
KW_VISION_THINKING_MODE=disabled # 作用：控制兼容视觉模型的思考模式；可选：disabled | enabled，不支持时可留空
# ── ASR 与临时媒体（小红书/抖音/B站视频链路）──────────────────────────────
# 默认在本机通过 faster-whisper 转录，不需要腾讯云凭据。
# Docker Compose 构建也读取该值；切换供应商后必须重新执行 docker compose build。
KW_ASR_PROVIDER=faster_whisper # 作用：选择语音转录实现；可选：faster_whisper | tencent
KW_TEMP_STORAGE_PROVIDER=local # 作用：选择 ASR 临时产物存储；本地 ASR 用 local，腾讯 ASR 必须用 tencent_cos
KW_TEMP_DELETE_AFTER_PROCESS=true # 作用：控制任务结束后是否删除本地文件和腾讯 COS 中转对象；true 删除，false 保留用于调试
# KW_TEMP_LOCAL_ROOT=REPLACE_ME # 作用：指定下载、FFmpeg 和本地 ASR 的工作目录；例：D:/knowwhere/temp
# 本地ASR模型配置；模型缓存不参与临时文件清理。
KW_FASTER_WHISPER_MODEL=small # 作用：指定 Whisper 模型名称或本地模型路径；例：tiny、small、large-v3
# KW_FASTER_WHISPER_MODEL_DIR=REPLACE_ME # 作用：指定模型下载与复用缓存目录；例：D:/knowwhere/models
KW_FASTER_WHISPER_DEVICE=cpu # 作用：选择推理设备；可选：cpu | cuda | auto
KW_FASTER_WHISPER_COMPUTE_TYPE=int8 # 作用：选择推理精度和量化方式；CPU 推荐 int8，CUDA 推荐 float16
KW_FASTER_WHISPER_LANGUAGE=zh # 作用：提供音频语言提示以提升识别稳定性；留空时自动识别语言
KW_FASTER_WHISPER_VAD_FILTER=true # 作用：是否启用语音活动检测并过滤长静音；可选：true | false
KW_FASTER_WHISPER_BEAM_SIZE=5 # 作用：设置 Beam Search 宽度；值越大通常越准但推理越慢，范围：1～10
KW_FASTER_WHISPER_CPU_THREADS=0 # 作用：限制 CPU 推理线程数；0 表示使用运行库默认值
KW_FASTER_WHISPER_ALLOW_MODEL_DOWNLOAD=true # 作用：本地缺少模型时是否允许自动下载；生产预装模型后建议设为 false
# ── 腾讯云 ASR 与 COS（仅腾讯模式必填）─────────────────────────────────────
# 使用腾讯 ASR 时必须同时设置 KW_TEMP_STORAGE_PROVIDER=tencent_cos，
# 并取消下面五行注释；ASR 与 COS 复用同一组最小权限凭据。
# KW_TENCENTCLOUD_APP_ID=REPLACE_ME # 作用：标识腾讯云账号并核对 COS Bucket 归属；例：1250000000
# KW_TENCENTCLOUD_SECRET_ID=REPLACE_ME # 作用：认证腾讯 ASR 与 COS API 请求；例：AKIDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# KW_TENCENTCLOUD_SECRET_KEY=REPLACE_ME # 作用：与 SecretId 配对完成腾讯云请求签名，请勿提交到仓库；例：xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# KW_COS_REGION=REPLACE_ME # 作用：指定 COS Bucket 和腾讯 ASR 客户端地域；例：ap-shanghai
# KW_COS_BUCKET=REPLACE_ME # 作用：指定腾讯 ASR 临时音频中转 Bucket；例：knowwhere-temp-1250000000
# 腾讯 ASR 中转对象专用前缀。
KW_COS_PREFIX=knowwhere-temp/ # 作用：隔离知归写入 COS 的临时对象键，便于最小权限授权和生命周期管理
# 私有对象短时下载地址有效期秒数，默认 3600。
KW_COS_PRESIGNED_URL_TTL_SECONDS=3600 # 作用：设置腾讯 ASR 拉取私有 COS 音频的预签名 URL 有效期；单位：秒
# 腾讯云录音文件识别引擎。
KW_TENCENT_ASR_ENGINE_MODEL_TYPE=16k_zh # 作用：选择腾讯录音文件识别引擎；16k_zh 适用于 16kHz 普通话音频
# 轮询间隔与单任务最大等待秒数。
KW_TENCENT_ASR_POLL_INTERVAL_SECONDS=3 # 作用：设置查询腾讯 ASR 异步任务状态的间隔；单位：秒
KW_TENCENT_ASR_MAX_WAIT_SECONDS=1800 # 作用：限制单个腾讯 ASR 任务的最长轮询时间；单位：秒
# ── 平台媒体处理限制（默认可直接使用）──────────────────────────────────────
# 页面与 CDN 请求超时秒数。
KW_DOUYIN_REQUEST_TIMEOUT_SECONDS=60 # 作用：限制抖音页面解析和媒体下载单次请求时间；单位：秒
# 单张图片、单个视频和单作品图片数上限。
KW_DOUYIN_MAX_IMAGE_BYTES=20971520 # 作用：限制单张抖音图片大小，防止异常响应耗尽磁盘；单位：字节，默认 20 MiB
KW_DOUYIN_MAX_VIDEO_BYTES=4294967296 # 作用：限制单个抖音视频下载大小；单位：字节，默认 4 GiB
KW_DOUYIN_MAX_IMAGES=30 # 作用：限制单个抖音图文作品处理的图片数量
# 小红书公开页面/CDN 请求超时、单媒体大小和单篇图片数上限。
KW_XIAOHONGSHU_COOKIE= # 可选：小红书网页版 Cookie；留空匿名访问，含分号时建议用单引号包裹
KW_XIAOHONGSHU_REQUEST_TIMEOUT_SECONDS=60 # 作用：限制小红书页面解析和媒体下载单次请求时间；单位：秒
KW_XIAOHONGSHU_MAX_IMAGE_BYTES=20971520 # 作用：限制单张小红书图片大小；单位：字节，默认 20 MiB
KW_XIAOHONGSHU_MAX_VIDEO_BYTES=4294967296 # 作用：限制单个小红书视频下载大小；单位：字节，默认 4 GiB
KW_XIAOHONGSHU_MAX_IMAGES=30 # 作用：限制单篇小红书图文笔记处理的图片数量
# B站公开接口/CDN 请求超时和单条 DASH 音频大小上限。
KW_BILIBILI_REQUEST_TIMEOUT_SECONDS=60 # 作用：限制 B站接口访问和 DASH 音频下载单次请求时间；单位：秒
KW_BILIBILI_MAX_AUDIO_BYTES=2147483648 # 作用：限制单条 B站 DASH 音频下载大小；单位：字节，默认 2 GiB
# FFmpeg 可执行文件名或绝对路径；容器镜像已内置 ffmpeg。
KW_FFMPEG_PATH=ffmpeg # 作用：指定媒体转码使用的 FFmpeg 可执行文件名或绝对路径；例：C:/ffmpeg/bin/ffmpeg.exe