Skip to content

Commit af62080

Browse files
committed
docs: 新增 Docker Compose 启动配置说明,调整 docker-compose.yml 配置
1 parent a625eff commit af62080

File tree

5 files changed

+184
-167
lines changed

5 files changed

+184
-167
lines changed

.env.example

Lines changed: 4 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ STORAGE_TYPE=local
2323
# 流处理后端(memory/redis)
2424
STREAM_MANAGER_TYPE=redis
2525

26-
# 主数据库配置
27-
# 数据库端口,默认为5432
28-
DB_PORT=5432
29-
3026
# 应用服务端口,默认为8080
3127
APP_PORT=8080
3228

@@ -46,9 +42,6 @@ DB_PASSWORD=postgres123!@#
4642
DB_NAME=WeKnora
4743

4844
# 如果使用 redis 作为流处理后端,需要配置以下参数
49-
# Redis端口,默认为6379
50-
REDIS_PORT=6379
51-
5245
# Redis密码,如果没有设置密码,可以留空
5346
REDIS_PASSWORD=redis123!@#
5447

@@ -66,9 +59,11 @@ TENANT_AES_KEY=weknorarag-api-key-secret-secret
6659
# 是否开启知识图谱构建和检索(构建阶段需调用大模型,耗时较长)
6760
ENABLE_GRAPH_RAG=false
6861

69-
MINIO_PORT=9000
62+
# MinIO端口
63+
# MINIO_PORT=9000
7064

71-
MINIO_CONSOLE_PORT=9001
65+
# MinIO控制台端口
66+
# MINIO_CONSOLE_PORT=9001
7267

7368
# Embedding并发数,出现429错误时,可调小此参数
7469
CONCURRENCY_POOL_SIZE=5
@@ -132,79 +127,3 @@ COS_ENABLE_OLD_DOMAIN=true
132127

133128
# Neo4j的密码
134129
# NEO4J_PASSWORD=password
135-
136-
##############################################################
137-
138-
###### 注意: 以下配置不再生效,已在Web“配置初始化”阶段完成 #########
139-
140-
141-
# # 初始化默认租户与知识库
142-
# # 租户ID,通常是一个字符串
143-
# INIT_TEST_TENANT_ID=1
144-
145-
# # 知识库ID,通常是一个字符串
146-
# INIT_TEST_KNOWLEDGE_BASE_ID=kb-00000001
147-
148-
# # LLM Model
149-
# # 使用的LLM模型名称
150-
# # 默认使用 Ollama 的 Qwen3 8B 模型,ollama 会自动处理模型下载和加载
151-
# # 如果需要使用其他模型,请替换为实际的模型名称
152-
# INIT_LLM_MODEL_NAME=qwen3:8b
153-
154-
# # LLM模型的访问地址
155-
# # 支持第三方模型服务的URL
156-
# # 如果使用 Ollama 的本地服务,可以留空,ollama 会自动处理
157-
# # INIT_LLM_MODEL_BASE_URL=your_llm_model_base_url
158-
159-
# # LLM模型的API密钥,如果需要身份验证,可以设置
160-
# # 支持第三方模型服务的API密钥
161-
# # 如果使用 Ollama 的本地服务,可以留空,ollama 会自动处理
162-
# # INIT_LLM_MODEL_API_KEY=your_llm_model_api_key
163-
164-
# # Embedding Model
165-
# # 使用的Embedding模型名称
166-
# # 默认使用 nomic-embed-text 模型,支持文本嵌入
167-
# # 如果需要使用其他模型,请替换为实际的模型名称
168-
# INIT_EMBEDDING_MODEL_NAME=nomic-embed-text
169-
170-
# # Embedding模型向量维度
171-
# INIT_EMBEDDING_MODEL_DIMENSION=768
172-
173-
# # Embedding模型的ID,通常是一个字符串
174-
# INIT_EMBEDDING_MODEL_ID=builtin:nomic-embed-text:768
175-
176-
# # Embedding模型的访问地址
177-
# # 支持第三方模型服务的URL
178-
# # 如果使用 Ollama 的本地服务,可以留空,ollama 会自动处理
179-
# # INIT_EMBEDDING_MODEL_BASE_URL=your_embedding_model_base_url
180-
181-
# # Embedding模型的API密钥,如果需要身份验证,可以设置
182-
# # 支持第三方模型服务的API密钥
183-
# # 如果使用 Ollama 的本地服务,可以留空,ollama 会自动处理
184-
# # INIT_EMBEDDING_MODEL_API_KEY=your_embedding_model_api_key
185-
186-
# # Rerank Model(可选)
187-
# # 对于rag来说,使用Rerank模型对提升文档搜索的准确度有着重要作用
188-
# # 目前 ollama 暂不支持运行 Rerank 模型
189-
# # 使用的Rerank模型名称
190-
# # INIT_RERANK_MODEL_NAME=your_rerank_model_name
191-
192-
# # Rerank模型的访问地址
193-
# # 支持第三方模型服务的URL
194-
# # INIT_RERANK_MODEL_BASE_URL=your_rerank_model_base_url
195-
196-
# # Rerank模型的API密钥,如果需要身份验证,可以设置
197-
# # 支持第三方模型服务的API密钥
198-
# # INIT_RERANK_MODEL_API_KEY=your_rerank_model_api_key
199-
200-
# # VLM_MODEL_NAME 使用的多模态模型名称
201-
# # 用于解析图片数据
202-
# # VLM_MODEL_NAME=your_vlm_model_name
203-
204-
# # VLM_MODEL_BASE_URL 使用的多模态模型访问地址
205-
# # 支持第三方模型服务的URL
206-
# # VLM_MODEL_BASE_URL=your_vlm_model_base_url
207-
208-
# # VLM_MODEL_API_KEY 使用的多模态模型API密钥
209-
# # 支持第三方模型服务的API密钥
210-
# # VLM_MODEL_API_KEY=your_vlm_model_api_key

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,25 +119,58 @@ cp .env.example .env
119119
# All variables are documented in the .env.example comments
120120
```
121121

122-
#### ③ Start the services
122+
#### ③ Start the services (include Ollama)
123+
124+
Check the images that need to be started in the .env file.
123125

124126
```bash
125-
# Start all services (Ollama + backend containers)
126127
./scripts/start_all.sh
127-
# Or
128+
```
129+
130+
or
131+
132+
```bash
128133
make start-all
129134
```
130135

131-
#### ③ Start the services (backup)
136+
#### .0 Start ollama services (Optional)
132137

133138
```bash
134-
# Start ollama services (Optional)
135139
ollama serve > /dev/null 2>&1 &
140+
```
141+
142+
#### ③.1 Activate different combinations of features
136143

137-
# Start the service
144+
- Minimum core services
145+
```bash
138146
docker compose up -d
139147
```
140148

149+
- All features enabled
150+
```bash
151+
docker-compose --profile full up -d
152+
```
153+
154+
- Tracing logs required
155+
```bash
156+
docker-compose --profile jaeger up -d
157+
```
158+
159+
- Neo4j knowledge graph required
160+
```bash
161+
docker-compose --profile neo4j up -d
162+
```
163+
164+
- Minio file storage service required
165+
```bash
166+
docker-compose --profile minio up -d
167+
```
168+
169+
- Multiple options combination
170+
```bash
171+
docker-compose --profile neo4j --profile minio up -d
172+
```
173+
141174
#### ④ Stop the services
142175

143176
```bash

README_CN.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,25 +119,58 @@ cp .env.example .env
119119
# 所有变量说明详见 .env.example 注释
120120
```
121121

122-
#### ③ 启动服务
122+
#### ③ 启动服务 (含 Ollama)
123+
124+
检查 .env 文件中需要启动的镜像。
123125

124126
```bash
125-
# 启动全部服务(含 Ollama 与后端容器)
126127
./scripts/start_all.sh
127-
#
128+
```
129+
130+
或者
131+
132+
```bash
128133
make start-all
129134
```
130135

131-
#### 启动服务备选
136+
#### .0 启动Ollama (可选)
132137

133138
```bash
134-
# 启动 ollama 服务 (可选)
135139
ollama serve > /dev/null 2>&1 &
140+
```
141+
142+
#### ③.1 激活不同组合的功能
136143

137-
# 启动服务
144+
- 启动最小功能
145+
```bash
138146
docker compose up -d
139147
```
140148

149+
- 启动全部功能
150+
```bash
151+
docker-compose --profile full up -d
152+
```
153+
154+
- 需要 tracing 日志
155+
```bash
156+
docker-compose --profile jaeger up -d
157+
```
158+
159+
- 需要 neo4j 知识图谱
160+
```bash
161+
docker-compose --profile neo4j up -d
162+
```
163+
164+
- 需要 minio 文件存储服务
165+
```bash
166+
docker-compose --profile minio up -d
167+
```
168+
169+
- 多选项组合
170+
```bash
171+
docker-compose --profile neo4j --profile minio up -d
172+
```
173+
141174
#### ④ 停止服务
142175

143176
```bash

README_JA.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,25 +119,58 @@ cp .env.example .env
119119
# すべての変数の説明は.env.exampleのコメントを参照
120120
```
121121

122-
#### ③ サービスの起動
122+
#### ③ サービスを起動します(Ollama を含む)
123+
124+
.env ファイルで、起動する必要があるイメージを確認します。
123125

124126
```bash
125-
# すべてのサービスを起動(Ollamaとバックエンドコンテナを含む)
126127
./scripts/start_all.sh
127-
# または
128+
```
129+
130+
または
131+
132+
```bash
128133
make start-all
129134
```
130135

131-
#### サービス起動の代替方法
136+
#### .0 ollama サービスを起動する (オプション)
132137

133138
```bash
134-
# ollamaサービスを起動(オプション)
135139
ollama serve > /dev/null 2>&1 &
140+
```
141+
142+
#### ③.1 さまざまな機能の組み合わせを有効にする
136143

137-
# サービスを起動
144+
- 最小限のコアサービス
145+
```bash
138146
docker compose up -d
139147
```
140148

149+
- すべての機能を有効にする
150+
```bash
151+
docker-compose --profile full up -d
152+
```
153+
154+
- トレースログが必要
155+
```bash
156+
docker-compose --profile jaeger up -d
157+
```
158+
159+
- Neo4j ナレッジグラフが必要
160+
```bash
161+
docker-compose --profile neo4j up -d
162+
```
163+
164+
- Minio ファイルストレージサービスが必要
165+
```bash
166+
docker-compose --profile minio up -d
167+
```
168+
169+
- 複数のオプションの組み合わせ
170+
```bash
171+
docker-compose --profile neo4j --profile minio up -d
172+
```
173+
141174
#### ④ サービスの停止
142175

143176
```bash

0 commit comments

Comments
 (0)